add maxLength to recording

log4js-node · May 19, 2023 · cd8b019 · cd8b019
1 parent 26dcec6
commit cd8b019
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/recording.md b/docs/recording.md
@@ -5,6 +5,7 @@ This appender stores the log events in memory. It is mainly useful for testing (
 ## Configuration
 
 - `type` - `recording`
+- `maxLength` - `integer` (optional, defaults to undefined) - the maximum array length for the recording. If not specified, the array will grow until cleared
 
 There is no other configuration for this appender.
 

diff --git a/lib/appenders/recording.js b/lib/appenders/recording.js
@@ -2,12 +2,15 @@ const debug = require('debug')('log4js:recording');
 
 const recordedEvents = [];
 
-function configure() {
+function configure(config) {
   return function (logEvent) {
     debug(
       `received logEvent, number of events now ${recordedEvents.length + 1}`
     );
     debug('log event was ', logEvent);
+    if (config.maxLength && recordedEvents.length >= config.maxLength) {
+      recordedEvents.shift();
+    }
     recordedEvents.push(logEvent);
   };
 }