ovh-winston-ldp
v0.3.3
Published
A OVH Logs Data Platform TCP/TLS transport for winston
Downloads
122
Readme
ovh-winston-ldp
A graylog2 TCP/TLS transport for winston library
const winston = require('winston');
winston.add(require('ovh-winston-ldp'), {
level: 'debug',
graylogOvhTokenValue: "GRAY_LOG_TOKEN"
});
logger.info("Hello world!");
logger.log('warn', 'Test Log Message', {"anything": 'This is metadata' });
Installation
Winston-graylog works with NodeJS 6.0.0+.
The easiest way to install it is to use yarn
$yarn add ovh-winston-ldp
Usage
const winston = require('winston');
winston.add(require('ovh-winston-ldp'), options);
or
const OvhWinstonLDP = require('ovh-winston-ldp');
const logger = new(winston.Logger)({
exitOnError: false,
transports: [
new(OvhWinstonLDP)(options)
]
});
Options
- name: Transport name
- level: Level of messages this transport should log. (default: info)
- silent: Boolean flag indicating whether to suppress output. (default: false)
- autoReconnect: Boolean flag indicating whether to reconnect on error. (default: false)
- graylogHost: your server address (default: localhost)
- graylogPort: your server port (default: 12201)
- graylogFlag: Required on LDP Alpha
- graylogOvhTokenKey: Required on LDP Beta
- graylogOvhTokenValue: Required on LDP Beta
- hostname: the name of this host (default: os.hostname())
- facility: the facility for these log messages (default: "Node.js")
Log Levels
Supported log levels, are the following
Winston Level | Graylog2 level ---------------|--------------- emerg | emergency alert | alert crit | critical error | error warning | warning notice | notice info | info debug | debug
All other possibile winston's level, or custom levels, will default to info