Nona Node Logging

This packages pre-configures the bunyan logging library for use in node projects.

Installation

npm install nona-node-logging

Overriding defaults

It is recommended that you change the name that the logger uses to log with to something relevant for your project. This is achieved using environmental variables. The following options are available:

• NAME - the name of the application
• LOG_LEVEL - the log level
• LOG_HOST - centralised logging host

Usage

Quick and dirty way:

import logger from 'nona-node-logger'
 
logger.debug({ foo: 'some optional data to log' }, 'some message to log')

Recommended usage is to define a context within each scope of your application. In any particular file that you import the logger into, use the following to create a logger for use within that file:

import logger from 'nona-node-logger'
const mylogger = logger.child({ context: 'My application layer' })
 
mylogger.debug({ foo: 'some optional data to log' }, 'some message to log')

This lets you see where in your application a log came from.

Log levels

These are the standard bunyan supported log levels. This package attempts to set the log level from the environment through the LOG_LEVEL variable. If not present, the default level is error.

Centralised logging

To enable centralised logging, you will need to provide the LOG_HOST option. See the bunyan-elasticsearch repository for preparing your host for logs.

Example usage using logit.io

LOG_HOST="your-stack-id-es.logit.io?apikey=your-api-key" LOG_LEVEL=info NAME=<myapp-myenvironment> npm run start