log4js-node-amqp

log4js-node-amqp

An AMQP appender for log4js-node

Usage:

Configure in code:

var log4js = require('log4js');
var amqpAppender = require('log4js-node-amqp');

log4js.addAppender(
	amqpAppender.appender({
		// more config options available
		connection: {
			url: "amqp://guest:guest@localhost:5672"
		},
		// this is a space for you to add custom bits to every log message
		additonalInfo: {
			machine: require("os").hostname(),
			applicationName: 'example application'
		}
	}),
	'amqp-example'
);

or configure via configure() You could also require() a config .json or .js file here, any Javascript object will work with log4js.

log4js.configure({
	appenders: [
		{
			type: 'console'
		},
		{
			type: 'log4js-node-amqp',
			connection: {
				url: "amqp://guest:guest@localhost:5672"
			},
			// this is a space for you to add custom bits to every log message
			additonalInfo: {
				machine: require("os").hostname(),
				applicationName: 'example application'
			}
			category: 'amqp-example'
		}
	]
});

Log things:

var logger = log4js.getLogger('amqp-example');
// strings work
logger.info('a string of log data.');
// so do objects
logger.info({name: 'a string', type: 'a silly example'});

You can also have a look at the example.

Configuration

This is a log4js appender which uses the awesome node-amqp package and shares a good bit of config with it.

 {
 	// see https://github.com/postwait/node-amqp#connection
	connection: {
		url: "amqp://guest:guest@localhost:5672",
		clientProperties: {
			product: 'log4js'
		}
	},
	// see https://github.com/postwait/node-amqp#connectionexchange
	exchange: {
		name: 'logExchange',
		type: 'fanout',
		durable: true,
		autoDelete: false
	},
	// see https://github.com/postwait/node-amqp#exchangepublishroutingkey-message-options-callback
	publish: {
		mandatory: true,
		deliveryMode: 2, // persistent
		routingKey: 'msg'
	},
	// interval at which to flush messages to the queue, 0 means "immediate"
	sendInterval: 0,
	// a log4js layout, this is ignored if the logged item is an object
	layout: log4js.layouts.messagePassThroughLayout,
	// this is a space for you to add custom bits to every log message
	additonalInfo: {
		//
	}
}

What's sent to the exchange?

// Everything log4js provides, + whatever you added to additonalInfo (keys in additonalInfo are added as keys to the log message).
{
  timestamp: Fri Dec 20 2013 20:54:22 GMT-0800 (PST),
  data: 'test-message',
  level: { level: 20000, levelStr: 'INFO' },
  category: 'test'
}

License

The MIT License

Copyright (c) 2014 Max Nachlinger