Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 5.34 KB

configuration-options.md

File metadata and controls

49 lines (39 loc) · 5.34 KB
Raw

Advanced Console Log Documentation

Configuration Options

The advanced-console-log module offers a wide range of configuration options to customize its behavior. Below is a detailed breakdown of each configuration option:

Core Configuration Options

Option Type Default Description
mode string "regular" Sets the logging mode. Possible values are "regular", "async", "async-queue", and "worker".
logLevel number 1 Sets the console log level. Accepts values from 0 (debug) to 5 (fatal).
terminateOnFatal boolean false If true, terminates the current process upon a fatal message.
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.
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.)
enableExitHandlers boolean false If true, automatically handles process exits, ensuring all logs are flushed before termination.
workerScriptPath string null Custom path for worker script when using mode: "worker".

Timestamp and Caller Information Configuration

Option Type Default Description
timestampFormat string HH:mm:ss.SSS Defines the timestamp format using date/time formatting tokens (YYYY, MM, DD, HH, mm, ss, SSS).
includeCallerInfo boolean false If true, includes caller information (file, function, line, and column) in log messages.
callerInfoLevel number 2 Sets the log level for caller information. Only logs of this level or higher include caller info.
includeInlineCallerInfo boolean false If true, displays caller information inline within log messages for easier debugging.
inlineCallerInfoLevel number 1 Sets the log level for inline caller information. Only logs of this level or higher include inline caller info.
includeStackTrace boolean false If true, includes a stack trace in error and fatal messages.

File Logging Configuration

Option Type Default Description
outputFilename string null Specifies the filename for file-based logging. If empty, file logging is disabled.
outputFileLogLevel number 1 Sets the log level for file logging. Accepts values from 0 (debug) to 5 (fatal).
maxLogFileSizeMB number 10 Defines the maximum log file size in MB. When the file size is reached, a new log file is created.
maxLogFiles number 5 Limits the number of log files retained. Older files are deleted when the limit is exceeded.

Performance and Async Configuration

Option Type Default Description
queueBatchSize number 50 Defines the number of log entries to batch before writing to the file when in async-queue mode.
flushInterval number 1000 The interval in milliseconds at which the log queue is flushed when in async-queue mode.