ney-log v1.1.0

ney-log

A logger package (built with backend APIs in mind) designed to handle logs and put together relevant metadata. The package itself does not actually log anywhere, but requires you to add delegate methods that it can call upon when a new log has been received.

Adding to project

• Install: npm install @neylion/log
• Initialize (before any calls to log):
  • Importing: const { init } = require("@neylion/log");
  • Initializing: init(logDelegates);
• Log:
  • Importing: const { log } = require("@neylion/log");
  • Logging: log.error("Message", errorObject, { metadata1: "Useful context", metadata2: "useful context" })

Log Levels

Log Delegates

When initializing the logger, you are required to provide an array of methods (delegates) that will do the actual logging. These delegates will be called, when a new log has been processed, with all the data relevant to that specific log.

Here are two small examples on how you can set up your own log delegate method:

Simply logging the whole logData object as json

function consoleLogger(logData){
  console.log(logData);
}

Logging message after customizing it

function consoleLogger(logData){
  // Customize message the way you want it
  let message = `${logData.direction} ${logData.message} | CorrId: ${logData.correlationId}`;
  // Add direction if it exists
  message = logData.direction ? `${logData.direction} ${message}` : message;
  console.log(`${logData.level} ${message}`);
}

If you use typescript you can import the interface "ILogData" to be able to more easily handle the logData parameter. If using plain javascript, see the following section for a list of what the object contains

Log Data

The packages processes a lot of useful information and makes them available to the log delegates through the parameter sent to them. Here are all the properties available on the object:

requestContext properties