1.1.1 • Published 7 years ago

be-error-logger v1.1.1

Weekly downloads
58
License
Apache-2.0
Repository
github
Last release
7 years ago

Behance Error Logger Build Status NPM version

This Browser / Node.js library is a helper for logging errors in the Be format.

Usage

Designed as contents of: <APP_ROOT>/lib/core/loggers.js:

const loggerFactory = require('be-error-logger');
module.exports = loggerFactory.create('My Application', process.pid, process.stdout, process.stderr);

Then, in many other places within the application:

const loggers = require('./core/loggers');

const logger = loggers.get('name_of_file');

// ...

logger.info('stats_channel', 'some_description', { time_in_ms: 34 });

Output to stdout:

[2017-02-01 23:13:10] CHANNEL='stats_channel' LEVEL='INFO' APP_NAME='My Application' MESSAGE='name_of_file:some_description' PID='3421' TIME_IN_MS='34'\n

Logger

loggers.get() returns a Logger with the following interface:

  • 'error' - prints to errstream
  • 'info' - prints to outstream
  • 'notice' - prints to outstream
  • 'warn' - prints to outstream

Each of these, in turn, has the following interface:

  • channel - String - rendered as `CHANNEL='name_of_chan'
  • message - String - rendered as MESSAGE='context:message'
  • optional - Object - rendered as KEY1='value1' KEY2='value2' etc.

License

Apache-2.0