logging-utils

logging-utils v3.0.14

Utilities for configuring simple log level based logging functionality on an object.

The log levels supported are the following:

• ERROR - only logs error messages
• WARN - only logs warning and error messages
• INFO - logs info, warning and error messages
• DEBUG - logs debug, info, warning and error messages
• TRACE - logs trace, debug, info, warning and error messages (i.e. all)

Main module:

• logging.js

This module is exported as a Node.js module.

Installation

Using npm:

$ npm i --save logging-utils

Usage

1. Configure logging:

1. Require logging-utils

// To use the logging utilties
const logging = require('logging-utils');

// Logging configuration functions
const isLoggingConfigured = logging.isLoggingConfigured;
const configureLoggingWithSettings = logging.configureLoggingWithSettings;
const getDefaultLoggingSettings = logging.getDefaultLoggingSettings;
const configureDefaultLogging = logging.configureDefaultLogging;
const configureLogging = logging.configureLogging;

// Log level constants
const ERROR = logging.ERROR;
const WARN = logging.WARN;
const INFO = logging.INFO;
const DEBUG = logging.DEBUG;
const TRACE = logging.TRACE;

1. Provide a context object on which to configure logging, e.g:

const context = { a: 1, b: 2, c: 3 }; // replace with your own target object to be configured

1. Configure logging on the context object

• To configure default logging on an existing object:

configureDefaultLogging(context);

• To configure WARN level logging on an existing object

configureLoggingWithSettings(context, {logLevel: WARN});

• To configure specific logging (WITHOUT overriding any existing logging on context)

const settings = {logLevel: DEBUG, useLevelPrefixes: false, useConsoleTrace: false, underlyingLogger: console};
configureLoggingWithSettings(context, settings, false);

• To configure specific logging (OVERRIDING any existing logging on context!)

configureLoggingWithSettings(context, settings, true);

• To configure simple default logging on a new object

const log = configureDefaultLogging({});

• To configure default logging on an existing object with overriding options, an explicit logger and forceConfiguration true

const options = undefined; // ... or any LoggingOptions you want to use to partially or fully override the default logging settings
configureDefaultLogging(context, options, console, true);

// Alternatives specifying only underlying logger or forceConfiguration 
configureDefaultLogging(context, options, console);
configureDefaultLogging(context, options, undefined, true);

• To configure logging from a config object (or file) with logging options under config.loggingOptions

const options = { loggingOptions: { logLevel: DEBUG, useLevelPrefixes: true, useConsoleTrace: false } }; // replace with your own config object
const loggingSettings = getDefaultLoggingSettings(options.loggingOptions);
configureLoggingWithSettings(context, loggingSettings);
// or as an alternative to the above 2 lines, just use the following:
configureDefaultLogging(context, config.loggingOptions);

// Alternatives specifying only optional underlying logger or forceConfiguration 
configureLoggingWithSettings(context, loggingSettings, console);
configureLoggingWithSettings(context, loggingSettings, undefined, true);

• To configure logging from logging options

const options = { logLevel: DEBUG, useLevelPrefixes: true, useConsoleTrace: false }; // replace with your own config object
const loggingSettings = getDefaultLoggingSettings(options);
configureLoggingWithSettings(context, loggingSettings);
// or as an alternative to the above 2 lines, just use the following:
configureDefaultLogging(context, options);

• To configure logging from EITHER logging settings OR logging options (OR defaults if neither) - WITHOUT overriding any existing logging on context

configureLogging(context, loggingSettings, loggingOptions, underlyingLogger, false);

• To configure logging from EITHER logging settings OR logging options (OR defaults if neither) - OVERRIDING any existing logging on context!

configureLogging(context, loggingSettings, loggingOptions, underlyingLogger, true);

2. Log messages

• To log errors:

// Log an error with a strack trace
context.error('Error message 1', new Error('Boom').stack);

// Log an error without a stack trace
context.error('Error message 2');

• To log warnings:

// Log a warning (or do nothing when warnings are disabled)
context.warn('Warning message 1');

// To avoid building the warning message (when warnings are disabled)
if (context.warnEnabled) context.warn('Warning message 2');

• To log info messages:

// Log an info message (or do nothing when info messages are disabled)
context.info('Info message 1');

// To avoid building the info message (when info messages are disabled)
if (context.infoEnabled) context.info('Info message 2');

• To log debug messages:

// Log a debug message (or do nothing when debug messages are disabled)
context.debug('Debug message 1');

// To avoid building the debug message (when debug messages are disabled)
if (context.debugEnabled) context.debug('Debug message 2');

• To log trace messages:

// To log a trace message (or do nothing when trace messages are disabled)
context.trace('Trace message 1');

// To avoid building the trace message (when trace messages are disabled)
if (context.traceEnabled) context.trace('Trace message 2');

Unit tests

This module's unit tests were developed with and must be run with tape. The unit tests have been tested on Node.js v4.3.2.

See the package source for more details.

Changes

3.0.14

• Moved test devDependencies to package.json & removed test/package.json

3.0.13

• Updated core-functions dependency to version 2.0.15

3.0.12

• Updated core-functions dependency to version 2.0.14

3.0.11

• Updated core-functions dependency to version 2.0.13

3.0.10

• Updated core-functions dependency to version 2.0.12

3.0.9

• Improved LoggingSettings & LoggingOptions typedefs in type-defs.js module

3.0.8

• Moved all typedefs from logging.js module to new type-defs.js module

3.0.7

• Added Logging typedef
• Changed return types of configureLogging, configureLoggingWithSettings and configureDefaultLogging functions to new Logging type

3.0.6

• Updated core-functions dependency to version 2.0.11

3.0.5

• Changed 'Logging was configured without settings or options' warning to use JSON.stringify instead of Strings.stringify to avoid verbose logging of all of console object's properties and functions

3.0.4

• Updated core-functions dependency to version 2.0.10

3.0.3

• Updated core-functions dependency to version 2.0.9

3.0.2

• Updated core-functions dependency to version 2.0.8

3.0.1

• Updated core-functions dependency to version 2.0.7
• Updated tape dependency to 4.6.3

3.0.0

• Changes to logging.js module:
  • Renamed configureLogging function to configureLoggingWithSettings
  • Renamed configureLoggingWithSettingsOrOptions function to configureLogging
  • Removed configureLoggingIfNotConfigured function
• Updated core-functions dependency to version 2.0.5

2.0.4

• Changes to logging.js module:
  • Added new configureLoggingWithSettingsOrOptions function to simplify programmatic configuration

2.0.3

• Changes to logging.js module:
  • Added missing return value to configureLoggingIfNotConfigured function

2.0.2

• Changes to logging.js module:
  • Added a convenience configureLoggingIfNotConfigured function

2.0.1

• Changes to logging.js module:
  • Changed configureDefaultLogging function to accept a new options argument of type LoggingOptions to enable optional, partial overriding of default logging settings
  • Renamed getLoggingSettingsOrDefaults function to getDefaultLoggingSettings

2.0.0

• Changed logging-utils configuration API to synchronize with similar changes done to aws-core-utils/stages configuration and aws-stream-consumer/stream-processing configuration.
  • Changed configureLogging function API to replace multiple arguments with single settings argument
  • Added getLoggingSettingsOrDefaults function to facilitate overriding default settings
  • Changed configureDefaultLogging function to use new getLoggingSettingsOrDefaults function
  • Added typedefs for LoggingSettings and LoggingOptions to better define parameter and return types
  • Removed obsolete configureLoggingFromConfig function
  • Removed obsolete finaliseLogLevel, finaliseUseLevelPrefixes and finaliseUseConsoleTrace functions
  • Removed defaultLogLevel, defaultUseLevelPrefixes and defaultUseConsoleTrace properties & config.json settings
  • Fixed unit tests to synchronize with API changes
• Renamed logging-utils module to logging module.

1.0.6

• Updated core-functions dependency to version 2.0.3

1.0.5

• Updated core-functions dependency to version 2.0.2

1.0.4

• Added optional underlyingLogger and forceConfiguration arguments to the configureDefaultLogging function
• Added a new configureLoggingFromConfig function to simplify configuring from a config object/file
• Added unit tests for configureDefaultLogging and configureLoggingFromConfig functions
• Updated core-functions dependency to version 2.0.1

1.0.3

• Removed dependency on and replaced usage of core-functions/functions functions with standard JS functionality
• Updated core-functions dependency to version 2.0.0

1.0.2

• Added an explicit configureDefaultLogging function for clarity.
• Minor JSDoc updates
• Updated core-functions dependency to 1.2.0

1.0.1

• Simply set core-functions dependency to 1.1.1