winston-middleware 1.1.0 → 1.3.0

package/.travis.yml

@@ -1,10 +1,11 @@
+sudo: false
 language: node_js
 node_js:
-  - "0.6"
-  - "0.8"
   - "0.10"
   - "0.11"
   - "0.12"
+  - "4.2"
+  - "5.3"
   - "iojs"
 
 script:

package/AUTHORS

@@ -5,3 +5,4 @@ Xavier Damman (http://xdamman.com)
 Quentin Rossetti <quentin.rossetti@gmail.com>
 Damian Kaczmarek <rush@rushbase.net>
 Robbie Trencheny <me@robbiet.us> (http://robbie.io)
+Ross Brandes <ross.brandes@gmail.com>

package/Readme.md

@@ -1,17 +1,17 @@
 # winston-middleware
-[![Build Status](https://secure.travis-ci.org/bithavoc/winston-middleware.png)](http://travis-ci.org/bithavoc/winston-middleware)
+[![Monthly Downloads](https://img.shields.io/npm/dm/winston-middleware.svg)](https://www.npmjs.com/package/winston-middleware) [![Build Status](https://secure.travis-ci.org/bithavoc/winston-middleware.png)](http://travis-ci.org/bithavoc/winston-middleware)
 
 > [winston](https://github.com/flatiron/winston) middleware for express.js
 
 ## Installation
 
-Newcomers should start with the latest branch which makes use of winston 1.x.x:
+Newcomers should start with the latest branch which makes use of winston 1.x.x and supports node >= 0.10:
 
     npm install winston-middleware
 
 If you're already using winston-middleware, and want to stick with the stable version based on winston 0.9.x, you should instead do:
 
-    npm install winston-middleware@0.3.x --save
+    npm install winston-middleware@0.x.x --save
 
 ## Usage
 
@@ -39,64 +39,91 @@ var winston = require('winston'),
     expressWinston = require('winston-middleware');
 ```
 
-### Error Logging
+### Request Logging
 
-Use `expressWinston.errorLogger(options)` to create a middleware that log the errors of the pipeline.
+Use `expressWinston.logger(options)` to create a middleware to log your HTTP requests.
 
 ``` js
     var router = require('./my-express-router');
 
-    app.use(router); // notice how the router goes first.
-    app.use(expressWinston.errorLogger({
+    app.use(expressWinston.logger({
       transports: [
         new winston.transports.Console({
           json: true,
           colorize: true
         })
-      ]
+      ],
+      meta: true, // optional: control whether you want to log the meta data about the request (default to true)
+      msg: "HTTP {{req.method}} {{req.url}}", // optional: customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}"
+      expressFormat: true, // Use the default Express/morgan request formatting, with the same colors. Enabling this will override any msg and colorStatus if true. Will only output colors on transports with colorize set to true
+      colorStatus: true, // Color the status code, using the Express/morgan color palette (default green, 3XX cyan, 4XX yellow, 5XX red). Will not be recognized if expressFormat is true
+      ignoreRoute: function (req, res) { return false; } // optional: allows to skip some log messages based on request and/or response
     }));
-```
 
-The logger needs to be added AFTER the express router(`app.router)`) and BEFORE any of your custom error handlers(`express.handler`). Since winston-middleware will just log the errors and not __handle__ them, you can still use your custom error handler like `express.handler`, just be sure to put the logger before any of your handlers.
+    app.use(router); // notice how the router goes after the logger.
+```
 
-### Options
+#### Options
 
 ``` js
     transports: [<WinstonTransport>], // list of all winston transports instances to use.
-    winstonInstance: <WinstonLogger>, // a winston logger instance. If this is provided the transports option is ignored
+    winstonInstance: <WinstonLogger>, // a winston logger instance. If this is provided the transports option is ignored.
     level: String, // log level to use, the default is "info".
-    statusLevels: Boolean // different HTTP status codes caused log messages to be logged at different levels (info/warn/error), the default is false
-    skip: function(req, res) // function to determine if logging is skipped, defaults to false
-```
+    msg: String // customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}", "HTTP {{req.method}} {{req.url}}".
+    expressFormat: Boolean, // Use the default Express/morgan request formatting, with the same colors. Enabling this will override any msg and colorStatus if true. Will only output colors on transports with colorize set to true
+    colorStatus: Boolean, // Color the status code, using the Express/morgan color palette (default green, 3XX cyan, 4XX yellow, 5XX red). Will not be recognized if expressFormat is true
+    meta: Boolean, // control whether you want to log the meta data about the request (default to true).
+    baseMeta: Object, // default meta data to be added to log, this will be merged with the meta data.
+    metaField: String, // if defined, the meta data will be added in this field instead of the meta root object.
+    statusLevels: Boolean or Object // different HTTP status codes caused log messages to be logged at different levels (info/warn/error), the default is false. Use an object to control the levels various status codes are logged at.
+    ignoreRoute: function (req, res) { return false; } // allows to skip some log messages based on request and/or response.
+    skip: function(req, res) { return false; } // function to determine if logging is skipped, defaults to false.
+    requestFilter: function (req, propName) { return req[propName]; } // A function to filter/return request values, defaults to returning all values allowed by whitelist. If the function returns undefined, the key/value will not be included in the meta.
+    responseFilter: function (res, propName) { return res[propName]; } // A function to filter/return response values, defaults to returning all values allowed by whitelist. If the function returns undefined, the key/value will not be included in the meta.
+    requestWhitelist: [String] // Array of request properties to log. Overrides global requestWhitelist for this instance
+    responseWhitelist: [String] // Array of response properties to log. Overrides global responseWhitelist for this instance
+    bodyWhitelist: [String] // Array of body properties to log. Overrides global bodyWhitelist for this instance
+    bodyBlacklist: [String] // Array of body properties to omit from logs. Overrides global bodyBlacklist for this instance
+    ignoredRoutes: [String] // Array of paths to ignore/skip logging. Overrides global ignoredRoutes for this instance
 
-To use winston's existing transports, set `transports` to the values (as in key-value) of the `winston.default.transports` object. This may be done, for example, by using underscorejs: `transports: _.values(winston.default.transports)`.
-
-Alternatively, if you're using a winston logger instance elsewhere and have already set up levels and transports, pass the instance into expressWinston with the `winstonInstance` option. The `transports` option is then ignored.
+```
 
-### Request Logging
+### Error Logging
 
-Use `expressWinston.logger(options)` to create a middleware to log your HTTP requests.
+Use `expressWinston.errorLogger(options)` to create a middleware that log the errors of the pipeline.
 
 ``` js
     var router = require('./my-express-router');
 
-    app.use(expressWinston.logger({
+    app.use(router); // notice how the router goes first.
+    app.use(expressWinston.errorLogger({
       transports: [
         new winston.transports.Console({
           json: true,
           colorize: true
         })
-      ],
-      meta: true, // optional: control whether you want to log the meta data about the request (default to true)
-      msg: "HTTP {{req.method}} {{req.url}}", // optional: customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}"
-      expressFormat: true, // Use the default Express/morgan request formatting, with the same colors. Enabling this will override any msg and colorStatus if true. Will only output colors on transports with colorize set to true
-      colorStatus: true, // Color the status code, using the Express/morgan color palette (default green, 3XX cyan, 4XX yellow, 5XX red). Will not be recognized if expressFormat is true
-      ignoreRoute: function (req, res) { return false; } // optional: allows to skip some log messages based on request and/or response
+      ]
     }));
+```
 
-    app.use(router); // notice how the router goes after the logger.
+The logger needs to be added AFTER the express router(`app.router)`) and BEFORE any of your custom error handlers(`express.handler`). Since winston-middleware will just log the errors and not __handle__ them, you can still use your custom error handler like `express.handler`, just be sure to put the logger before any of your handlers.
+
+#### Options
+
+``` js
+    transports: [<WinstonTransport>], // list of all winston transports instances to use.
+    winstonInstance: <WinstonLogger>, // a winston logger instance. If this is provided the transports option is ignored
+    msg: String // customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}", "HTTP {{req.method}} {{req.url}}".
+    baseMeta: Object, // default meta data to be added to log, this will be merged with the error data.
+    metaField: String, // if defined, the meta data will be added in this field instead of the meta root object.
+    requestFilter: function (req, propName) { return req[propName]; } // A function to filter/return request values, defaults to returning all values allowed by whitelist. If the function returns undefined, the key/value will not be included in the meta.
+    requestWhitelist: [String] // Array of request properties to log. Overrides global requestWhitelist for this instance
 ```
 
+To use winston's existing transports, set `transports` to the values (as in key-value) of the `winston.default.transports` object. This may be done, for example, by using underscorejs: `transports: _.values(winston.default.transports)`.
+
+Alternatively, if you're using a winston logger instance elsewhere and have already set up levels and transports, pass the instance into expressWinston with the `winstonInstance` option. The `transports` option is then ignored.
+
 ## Examples
 
 ``` js
@@ -346,6 +373,17 @@ If both `req._bodyWhitelist.body` and `req._bodyBlacklist.body` are set the resu
 excluding any black listed ones. In the above example, only 'email' and 'age' would be included.
 
 
+## Custom Status Levels
+
+If you set statusLevels to true winston-middleware will log sub 400 responses at info level, sub 500 responses as warnings and 500+ responses as errors. To change these levels specify an object as follows
+```json
+  "statusLevels": {
+    "success": "debug",
+    "warn": "debug",
+    "error": "info"
+  }
+```
+
 ## Tests
 
 Run the basic Mocha tests:
@@ -354,11 +392,11 @@ Run the basic Mocha tests:
 
 Run the Travis-CI tests (which will fail with < 100% coverage):
 
-    npm test-travis
+    npm run test-travis
 
 Generate the `coverage.html` coverage report:
 
-    npm test-coverage
+    npm run test-coverage
 
 ## Issues and Collaboration
 
@@ -369,6 +407,7 @@ If you ran into any problems, please use the project [Issues section](https://gi
 * [Johan Hernandez](https://github.com/bithavoc) (https://github.com/bithavoc)
 * [Lars Jacob](https://github.com/jaclar) (https://github.com/jaclar)
 * [Jonathan Lomas](https://github.com/floatingLomas) (https://github.com/floatingLomas)
+* [Ross Brandes](https://github.com/rosston) (https://github.com/rosston)
 
 Also see AUTHORS file, add yourself if you are missing.
 

package/index.js

@@ -34,34 +34,34 @@ delete require.cache[require.resolve('underscore')];
  * TODO: Include 'body' and get the defaultRequestFilter to filter the inner properties like 'password' or 'password_confirmation', etc. Pull requests anyone?
  * @type {Array}
  */
-var requestWhitelist = ['url', 'headers', 'method', 'httpVersion', 'originalUrl', 'query'];
+exports.requestWhitelist = ['url', 'headers', 'method', 'httpVersion', 'originalUrl', 'query'];
 
 /**
  * A default list of properties in the request body that are allowed to be logged.
  * This will normally be empty here, since it should be done at the route level.
  * @type {Array}
  */
-var bodyWhitelist = [];
+exports.bodyWhitelist = [];
 
 /**
  * A default list of properties in the request body that are not allowed to be logged.
  * @type {Array}
  */
-var bodyBlacklist = [];
+exports.bodyBlacklist = [];
 
 /**
  * A default list of properties in the response object that are allowed to be logged.
  * These properties will be safely included in the meta of the log.
  * @type {Array}
  */
-var responseWhitelist = ['statusCode'];
+exports.responseWhitelist = ['statusCode'];
 
 /**
  * A list of request routes that will be skipped instead of being logged. This would be useful if routes for health checks or pings would otherwise pollute
  * your log files.
  * @type {Array}
  */
-var ignoredRoutes = [];
+exports.ignoredRoutes = [];
 
 /**
  * A default function to filter the properties of the req object.
@@ -69,7 +69,7 @@ var ignoredRoutes = [];
  * @param propName
  * @return {*}
  */
-var defaultRequestFilter = function (req, propName) {
+exports.defaultRequestFilter = function (req, propName) {
     return req[propName];
 };
 
@@ -79,7 +79,7 @@ var defaultRequestFilter = function (req, propName) {
  * @param propName
  * @return {*}
  */
-var defaultResponseFilter = function (res, propName) {
+exports.defaultResponseFilter = function (res, propName) {
     return res[propName];
 };
 
@@ -87,7 +87,7 @@ var defaultResponseFilter = function (res, propName) {
  * A default function to decide whether skip logging of particular request. Doesn't skip anything (i.e. log all requests).
  * @return always false
  */
-var defaultSkip = function() {
+exports.defaultSkip = function() {
   return false;
 };
 
@@ -114,13 +114,16 @@ function filterObject(originalObj, whiteList, initialFilter) {
 //
 
 
-function errorLogger(options) {
+exports.errorLogger = function errorLogger(options) {
 
     ensureValidOptions(options);
 
-    options.requestFilter = options.requestFilter || defaultRequestFilter;
+    options.requestWhitelist = options.requestWhitelist || exports.requestWhitelist;
+    options.requestFilter = options.requestFilter || exports.defaultRequestFilter;
     options.winstonInstance = options.winstonInstance || (new winston.Logger ({ transports: options.transports }));
     options.msg = options.msg || 'middlewareError';
+    options.baseMeta = options.baseMeta || {};
+    options.metaField = options.metaField || null;
 
     // Using mustache style templating
     var template = _.template(options.msg, null, {
@@ -131,14 +134,22 @@ function errorLogger(options) {
 
         // Let winston gather all the error data.
         var exceptionMeta = winston.exception.getAllInfo(err);
-        exceptionMeta.req = filterObject(req, requestWhitelist, options.requestFilter);
+        exceptionMeta.req = filterObject(req, options.requestWhitelist, options.requestFilter);
+
+        if (options.metaField) {
+            var newMeta = {};
+            newMeta[options.metaField] = exceptionMeta;
+            exceptionMeta = newMeta;
+        }
+
+        exceptionMeta = _.extend(exceptionMeta, options.baseMeta);
 
         // This is fire and forget, we don't want logging to hold up the request so don't wait for the callback
         options.winstonInstance.log('error', template({err: err, req: req, res: res}), exceptionMeta);
 
         next(err);
     };
-}
+};
 
 //
 // ### function logger(options)
@@ -146,21 +157,28 @@ function errorLogger(options) {
 //
 
 
-function logger(options) {
+exports.logger = function logger(options) {
 
     ensureValidOptions(options);
     ensureValidLoggerOptions(options);
 
-    options.requestFilter = options.requestFilter || defaultRequestFilter;
-    options.responseFilter = options.responseFilter || defaultResponseFilter;
+    options.requestWhitelist = options.requestWhitelist || exports.requestWhitelist;
+    options.bodyWhitelist = options.bodyWhitelist || exports.bodyWhitelist;
+    options.bodyBlacklist = options.bodyBlacklist || exports.bodyBlacklist;
+    options.responseWhitelist = options.responseWhitelist || exports.responseWhitelist;
+    options.requestFilter = options.requestFilter || exports.defaultRequestFilter;
+    options.responseFilter = options.responseFilter || exports.defaultResponseFilter;
+    options.ignoredRoutes = options.ignoredRoutes || exports.ignoredRoutes;
     options.winstonInstance = options.winstonInstance || (new winston.Logger ({ transports: options.transports }));
     options.level = options.level || "info";
     options.statusLevels = options.statusLevels || false;
     options.msg = options.msg || "HTTP {{req.method}} {{req.url}}";
+    options.baseMeta = options.baseMeta || {};
+    options.metaField = options.metaField || null;
     options.colorStatus = options.colorStatus || false;
     options.expressFormat = options.expressFormat || false;
     options.ignoreRoute = options.ignoreRoute || function () { return false; };
-    options.skip = options.skip || defaultSkip;
+    options.skip = options.skip || exports.defaultSkip;
 
     // Using mustache style templating
     var template = _.template(options.msg, null, {
@@ -169,7 +187,7 @@ function logger(options) {
 
     return function (req, res, next) {
         var currentUrl = req.originalUrl || req.url;
-        if (currentUrl && _.contains(ignoredRoutes, currentUrl)) return next();
+        if (currentUrl && _.contains(options.ignoredRoutes, currentUrl)) return next();
         if (options.ignoreRoute(req, res)) return next();
 
         req._startTime = (new Date);
@@ -195,9 +213,9 @@ function logger(options) {
             req.url = req.originalUrl || req.url;
 
             if (options.statusLevels) {
-              if (res.statusCode >= 100) { options.level = "info"; }
-              if (res.statusCode >= 400) { options.level = "warn"; }
-              if (res.statusCode >= 500) { options.level = "error"; }
+              if (res.statusCode >= 100) { options.level = options.statusLevels.success || "info"; }
+              if (res.statusCode >= 400) { options.level = options.statusLevels.warn || "warn"; }
+              if (res.statusCode >= 500) { options.level = options.statusLevels.error || "error"; }
             };
 
             if (options.colorStatus || options.expressFormat) {
@@ -212,27 +230,27 @@ function logger(options) {
             var meta = {};
 
             if(options.meta !== false) {
-              var bodyWhitelist, blacklist;
+              var logData = {};
 
-              requestWhitelist = requestWhitelist.concat(req._routeWhitelists.req || []);
-              responseWhitelist = responseWhitelist.concat(req._routeWhitelists.res || []);
+              var requestWhitelist = options.requestWhitelist.concat(req._routeWhitelists.req || []);
+              var responseWhitelist = options.responseWhitelist.concat(req._routeWhitelists.res || []);
 
-              meta.res = res;
+              logData.res = res;
 
               if (_.contains(responseWhitelist, 'body')) {
                 if (chunk) {
                   var isJson = (res._headers && res._headers['content-type']
                     && res._headers['content-type'].indexOf('json') >= 0);
 
-                  meta.res.body =  isJson ? JSON.parse(chunk) : chunk.toString();
+                  logData.res.body =  isJson ? JSON.parse(chunk) : chunk.toString();
                 }
               }
 
-              meta.req = filterObject(req, requestWhitelist, options.requestFilter);
-              meta.res = filterObject(res, responseWhitelist, options.responseFilter);
+              logData.req = filterObject(req, requestWhitelist, options.requestFilter);
+              logData.res = filterObject(res, responseWhitelist, options.responseFilter);
 
-              bodyWhitelist = req._routeWhitelists.body || [];
-              blacklist = _.union(bodyBlacklist, (req._routeBlacklists.body || []));
+              var bodyWhitelist = _.union(options.bodyWhitelist, (req._routeWhitelists.body || []));
+              var blacklist = _.union(options.bodyBlacklist, (req._routeBlacklists.body || []));
 
               var filteredBody = null;
 
@@ -244,12 +262,21 @@ function logger(options) {
                     filteredBody = filterObject(req.body, bodyWhitelist, options.requestFilter);
                   }
               }
-              
-              if (filteredBody) meta.req.body = filteredBody;
 
-              meta.responseTime = res.responseTime;
+              if (filteredBody) logData.req.body = filteredBody;
+
+              logData.responseTime = res.responseTime;
+
+              if (options.metaField) {
+                  var newMeta = {}
+                  newMeta[options.metaField] = logData;
+                  logData = newMeta;
+              }
+              meta = _.extend(meta, logData);
             }
 
+            meta = _.extend(meta, options.baseMeta);
+
             if(options.expressFormat) {
               var msg = chalk.grey(req.method + " " + req.url || req.url)
                 + " " + chalk[statusColor](res.statusCode)
@@ -265,7 +292,7 @@ function logger(options) {
 
         next();
     };
-}
+};
 
 function ensureValidOptions(options) {
     if(!options) throw new Error("options are required by winston-middleware middleware");
@@ -278,14 +305,3 @@ function ensureValidLoggerOptions(options) {
         throw new Error("`ignoreRoute` winston-middleware option should be a function");
     }
 }
-
-module.exports.errorLogger = errorLogger;
-module.exports.logger = logger;
-module.exports.requestWhitelist = requestWhitelist;
-module.exports.bodyWhitelist = bodyWhitelist;
-module.exports.bodyBlacklist = bodyBlacklist;
-module.exports.responseWhitelist = responseWhitelist;
-module.exports.defaultRequestFilter = defaultRequestFilter;
-module.exports.defaultResponseFilter = defaultResponseFilter;
-module.exports.defaultSkip = defaultSkip;
-module.exports.ignoredRoutes = ignoredRoutes;

package/package.json

@@ -17,7 +17,7 @@
     "middleware",
     "colors"
   ],
-  "version": "1.1.0",
+  "version": "1.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/bithavoc/winston-middleware.git"
@@ -30,7 +30,7 @@
   "scripts": {
     "test": "node_modules/.bin/mocha --reporter spec",
     "test-travis": "node_modules/.bin/mocha --require blanket --reporter travis-cov",
-    "test-coverage": "node_modules/.bin/mocha --require blanket --reporter html-cov >| coverage.html || true"
+    "test-coverage": "node_modules/.bin/mocha --require blanket --reporter html-cov > coverage.html || true"
   },
   "config": {
     "travis-cov": {
@@ -52,14 +52,15 @@
     "winston": "~1.0.0"
   },
   "devDependencies": {
-    "blanket": "~1.1.6",
-    "mocha": "~2.1.0",
-    "node-mocks-http": "~1.2.3",
-    "should": "~4.6.0",
-    "travis-cov": "~0.2.5"
+    "blanket": "^1.2.2",
+    "mocha": "^2.4.5",
+    "node-mocks-http": "^1.5.1",
+    "promise": "^7.1.1",
+    "should": "^8.2.2",
+    "travis-cov": "^0.2.5"
   },
   "engines": {
-    "node": ">=0.6.0"
+    "node": ">=0.10.0"
   },
   "license": "MIT",
   "contributors": [