Merge pull request log4js-node#387 from sparklton/master

logFaces appender

Author: nomiddlename

README.md

@@ -15,6 +15,7 @@ Out of the box it supports the following features:
 * hook.io appender
 * Loggly appender
 * Logstash UDP appender
+* logFaces appender
 * multiprocess appender (useful when you've got worker processes)
 * a logger for connect/express servers
 * configurable log message layout/patterns

examples/logFaces-appender.js

@@ -0,0 +1,24 @@
+var log4js = require('../lib/log4js');
+
+/*
+   logFaces server configured with UDP receiver, using JSON format,
+   listening on port 55201 will receive the logs from the appender below.
+*/
+
+log4js.configure({
+  "appenders": [
+    {
+      "type": "logFacesAppender",       // (mandatory) appender type
+      "application": "MY-NODEJS",       // (optional) name of the application (domain)
+      "remoteHost": "localhost",        // (optional) logFaces server host or IP address
+      "port": 55201,                    // (optional) logFaces UDP receiver port (must use JSON format)  
+      "layout": {                       // (optional) the layout to use for messages
+        "type": "pattern",
+        "pattern": "%m"
+      }       
+    }
+  ]
+});
+
+var logger = log4js.getLogger("myLogger");
+logger.info("Testing message %s", "arg1");

lib/appenders/logFacesAppender.js

@@ -0,0 +1,71 @@
+/**
+* logFaces appender sends JSON formatted log events to logFaces server UDP receivers.
+* Events contain the following properties:
+*  - application name (taken from configuration)
+*  - host name (taken from underlying os)
+*  - time stamp
+*  - level
+*  - logger name (e.g. category)
+*  - thread name (current process id)
+*  - message text
+*/
+
+"use strict";
+var dgram = require('dgram'),
+    layouts = require('../layouts'),
+    os = require('os'),
+    util = require('util');
+
+try{
+ 	var process = require('process');
+}
+catch(error){
+   //this module is optional as it may not be available
+ 	//in older versions of node.js, so ignore if it failes to load
+}
+
+function logFacesAppender (config, layout) {
+  var lfsSock = dgram.createSocket('udp4');
+  var localhost = "";
+
+  if(os && os.hostname())
+     localhost = os.hostname().toString();
+
+   var pid = "";
+   if(process && process.pid)
+      pid = process.pid;
+
+  return function log(loggingEvent) {
+    var lfsEvent = {
+      a: config.application || "",                      // application name
+      h: localhost,                                     // this host name
+      t: loggingEvent.startTime.getTime(),              // time stamp
+      p: loggingEvent.level.levelStr,                   // level (priority)
+      g: loggingEvent.categoryName,                     // logger name
+      r: pid,                                           // thread (process id)
+      m: layout(loggingEvent)                           // message text
+    };
+
+    var buffer = new Buffer(JSON.stringify(lfsEvent));
+    var lfsHost = config.remoteHost || "127.0.0.1";
+    var lfsPort = config.port || 55201;
+    lfsSock.send(buffer, 0, buffer.length, lfsPort, lfsHost, function(err, bytes) {
+       if(err) {
+         console.error("log4js.logFacesAppender send to %s:%d failed, error: %s",
+                        config.host, config.port, util.inspect(err));
+       }
+    });
+  };
+}
+
+function configure(config) {
+	var layout;
+	if (config.layout)
+		layout = layouts.layout(config.layout.type, config.layout);
+    else
+       layout = layouts.layout("pattern", {"type": "pattern", "pattern": "%m"});
+   return logFacesAppender(config, layout);
+}
+
+exports.appender = logFacesAppender;
+exports.configure = configure;

test/logFacesAppender-test.js

@@ -0,0 +1,96 @@
+"use strict";
+var vows = require('vows'),
+    assert = require('assert'),
+    log4js = require('../lib/log4js'),
+    sandbox = require('sandboxed-module');
+
+function setupLogging(category, options) {
+  var udpSent = {};
+
+  var fakeDgram = {
+    createSocket: function (type) {
+      return {
+        send: function(buffer, offset, length, port, host, callback) {
+          udpSent.date = new Date();
+          udpSent.host = host;
+          udpSent.port = port;
+          udpSent.length = length;
+          udpSent.offset = 0;
+          udpSent.buffer = buffer;
+          callback(undefined, length);
+        }
+      };
+    }
+  };
+
+  var lfsModule = sandbox.require('../lib/appenders/logFacesAppender', {
+    requires: {
+      'dgram': fakeDgram
+    }
+  });
+  log4js.clearAppenders();
+  log4js.addAppender(lfsModule.configure(options), category);
+
+  return {
+    logger: log4js.getLogger(category),
+    results: udpSent
+  };
+}
+
+vows.describe('logFaces UDP appender').addBatch({
+  'when logging to logFaces UDP receiver': {
+    topic: function() {
+      var setup = setupLogging('myCategory', {
+         "type": "logFacesAppender",
+         "application": "LFS-TEST",
+         "remoteHost": "127.0.0.1",
+         "port": 55201,
+         "layout": {
+           "type": "pattern",
+           "pattern": "%m"
+         }
+      });
+
+      setup.logger.warn('Log event #1');
+      return setup;
+    },
+    'an UDP packet should be sent': function (topic) {
+      assert.equal(topic.results.host, "127.0.0.1");
+      assert.equal(topic.results.port, 55201);
+      assert.equal(topic.results.offset, 0);
+      var json = JSON.parse(topic.results.buffer.toString());
+      assert.equal(json.a, 'LFS-TEST');
+      assert.equal(json.m, 'Log event #1');
+      assert.equal(json.g, 'myCategory');
+      assert.equal(json.p, 'WARN');
+
+      // Assert timestamp, up to hours resolution.
+      var date = new Date(json.t);
+      assert.equal(
+        date.toISOString().substring(0, 14),
+        topic.results.date.toISOString().substring(0, 14)
+      );
+    }
+  },
+
+  'when missing options': {
+    topic: function() {
+      var setup = setupLogging('myLogger', {
+          "type": "logFacesAppender",
+      });
+      setup.logger.error('Log event #2');
+      return setup;
+    },
+    'it sets some defaults': function (topic) {
+      assert.equal(topic.results.host, "127.0.0.1");
+      assert.equal(topic.results.port, 55201);
+
+      var json = JSON.parse(topic.results.buffer.toString());
+      assert.equal(json.a, "");
+      assert.equal(json.m, 'Log event #2');
+      assert.equal(json.g, 'myLogger');
+      assert.equal(json.p, 'ERROR');
+    }
+  }
+
+}).export(module);