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

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

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

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

Configure logging on the context object

To configure default logging on an existing object:

configureLogging(context);

To configure WARN level logging on an existing object

configureLogging(context, WARN);

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

configureLogging(context, DEBUG, false, console, false, false);

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

configureLogging(context, DEBUG, false, console, false, true);

To configure simple default logging on a new object

const log = configureLogging({});

To configure default logging on an existing object

configureDefaultLogging(context);

To configure default logging on an existing object with an explicit logger and forceConfiguration true

configureDefaultLogging(context, console, true);

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

To configure logging from a config object with settings under config.logging

const config = { logging: { logLevel: DEBUG, useLevelPrefixes: true, useConsoleTrace: false } }; // replace with your own config object

configureLoggingFromConfig(context, config);

// Alternatives specifying optional underlying logger and/or forceConfiguration 
configureLoggingFromConfig(context, config, console);
configureLoggingFromConfig(context, config, undefined, true);

To configure logging from a config object with settings directly under config

const config = { logLevel: DEBUG, useLevelPrefixes: true, useConsoleTrace: false }; // replace with your own config object

configureLoggingFromConfig(context, config);

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

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

1.0.6

Updated core-functions dependency to version 2.0.3

FAQs

What is logging-utils?

Is logging-utils popular?

Is logging-utils well maintained?

Package last updated on 15 Nov 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install