0.6.12

adding ability to check if a logger exists

README.md

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

examples/loggly-appender.js

@@ -0,0 +1,24 @@
+//Note that loggly appender needs node-loggly to work.
+//If you haven't got node-loggly installed, you'll get cryptic
+//"cannot find module" errors when using the loggly appender
+var log4js = require('../lib/log4js');
+
+log4js.configure({
+  "appenders": [
+    {
+      type: "console",
+      category: "test"
+    },
+    {
+      "type"     : "loggly",
+      "token"    : "12345678901234567890",
+      "subdomain": "your-subdomain",
+      "tags"     : ["test"],
+      "category" : "loggly"
+    }
+  ]
+});
+
+var logger = log4js.getLogger("loggly");
+logger.info("Test log message");
+//logger.debug("Test log message");

lib/appenders/loggly.js

@@ -0,0 +1,37 @@
+"use strict";
+var layouts = require("../layouts")
+, loggly = require("loggly")
+, os = require('os');
+
+/**
+ * Loggly Appender. Sends logging events to Loggly using node-loggly 
+ *
+ * @param config object with loggly configuration data
+ * {
+ *   token: 'your-really-long-input-token',
+ *   subdomain: 'your-subdomain',
+ *   tags: ['loggly-tag1', 'loggly-tag2', .., 'loggly-tagn'] 
+ * }
+ * @param layout a function that takes a logevent and returns a string (defaults to basicLayout).
+ */
+function logglyAppender(config, layout) {
+	layout = layout || layouts.basicLayout;
+
+	var client = loggly.createClient(config);
+	
+	return function(loggingEvent) {
+		client.log(layout(loggingEvent), config.tags);
+	};
+}
+
+function configure(config) {
+	var layout;
+	if (config.layout) {
+		layout = layouts.layout(config.layout.type, config.layout);
+	}
+	return logglyAppender(config, layout);
+}
+
+exports.name      = "loggly";
+exports.appender  = logglyAppender;
+exports.configure = configure;

lib/connect-logger.js

@@ -120,10 +120,10 @@ function format(str, req, res) {
     .replace(':referrer', req.headers.referer || req.headers.referrer || '')
     .replace(':http-version', req.httpVersionMajor + '.' + req.httpVersionMinor)
     .replace(
-      ':remote-addr', 
+      ':remote-addr', req.ip || req._remoteAddress || ( 
       req.socket && 
         (req.socket.remoteAddress || (req.socket.socket && req.socket.socket.remoteAddress))
-    )
+    ))
     .replace(':user-agent', req.headers['user-agent'] || '')
     .replace(
       ':content-length', 

lib/log4js.js

@@ -62,6 +62,11 @@ var events = require('events')
   replaceConsole: false
 };
 
+function hasLogger(logger) {
+  return loggers.hasOwnProperty(logger);
+}
+
+
 /**
  * Get a logger instance. Instance is cached on categoryName level.
  * @param  {String} categoryName name of category to log to.
@@ -76,7 +81,7 @@ function getLogger (categoryName) {
   }
 
   var appenderList;
-  if (!loggers[categoryName]) {
+  if (!hasLogger(categoryName)) {
     // Create the logger for this name if it doesn't already exist
     loggers[categoryName] = new Logger(categoryName);
     if (appenders[categoryName]) {
@@ -115,7 +120,7 @@ function addAppender () {
     
     if (category === ALL_CATEGORIES) {
       addAppenderToAllLoggers(appender);
-    } else if (loggers[category]) {
+    } else if (hasLogger(category)) {
       loggers[category].addListener("log", appender);
     }
   });
@@ -123,7 +128,7 @@ function addAppender () {
 
 function addAppenderToAllLoggers(appender) {
   for (var logger in loggers) {
-    if (loggers.hasOwnProperty(logger)) {
+    if (hasLogger(logger)) {
       loggers[logger].addListener("log", appender);
     }
   }
@@ -139,7 +144,7 @@ function addAppenderToCategory(appender, category) {
 function clearAppenders () {
   appenders = {};
   for (var logger in loggers) {
-    if (loggers.hasOwnProperty(logger)) {
+    if (hasLogger(logger)) {
       loggers[logger].removeAllListeners("log");
     }
   }
@@ -304,6 +309,7 @@ function loadAppender(appender) {
 module.exports = {
   getLogger: getLogger,
   getDefaultLogger: getDefaultLogger,
+  hasLogger: hasLogger,
   
   addAppender: addAppender,
   loadAppender: loadAppender,

lib/logger.js

@@ -49,9 +49,12 @@ Logger.prototype.removeLevel = function() {
 
 Logger.prototype.log = function() {
   var args = Array.prototype.slice.call(arguments)
-  , logLevel = args.shift()
-  , loggingEvent = new LoggingEvent(this.category, logLevel, args, this);
-  this.emit("log", loggingEvent);
+  , logLevel = levels.toLevel(args.shift())
+  , loggingEvent;
+  if (this.isLevelEnabled(logLevel)) {
+    loggingEvent = new LoggingEvent(this.category, logLevel, args, this);
+    this.emit("log", loggingEvent);
+  }
 };
 
 Logger.prototype.isLevelEnabled = function(otherLevel) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "log4js",
-  "version": "0.6.9",
+  "version": "0.6.12",
   "description": "Port of Log4js to work with node.",
   "keywords": [
     "logging",
@@ -9,7 +9,7 @@
     "node"
   ],
   "main": "./lib/log4js",
-  "author": "Gareth Jones <gareth.jones@sensis.com.au>",
+  "author": "Gareth Jones <gareth.nomiddlename@gmail.com>",
   "repository": {
     "type": "git",
     "url": "https://github.com/nomiddlename/log4js-node.git"

test/logglyAppender-test.js

@@ -0,0 +1,82 @@
+"use strict";
+var vows = require('vows')
+, assert = require('assert')
+, log4js = require('../lib/log4js')
+, sandbox = require('sandboxed-module')
+;
+
+function setupLogging(category, options) {
+  var msgs = [];
+  
+  var fakeLoggly = {
+    createClient: function (options) {
+      return {
+        config: options,
+        log: function (msg, tags) {
+          msgs.push({
+            msg: msg,
+            tags: tags
+          });
+        }
+      };
+    }
+  };
+
+  var fakeLayouts = {
+    layout: function(type, config) {
+      this.type = type;
+      this.config = config;
+      return log4js.layouts.messagePassThroughLayout;
+    },
+    basicLayout: log4js.layouts.basicLayout,
+    messagePassThroughLayout: log4js.layouts.messagePassThroughLayout
+  };
+
+  var fakeConsole = {
+    errors: [],
+    error: function(msg, value) {
+      this.errors.push({ msg: msg, value: value });
+    }
+  };
+
+  var logglyModule = sandbox.require('../lib/appenders/loggly', {
+    requires: {
+      'loggly': fakeLoggly,
+      '../layouts': fakeLayouts
+    },
+    globals: {
+      console: fakeConsole
+    }
+  });
+
+  log4js.addAppender(logglyModule.configure(options), category);
+  
+  return {
+    logger: log4js.getLogger(category),
+    loggly: fakeLoggly,
+    layouts: fakeLayouts,
+    console: fakeConsole,
+    results: msgs
+  };
+}
+
+log4js.clearAppenders();
+vows.describe('log4js logglyAppender').addBatch({
+  'minimal config': {
+    topic: function() {
+      var setup = setupLogging('loggly', {
+        token: 'your-really-long-input-token',
+        subdomain: 'your-subdomain',
+        tags: ['loggly-tag1', 'loggly-tag2', 'loggly-tagn'] 
+      });
+      
+      setup.logger.log('trace', 'Log event #1');
+      return setup;
+    },
+    'there should be one message only': function (topic) {
+      //console.log('topic', topic);
+      assert.equal(topic.results.length, 1);
+    }
+  }
+
+}).export(module);