pkglogger

A zero-configuration logger that writes to date-stamped log files.

Version: 4.2.4

Quick Start

Install the pkglogger module.

npm install pkglogger

Import the createLog function from the pkglogger module.

import { createLog } from 'pkglogger';

Use the createLog() function to create a log for your module.

const log = createLog('server');

server
  .start(port)
  .then(() => {
    log.info(`Listening on port ${port}.`);
  })
  .catch((err) => {
    log.error(err);
  });

Instead of a string, you can also pass in your own module or import.meta object and the topic is created from the basename of the module's filename property or by parsing the url property of the import.meta object.

const log = createLog(import.meta);

If no argument is provided, then the name of the closest package.json file is used.

Available Log Methods

There are four log methods. The message part of the log output is created by calling msg.toString() so error objects can be passed to each method as well as strings.

log.error(msg); // logs the message with severity 0 (ERROR)
log.warn(msg);  // logs the message with severity 1 (WARN)
log.info(msg);  // logs the message with severity 2 (INFO)
log.debug(msg); // logs the message with severity 3 (DEBUG)

The format of each log message is fixed:

<timestamp> [<pid>] <severity> <topic>: <message>

Configuration

This logger is designed to work without any additional configuration. The configuration of a log can be obtained from the config property.

console.dir(log.config);

{
  logTopic: {string},
  logDir: {string},
  logFile: {string},
  logFiles: {number},
  logLevel: {number},
  logDebug: {string}
}

Log Directory

Log files are written to the logs directory. This directory is created if it does not exist. The default location of the logs directory is in the directory of the closest package.json file (see read-pkg-up). This can be overridden by setting the LOG_DIR environemnt variable. The directory is created if it does not exist.

Log File

The name of the each log file is created from the name of the closest package.json file (see read-pkg-up). The current date and the .log extension are appended to the package name to create the filename. This can be overridden by setting the LOG_FILE environment variable. The log.latestLogFile getter returns the path of the most-recent log file or null if no log files exist.

Number of Log Files

At most five log files are maintained. This can be overridden by setting the LOG_FILES environment variable to an integer value. Setting LOG_FILES to a negative value disables file logging.

Default Log Level

The default log level is 2 (INFO). This can be overridden by setting the LOG_LEVEL environment variable to a number (0 - 3) or to a case-insensitive string corresponding to the log level.

Level 0: ERROR
Level 1: WARN
Level 2: INFO
Level 3: DEBUG

Debugging

For calls to log.debug() to be logged, you must set the LOG_LEVEL environment variable to 3 or DEBUG. Once set, you can limit the modules for which debug logging is enabled by setting the LOG_DEBUG or DEBUG environment variables.

Set the LOG_DEBUG or DEBUG environment variable to a list of topics, delimited by commas or spaces. This follows the convention of the debug package by allowing wildcards and omitting topics by prefixing the topic with a dash.

Please note that the LOG_DEBUG environment variable, if set, takes precedence over the DEBUG environment variable. If neither one of these is set, then all calls to log.debug() are logged.

Console Output

Log messages are also written to the console (stderr) unless stderr is not connected to a TTY or we are in production mode (NODE_ENV=production). Console output is styled using chalk. The color-coding of message can be disabled by setting FORCE_COLOR=0.

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fhellwig/pkglogger