winston-bugsnag-logger
node-url
bugsnag-url
winston-url
license-urlThe maintained and well-documented Bugsnag transport for the winston logger.
Full API documentation is available at:
Index
- Log Level MappingInstall
npm install --save winston winston-bugsnag-logger
Usage
You can configurewinston-bugsnag-logger
in two different ways.With
new winston.Logger
:const winston = require('winston');
const Bugsnag = require('winston-bugsnag-logger');
const options = {
apiKey: '*******',
level: 'info'
};
const logger = new winston.Logger({
transports: [
new Bugsnag(options)
]
});
Or with winston's
add
method:const winston = require('winston');
const Bugsnag = require('winston-bugsnag-logger');
const logger = new winston.Logger();
logger.add(Bugsnag, options);
See Options below for custom configuration.
Options (options
)
Per options
variable above, here are the default options provided:Default options:
apiKey
(String) - your Bugsnag API key (defaults toprocess.env.BUGSNAG_API_KEY
)config
(Object) - a Bugsnag configuration objectbugsnag
(Object) - an optional instance ofbugsnag
that is already configured viabugsnag.register
(if provided this will be used instead of theconfig
option)
Transport related options:
name
(String) - transport's name (defaults tobugsnag
)silent
(Boolean) - suppress logging (defaults tofalse
)level
(String) - transport's level of messages to log (defaults toinfo
)levelsMap
(Object) - log level mapping to Bugsnag (see Log Level Mapping below)
Log Level Mapping
Winston logging levels are mapped by default to Bugsnag's acceptable levels.These defaults are set as `options.levelsMap' and are:
{
silly: 'info',
verbose: 'info',
info: 'info',
debug: 'debug',
warn: 'warning',
error: 'error'
}
You can customize how log levels are mapped using the
levelsMap
option:new Bugsnag({
levelsMap: {
verbose: 'info'
}
});
If no log level mapping was found for the given
level
passed, then it will not log anything.