feat: Introduced configuration options memoryUpdateInterval

- `memoryUpdateInterval` replaces `memoryCheckFrequency` to better handle high frequency logging environments

Author: samestrin

README.md

@@ -4,7 +4,7 @@
 
 ![Version 1.0.0](https://img.shields.io/badge/Version-1.0.0-blue) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Built with Node.js](https://img.shields.io/badge/Built%20with-Node.js-green)](https://nodejs.org/)
 
-**Advanced Console Log (ACL)**, available as the `advanced-console-log` NPM package, is a lightweight logging module for Node.js applications. It supports console and file logging with various levels, colors, and additional features such as memory usage tracking and caller information.
+**Advanced Console Log (ACL)**, available as the `advanced-console-log` NPM package, is a lightweight logging module for Node.js applications. It supports console and file logging with various levels, colors, and additional features such as memory usage tracking and caller information. ACL prioritizes performance by using lazy loading, ensuring efficient resource management.
 
 ![Advanced Console Log](https://samestrin.github.io/media/advanced-console-log/advanced-console-log.png)
 
@@ -13,7 +13,7 @@
 ### Core Logging Features
 
 - **Advanced Configuration Options**: Provides extensive [configuration options](docs/configuration-options.md) such as memory display modes, caller info inclusion levels, and more.
-- **Multiple Log Levels**: Supports six logging levels (debug, log, info, warn, error, fatal) to categorize and prioritize log messages.
+- **Multiple Log Levels**: Supports six logging levels (`debug`, `log`, `info`, `warn`, `error`, `fatal`) to categorize and prioritize log messages.
 - **Console Logging**: Outputs log messages to the console with color-coded and formatted output based on log level.
 - **File Logging**: Optionally logs messages to a specified file, with separate control over the log level for file output.
 - **Asynchronous Logging Modes**: Supports multiple asynchronous logging modes ("async", "async-queue", "worker") for non-blocking operations in high-throughput environments.
@@ -28,9 +28,9 @@
 
 ### Advanced Information Tracking
 
-- **Caller Information**: Includes caller information (file, function, line, and column) in log messages based on log level and configuration.
-- **Inline Caller Information**: Displays inline caller information within log messages for quick debugging reference.
-- **Memory Usage Tracking**: Tracks and displays memory usage, either in MB or percentage format, based on configuration.
+- **Caller Information**: Includes caller information (file, function, line, and column) in log messages based on log level and configuration. (2 modes available)
+- **Inline Caller Information**: Displays inline caller information within log messages for quick debugging reference. (3 modes available)
+- **Memory Usage Tracking**: Tracks and displays memory usage, either in MB or percentage format, based on configuration. (Uses color to provide a visual warning as usage increases)
 
 ### Performance Measurement
 

docs/configuration-options.md

@@ -14,7 +14,7 @@ The `advanced-console-log` module offers a wide range of configuration options t
 | `includeTimestamps`    | `boolean` | `true`      | Determines whether to include timestamps in log messages.                                           |
 | `includeMemoryUsage`   | `boolean` | `false`     | If `true`, includes memory usage information in log messages.                                       |
 | `generateReport`       | `boolean` | `false`     | If `true`, generates a summary report showing the number of times each log method was called.       |
-| `memoryCheckFrequency` | `number`  | `10`        | Defines the frequency of memory checks.                                                             |
+| `memoryUpdateInterval` | `number`  | `1000`      | Defines the frequency of memory checks in ms.                                                       |
 | `memoryDisplayMode`    | `number`  | `1`         | Defines the format for memory usage display. (1 is `MB`, 2 is `%`, and 3 is both).                  |
 | `extraSpace`           | `boolean` | `false`     | If `true`, adds an extra space after each logging message.                                          |
 | `enableTimers`         | `boolean` | `false`     | If `true`, enables timer methods. (`startTimer`, `stopTimer`, `getTimer`, etc.)                     |

docs/performance-considerations.md

@@ -81,7 +81,7 @@ const logger = ACL.getInstance({
 Memory usage tracking is an optional feature that can be enabled using the `includeMemoryUsage` configuration. If this information is not needed, disable memory tracking to reduce the computational cost associated with collecting and formatting memory statistics.
 
 - **`includeMemoryUsage`**: Set to `false` to disable memory usage tracking.
-- **`memoryCheckFrequency`**: If memory tracking is required, adjust the frequency of checks to reduce performance impact.
+- **`memoryUpdateInterval`**: If memory tracking is required, adjust the frequency of checks (in ms) to reduce performance impact. Use a larger value to limit the frequency of memory checks.
 
 #### Example:
 

examples/configuration-options.js

@@ -11,6 +11,7 @@ const logger = ACL.getInstance({
 	outputFileLogLevel: 2, // Set file log level
 	includeTimestamps: true, // Include timestamps in log messages
 	includeMemoryUsage: true, // Include memory usage information
+	memoryUpdateInterval: 1000,
 	memoryDisplayMode: 1, // Display memory usage in MB
 	includeCallerInfo: true, // Include caller information
 	callerInfoLevel: 2, // Include caller info for log level 2 and above

examples/memory-usage.js

@@ -9,7 +9,7 @@ const ACL = require("../index");
 const logger = ACL.getInstance({
 	includeMemoryUsage: true,
 	memoryDisplayMode: 3, // Display both MB and percentage
-	memoryCheckFrequency: 1,
+	memoryUpdateInterval: 1000,
 });
 
 function main() {

src/core/ACL.js

@@ -29,7 +29,7 @@ class ACL {
 	 * @param {number} [config.logLevel=1] - Console log level (0 = debug, 5 = fatal).
 	 * @param {boolean} [config.includeTimestamps=true] - Include timestamps in logs.
 	 * @param {boolean} [config.includeMemoryUsage=false] - Include memory usage info.
-	 * @param {number} [config.memoryCheckFrequency=10] - Frequency of memory checks.
+	 * @param {number} [config.memoryUpdateInterval=1000] - Frequency of memory checks in ms
 	 * @param {number} [config.memoryDisplayMode=1] - Memory display format (1 = MB, 2 = %, 3 = both).
 	 * @param {boolean} [config.includeCallerInfo=false] - Include caller info in logs.
 	 * @param {number} [config.callerInfoLevel=2] - Log level for including caller info.
@@ -55,7 +55,6 @@ class ACL {
 		this.logLevel = typeof config.logLevel === "number" ? config.logLevel : 1;
 		this.includeTimestamps = config.includeTimestamps !== false;
 		this.includeMemoryUsage = config.includeMemoryUsage || false;
-		this.memoryCheckFrequency = config.memoryCheckFrequency ?? 10;
 		this.memoryDisplayMode = config.memoryDisplayMode ?? 1;
 		this.includeCallerInfo = config.includeCallerInfo || false;
 		this.callerInfoLevel = config.callerInfoLevel ?? 2;
@@ -79,6 +78,8 @@ class ACL {
 		this.generateReport = !!config.generateReport;
 		this.terminateOnFatal = !!config.terminateOnFatal;
 
+		this.memoryUpdateInterval = config.memoryUpdateInterval || 1000;
+
 		this.firstShown = false;
 		this.timers = {};
 		this.logEventCount = 0;
@@ -96,6 +97,7 @@ class ACL {
 
 		if (this.includeMemoryUsage) {
 			this._totalHeapSizeLimit = getTotalHeapSizeLimit();
+			this.startMemoryUsageUpdates();
 		}
 
 		// Lazy load FileLogger when file logging is needed
@@ -315,6 +317,10 @@ class ACL {
 		this.isClosing = true;
 
 		try {
+			if (includeMemoryUsage) {
+				this.stopMemoryUsageUpdates();
+			}
+
 			// Flush and close file logs if enabled
 			if (this.fileLogHandler) {
 				await this.flushFileLogs();
@@ -554,15 +560,25 @@ class ACL {
 	}
 
 	/**
-	 * Checks and updates the memory usage based on the configured frequency.
+	 * Starts a timer to update memory usage at a regular interval.
 	 */
-	updateMemoryUsage() {
-		if (
-			this.includeMemoryUsage &&
-			this.logEventCount % this.memoryCheckFrequency === 0
-		) {
+	startMemoryUsageUpdates() {
+		if (!this.memoryTimer && this.includeMemoryUsage) {
 			this.memoryUsage = this.getFormattedMemoryUsage();
-			this.logEventCount = 0;
+
+			this.memoryTimer = setInterval(() => {
+				this.memoryUsage = this.getFormattedMemoryUsage();
+			}, this.memoryUpdateInterval);
+		}
+	}
+
+	/**
+	 * Stops the memory usage updates when the logger is closed or memory tracking is disabled.
+	 */
+	stopMemoryUsageUpdates() {
+		if (this.memoryTimer) {
+			clearInterval(this.memoryTimer);
+			this.memoryTimer = null;
 		}
 	}
 
@@ -634,8 +650,6 @@ class ACL {
 			  } `
 			: "";
 
-		this.updateMemoryUsage();
-
 		const inlineCallerInfo =
 			this.includeInlineCallerInfo && level >= 1
 				? `${this.color.inlineCaller}${this.getInlineCallerInfo(
@@ -706,8 +720,6 @@ class ACL {
 				  } `
 				: "";
 
-			this.updateMemoryUsage();
-
 			const inlineCallerInfo =
 				this.includeInlineCallerInfo && level >= 1
 					? `${this.color.inlineCaller}${this.getInlineCallerInfo(