toto-logger v5.0.0

Toto Logger

This npm library standardizes the way that toto microservices will log information.

Logs in toto have the following structure:

> [correlationID] - [apiName] - [logType] - [logLevel] - Message

Where:

• correlationID should be always present for apis and reactive microservices and is the identifier that can be used to track the flow of data through sync and async calls
• logType is the type of log. The following log types are accepted:
  • api-in - reserved - to be used only when receiving an API call. This log type must be used only once and only at the moment the API call is received: it shouldn't be used for subsequent log entries. It is only used to record the fact that an API call has been received!
  • api-out - reserved - to be used only when making an outbound API call.
  • event-in - reserved - to be used only when receiving an Event. Same logic applies as for the api-* log type.
  • event-out - reserved - to be used only when publishing an Event. Same logic applies as for the api-* log type.
  • compute - can be used for any log happening during the computation that results from the receiving an event or an api call.
• logLevel is the level of the log. Should only be:
  • debug - only used for debugging purposes
  • info - used for standard info logging
  • warn - used to log warnings
  • error - used to log errors

How to use it

Instantiate it:

const Logger = require('toto-logger');
let logger = new Logger("apiname");

Log, based on the type of log

logger.apiIn(correlationId, method, path);
logger.apiOut(correlationId, microservice, method, path);
logger.eventIn(correlationId, topic);
logger.eventOut(correlationId, topic);
logger.compute(correlationId, message, logLevel);