bunyan-loggly
A bunyan stream to send logs through to loggly.
Configuration
bunyan-loggly uses node-loggly under the hood. As such, when configuring bunyan-loggly as a stream for bunyan, you need to pass in the standard and required node-loggly configuration object.
For example:
{
token: "your-really-long-input-token",
subdomain: "your-subdomain"
}Usage
This is a basic usage example.
var bunyan = require('bunyan');
var Bunyan2Loggly = require('bunyan-loggly');
var logglyConfig = {
token: 'your-account-token',
subdomain: 'your-sub-domain',
};
var logglyStream = new Bunyan2Loggly(logglyConfig);
// create the logger
var logger = bunyan.createLogger({
name: 'logglylog',
streams: [
{
type: 'raw',
stream: logglyStream,
},
],
});
logger.info({});Please note: you MUST define
type: 'raw'as bunyan-loggly expects to receive objects so that certain values can be changed as required by loggly (i.e. time to timestamp).
Buffering
bunyan-loggly supports basic buffering by default and when setup, will only send your logs through to loggly on every x logs. To setup buffering, just pass an integer as the second parameter when creating a new instance of Bunyan2Loggly:
var bunyan = require('bunyan');
var Bunyan2Loggly = require('bunyan-loggly');
var logglyConfig = {
token: 'your-account-token',
subdomain: 'your-sub-domain',
};
var bufferLength = 5;
var logglyStream = new Bunyan2Loggly(logglyConfig, bufferLength);
// create the logger
var logger = bunyan.createLogger({
name: 'logglylog',
streams: [
{
type: 'raw',
stream: logglyStream,
},
],
});
logger.info({}); // won't send to loggly
logger.info({}); // won't send to loggly
logger.info({}); // won't send to loggly
logger.info({}); // won't send to loggly
logger.info({}); // will send to loggly
logger.info({}); // won't send to logglyBuffer Timeout
When buffering, a timeout can be provided to force flushing the buffer after a period of time. To setup a flush timeout, pass a timeout value (in ms) as the third parameter when creating a new instance of Bunyan2Loggly:
var bunyan = require('bunyan');
var Bunyan2Loggly = require('bunyan-loggly');
var logglyConfig = {
token: 'your-account-token',
subdomain: 'your-sub-domain',
};
var bufferLength = 5;
var bufferTimeout = 500;
var logglyStream = new Bunyan2Loggly(logglyConfig, bufferLength, bufferTimeout);
// create the logger
var logger = bunyan.createLogger({
name: 'logglylog',
streams: [
{
type: 'raw',
stream: logglyStream,
},
],
});
logger.info({}); // will be sent to loggly in 500ms if buffer threshold is not reachedTurning off buffering
You can turn off buffering by passing isBulk: false to the bunnyan2loggly config object.
var bunyan = require('bunyan');
var Bunyan2Loggly = require('bunyan-loggly');
var logglyConfig = {
token: 'your-account-token',
subdomain: 'your-sub-domain',
isBulk: false,
};
var logglyStream = new Bunyan2Loggly(logglyConfig);
// create the logger
var logger = bunyan.createLogger({
name: 'logglylog',
streams: [
{
type: 'raw',
stream: logglyStream,
},
],
});
logger.info({}); // sent to loggly
logger.info({}); // sent to loggly
logger.info({}); // sent to logglyLoggly request information
Each time log content is sent to loggly, the result of this request will be passed to the optional callback paramer logglyCallback
var bunyan = require('bunyan');
var Bunyan2Loggly = require('bunyan-loggly');
var logglyConfig = {
token: 'your-account-token',
subdomain: 'your-sub-domain',
};
function logglyCallback(error, result, content) {
// handle loggly callback
}
var logglyStream = new Bunyan2Loggly(logglyConfig, null, null, logglyCallback);