markrey/loopback-component-logger

Logging component for loopback with add performance instrumentation for remote methods and datasource calls

loopback-component-logger

Logging component for loopback using bunyan logger with additional loopback specific hooks and log management API

Features

• Default logger using bunyan
• Can use of custom bunyan streams to create root logger
• Hook: Basic performance instrumentation for remote execution
• Hook: Log management API (configurable)

Usage

Example server.js:

var loopback = require('loopback');
var boot = require('loopback-boot');
var rootLogger = bunyan.createLogger({name: 'myloopbackAPI'});
var logger = require('loopback-component-logger')(rootLogger);
var app = module.exports = loopback();

If rootLogger is not provide, the component creates a logger with default bunyan settings:

var loopback = require('loopback');
var boot = require('loopback-boot');
var logger = require('loopback-component-logger')();
var app = module.exports = loopback();

Child loggers can be created for model as shown below. By default child loggers inherit the log level from root.

var logger = require('loopback-component-logger')('TestModel');
module.exports = function(TestModel) {
    logger.debug('Initializing TestModel');
};

To add hooks and log management API to loopback, add configuration to component-config.json:

{
  "loopback-component-explorer": {
    "mountPath": "/explorer"
  },
  "loopback-component-logger": {
      "enableAPI" : true
  }
}

Make sure enableHttpContext is set as true in config.json for to allow collection of datasources performance within req/res

License

MIT.

Roadmap

• Additional Unit Test and Coverage
• Integrate with Strongloop Devops tools

Known Issue

• datasources performance will not recorded at times when loopback context is null. Noticed this issue when a composite called MongoDB followed by REST. Only MongoDB response time was recorded and REST was missing.

See Also

• Loopback
• bunyan