[Cluster][Master/Worker][Logger][Scaffolding] Implemented request-access-logger for single worker and cluster. Added GNU makefile for new projects.

Author: Jack12816

lib/app/cluster/master/ipc/logger.js

@@ -40,21 +40,48 @@ var Logger = function(options)
     };
 
     // Setup winston logger
-    this.logger = new winston.Logger(workerLoggerConf);
+    this.default = new winston.Logger(workerLoggerConf);
+
+    var workerRequestLoggerConf = {
+        transports: [
+            new (winston.transports.File)({
+                json: false,
+                filename: process.cwd() + '/var/log/' + greppy.context + '.access.log'
+            })
+        ]
+    };
+
+    // Setup winston request logger
+    this.request = new winston.Logger(workerRequestLoggerConf);
 };
 
 /**
  * Log an given worker request with userdefined content.
  */
 Logger.prototype.log = function(msg, options)
 {
-    options.msg = '[' + new String(msg.reqPid).white + '] ' + options.msg;
+    if ('undefined' === typeof options.type) {
+        options.type = 'default';
+    }
+
+    if (!this.hasOwnProperty(options.type)) {
+
+        return this.default.log('error',
+            'Logger "' + options.type + '" is not registered.'
+        );
+    }
+
+    // Modify the log request for the default logger
+    if ('default' === options.type) {
+
+        options.msg = '[' + new String(msg.reqPid).white + '] ' + options.msg;
 
-    if ('debug' !== options.level && 'error' !== options.level) {
-        options.msg = ' ' + options.msg;
+        if ('debug' !== options.level && 'error' !== options.level) {
+            options.msg = ' ' + options.msg;
+        }
     }
 
-    this.logger.log(options.level, options.msg, options.meta);
+    this[options.type].log(options.level, options.msg, options.meta);
 }
 
 module.exports = Logger;

lib/app/cluster/worker.js

@@ -41,8 +41,19 @@ var Worker = function(options, callback)
 
                         return part;
                     },
-                    "level"  : 'debug',
-                    "silent" : false
+                    level  : 'debug',
+                    silent : false
+                })
+            ]
+        },
+        requestLogger: {
+            transports: [
+                new (IPCLogger)({
+                    type     : 'request',
+                    worker   : this,
+                    colorize : false,
+                    level    : 'info',
+                    silent   : false
                 })
             ]
         }

lib/app/cluster/worker/ipc/logger.js

@@ -16,6 +16,7 @@ var IPCLogger = winston.transports.IPCLogger = function (options)
     this.name   = 'IPCLogger';
     this.level  = options.level || 'info';
     this.worker = options.worker;
+    this.type   = options.type || 'default';
 };
 
 /**
@@ -33,7 +34,8 @@ IPCLogger.prototype.log = function (level, msg, meta, callback)
     this.worker.getIPC().request('logger.log', {
         level : level,
         msg   : msg,
-        meta  : meta
+        meta  : meta,
+        type  : this.type
     });
 
     callback(null, true);

lib/app/worker.js

@@ -5,13 +5,13 @@
  * @author Hermann Mayer <hermann.mayer92@gmail.com>
  */
 
-var cluster = require('cluster');
-var winston = require('winston');
-var moment  = require('moment');
-var colors  = require('colors');
-var extend  = require('extend');
-var getopt  = require('node-getopt');
-
+var cluster          = require('cluster');
+var winston          = require('winston');
+var expressWinston   = require('express-winston');
+var moment           = require('moment');
+var colors           = require('colors');
+var extend           = require('extend');
+var getopt           = require('node-getopt');
 var ControllerLoader = require('../http/mvc/loader');
 
 /**
@@ -94,15 +94,28 @@ var Worker = function(options)
 
                     return part;
                 },
-                "level"  : 'debug',
-                "silent" : false
+                level  : 'debug',
+                silent : false
             })
         ]
     };
 
-    var loggerConf = extend(true, defaultLoggerConf, this.options.logger || {});
+    var loggerConf = extend(true, {}, defaultLoggerConf, this.options.logger || {});
     this.logger    = new winston.Logger(loggerConf);
     greppy.logger  = global.logger = this.logger;
+
+    // Setup winston request logger
+    var defaultRequestLoggerConf = {
+        transports: [
+            new (winston.transports.File)({
+                json: false,
+                filename: process.cwd() + '/var/log/' + greppy.context + '.access.log'
+            })
+        ]
+    };
+
+    var requestLoggerConf = extend(false, {}, defaultRequestLoggerConf, this.options.requestLogger || {});
+    this.requestLogger    = expressWinston.logger(requestLoggerConf);
 };
 
 /**
@@ -135,6 +148,9 @@ Worker.prototype.configure = function(app, server, callback)
 
     var setupModules = function()
     {
+        // Push the request logger to the middleware stack
+        app.use(self.requestLogger);
+
         var listenServer = function() {
 
             // Load all routes into the application
@@ -226,7 +242,7 @@ Worker.prototype.configure = function(app, server, callback)
             }
 
             // Configure the app with Greppy enhancements
-            var defaultApp = new (require('./worker/app'))(self.context);
+            var defaultApp = new (require('./worker/app'))(self);
 
             defaultApp.configure(self.app, self.server, listenServer);
         }

lib/app/worker/app.js

@@ -10,13 +10,14 @@ var express = require('express');
 /**
  * @constructor
  *
- * @param {Object} context - Worker context
+ * @param {Object} worker - Worker object
  */
-var App = function(context)
+var App = function(worker)
 {
     var self = this;
 
-    this.context = context;
+    this.context     = worker.context;
+    this.worker      = worker;
     this.controllers = {};
 
     this.context.routes.forEach(function(route) {

package.json

@@ -35,6 +35,7 @@
         "node-fs": "~0.1.5",
         "async": "~0.2.5",
         "winston": "~0.7.2",
+        "express-winston": "~0.2.1",
         "extend": "~1.1.3",
         "moment": "~2.2.1",
         "memory-cache": "~0.0.5",

templates/project/Makefile

@@ -0,0 +1,15 @@
+.PHONY: all clean configure deinstall install
+
+configure:
+uninstall:
+clean:
+	# Clean logs
+	@eval `find ./var/log -type f -name '*.log' | awk '{print "echo \"\033[0;31mremove \033[0m" $$0 "\" && rm " $$0 ";"}'`
+
+install: configure
+	##### Install backend vendor packages #####
+	@npm install
+
+	##### Install frontend vendor packages #####
+	@bower install
+

templates/project/package.json

@@ -21,7 +21,6 @@
         "node-uuid"         : "~1.4.0",
         "validator"         : "~1.2.1",
         "express-validator" : "~0.3.2",
-        "winston"           : "~0.7.2",
-        "express-winston"   : "~0.2.0"
+        "winston"           : "~0.7.2"
     }
 }