Merge pull request #296 from lumberj/feature/elf-logging

[FEATURE] Production logs in ELF format (RLJS-239)

api/lib/logger.js

@@ -7,30 +7,13 @@ var logger = new winston.Logger({
       prettyPrint: true,
       colorize: true,
       timestamp: true,
-      handleExceptions: true
+      handleExceptions: true,
+      logLevel: 'info',
+      showLevel: true,
+      silent: config.get('NODE_ENV') === 'test'
     })
-  ]
+  ],
+  exitOnError: false
 });
 
-var loggerStream = {write: function (data) {
-  logger.info(data.replace(/\n$/, ''));
-}};
-
-var logInfo = logger.info;
-
-logger.info = function() {
-  if (config.get('NODE_ENV') !== 'test') {
-    logInfo.apply(logger, arguments);
-  }
-};
-
-var logError = logger.error;
-
-logger.error = function() {
-  if (config.get('NODE_ENV') !== 'test') {
-    logError.apply(logger, arguments);
-  }
-};
-
 exports.logger = logger;
-exports.loggerStream = loggerStream;

server/express_app.js

@@ -1,8 +1,8 @@
 const ripple     = require('ripple-lib');
 const express    = require('express');
 const bodyParser = require('body-parser');
-const morgan     = require('morgan');
-const logger     = require('./logger.js');
+const logger     = require('./logger.js').logger;
+const morgan     = require('./logger.js').morgan;
 const config     = require('../api/lib/config');
 const router     = require('./router.js');
 const version    = require('./version.js');
@@ -24,13 +24,11 @@ app.use(function(req, res, next) {
   next();
 });
 
-if (config.get('NODE_ENV') !== 'test') {
-  app.use(morgan('dev', { stream: logger.loggerStream }));
-}
+morgan(app);
 
 if (config.get('debug')) {
   app.use(function (req, res, next) {
-    logger.logger.info(req.method, req.url, req.body);
+    logger.info(req.method, req.url, req.body);
     next();
   })
 }

server/logger.js

@@ -1,36 +1,76 @@
-var winston = require('winston');
-var config = require('../api/lib/config');
+const winston = require('winston');
+const config  = require('../api/lib/config');
+const morgan  = require('morgan');
+const utils   = require('../api/lib/utils.js');
 
-var logger = new winston.Logger({
+
+var logger = exports.logger = new winston.Logger({
   transports: [
     new winston.transports.Console({
       prettyPrint: true,
       colorize: true,
+      handleExceptions: true,
+      level: 'info',
+      showLevel: true,
       timestamp: true,
-      handleExceptions: true
+      silent: config.get('NODE_ENV') === 'test'
     })
-  ]
+  ],
+  exitOnError: false
 });
 
-var loggerStream = {write: function (data) {
-  logger.info(data.replace(/\n$/, ''));
-}};
+/**
+ * Setup server logging middleware
+ *
+ * Production logs conform to Extended Log File Format:
+ * http://www.w3.org/TR/WD-logfile
+ */
+
+/**
+ *  Returns the a date-time in ELF format (e.g, 2015-02-20 00:02:08)
+ */
+function elfDate() {
+  return new Date().toISOString().replace('T', ' ').substr(0, 19);
+}
 
-var logInfo = logger.info;
+// ELF Headers
+var elfHeaders = 
+  '\n#Version: 1.0\n' +
+  '#Date: ' + elfDate() + '\n' + 
+  '#Software: ' + utils.getPackageVersion() + '\n' + 
+  '#Fields: c-ip date time cs-method cs-uri cs(Version) sc-status time-taken cs(User-Agent)';
 
-logger.info = function() {
-  if (config.get('NODE_ENV') !== 'test') {
-    logInfo.apply(logger, arguments);
+// Logging in ELF format (http://www.w3.org/TR/WD-logfile)
+var morganFormat = ':remote-addr :datetime :method :url :http-version :status '
+                 + ':response-time :user-agent';
+
+// Both morgan and winston append a newline
+var stream = {
+  write: function (data) {
+    logger.info(data.slice(0, -1));
   }
 };
 
-var logError = logger.error;
+// Define the datetime token in ELF format
+morgan.token('datetime', elfDate);
+
+// Define the user-agent token in ELF format
+morgan.token('user-agent', function(req, res) {
+  return req.get('User-Agent').split(' ').join('+');
+});
+
+exports.morgan = function(app) {
+  if (config.get('NODE_ENV') === 'production') {
+    app.use(morgan(morganFormat));
+
+    logger.timestamp   = false;
+    logger.prettyPrint = false;
+    logger.colorize    = false;
+    logger.showLevel   = false;
 
-logger.error = function() {
-  if (config.get('NODE_ENV') !== 'test') {
-    logError.apply(logger, arguments);
+    logger.info(elfHeaders);
+  } else {
+    app.use(morgan('dev', {stream: stream}));
   }
 };
 
-exports.logger = logger;
-exports.loggerStream = loggerStream;