Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.64 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.64 KB

Build Status

winston-logzio

A Winston transport wrapper for Logz.io

Versions

Supports Winston 3, If you want to use Winston 2 - Checkout v1.0.8

Installation

npm install winston-logzio --save

Sample usage

const winston = require('winston');
const LogzioWinstonTransport = require('winston-logzio');

const logzioWinstonTransport = new LogzioWinstonTransport({
  level: 'info',
  name: 'winston_logzio',
  token: '__YOUR_API_TOKEN__',
});


const logger = winston.createLogger({
    format: format.simple(),
    transports: [logzioWinstonTransport],
});

logger.log('warn', 'Just a test message');

Make sure you replace __YOUR_API_TOKEN__ with your own logz.io api token.

If you do not have a Logz.io account, you can sign up for a free trial here

Note: If winston-logzio is used as part of a serverless service (AWS Lambda, Azure Functions, Google Cloud Functions, etc.), add logger.close() at the end of the run.

Details

This winston plugin, basically just wraps our nodejs logzio shipper.
If you want to configure the nodejs logger, any parameters sent to winston when initializing the transport (what is held in the variable LogzioWinstonTransport in the sample above) will be passed to the logzio nodejs logger itself.

Logs in my console

The winston logger by default sends all logs to the console.
You can easily disable this by adding this line to your code :

winston.remove(winston.transports.Console);