priviti-logger v1.0.0

Priviti-Logger

A log4js wrapper.

Overview

priviti-logger provides a quick and easy wrapper around log4js in order to get standardised log configurations that can be shared across projects, logger names and correlationIds.

Usage

yarn add https://s3-eu-west-1.amazonaws.com/priviti-npm-repo/priviti-logger-{VERSION}.tgz

Priviti-Middleware integration

priviti-logger was designed to be used as part of an express middleware, where each request is generated a new correlationId and a new logger based on that correlationId. The simplest way to start using priviti-logger is to add a dependency on priviti-middleware:

const { correlationIdMiddleware, loggerMiddleware } = require('priviti-middleware');
...
app.use(correlationIdMiddleware());
app.use(loggerMiddleware('<logger name>'));
...
function helloWorld(req, res, next) {
  req.meta.logger('Hello, World!');
}

Now each request will have priviti-logger attached to the meta object. For more info see the priviti-middleware docs.

Standalone usage

const PrivitiLogger = require('priviti-logger');
...
const logger = new PrivitiLogger('<logger name>', '<correlation id>').logger();
logger.info('use the logger exactly as log4js is used');