winston-middleware 0.2.0 → 0.2.2

package/.travis.yml

@@ -1,5 +1,5 @@
 language: node_js
 node_js:
-  - 0.6
-  - 0.8
+  - "0.6"
+  - "0.8"
 script: "npm test"

package/AUTHORS

@@ -0,0 +1,4 @@
+Heapsource <npm@heapsource.com> (http://www.heapsource.com)
+Lars Jacob (http://jaclar.net)
+Jonathan Lomas (http://feedbackular.com)
+Xavier Damman (http://xdamman.com)

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Firebase.co - http://www.firebase.co
+Copyright (c) 2012-2013 Heapsource.com - http://www.heapsource.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/Readme.md

@@ -11,6 +11,28 @@
 
 winston-middleware provides middlewares for request and error logging of your express.js application.  It uses 'whitelists' to select properties from the request and (new in 0.2.x) response objects.
 
+To make use of winston-middleware, you need to add the following to your application:
+
+In `package.json`:
+
+```
+{
+  "dependencies": {
+    "...": "...",
+    "winston": "0.6.x",
+    "winston-middleware": "0.2.x",
+    "...": "..."
+  }
+}
+```
+
+In `server.js` (or wherever you need it):
+
+```
+var winston = require('winston'),
+    expressWinston = require('winston-middleware');
+```
+
 ### Error Logging
 
 Use `expressWinston.errorLogger(options)` to create a middleware that log the errors of the pipeline.
@@ -48,7 +70,9 @@ Use `expressWinston.logger(options)` to create a middleware to log your HTTP req
           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}}"
     }));
     app.use(app.router); // notice how the router goes after the logger.
 ```
@@ -59,7 +83,7 @@ Use `expressWinston.logger(options)` to create a middleware to log your HTTP req
     var express = require('express');
     var expressWinston = require('winston-middleware');
     var winston = require('winston'); // for transports.Console
-    var app = module.exports = express.createServer();
+    var app = module.exports = express();
 
     app.use(express.bodyParser());
     app.use(express.methodOverride());
@@ -271,9 +295,11 @@ If you ran into any problems, please use the project [Issues section](https://gi
 * [Lars Jacob](https://github.com/jaclar) (https://github.com/jaclar)
 * [Jonathan Lomas](https://github.com/floatingLomas) (https://github.com/floatingLomas)
 
+Also see AUTHORS file, add yourself if you are missing.
+
 ## MIT License
 
-Copyright (c) 2012 Firebase.co and Contributors - http://www.firebase.co
+Copyright (c) 2012-2014 Heapsource.com and Contributors - http://www.heapsource.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2012 Firebase.co and Contributors - http://www.firebase.co
+// Copyright (c) 2012-2014 Heapsource.com and Contributors - http://www.heapsource.com
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -20,6 +20,7 @@
 //
 var winston = require('winston');
 var util = require('util');
+var _ = require('underscore');
 
 /**
  * A default list of properties in the request object that are allowed to be logged.
@@ -122,6 +123,7 @@ function logger(options) {
     options.requestFilter = options.requestFilter || defaultRequestFilter;
     options.responseFilter = options.responseFilter || defaultResponseFilter;
     options.level = options.level || "info";
+    options.msg = options.msg || "HTTP {{req.method}} {{req.url}}";
 
     return function (req, res, next) {
 
@@ -136,30 +138,37 @@ function logger(options) {
         // Manage to get information from the response too, just like Connect.logger does:
         var end = res.end;
         res.end = function(chunk, encoding) {
-            var responseTime = (new Date) - req._startTime;
+            res.responseTime = (new Date) - req._startTime;
 
             res.end = end;
             res.end(chunk, encoding);
 
-            var meta = {};
+            if(options.meta !== false) {
+              var meta = {};
 
-            var bodyWhitelist;
+              var bodyWhitelist;
 
-            requestWhitelist = requestWhitelist.concat(req._routeWhitelists.req || []);
-            responseWhitelist = responseWhitelist.concat(req._routeWhitelists.res || []);
+              requestWhitelist = requestWhitelist.concat(req._routeWhitelists.req || []);
+              responseWhitelist = responseWhitelist.concat(req._routeWhitelists.res || []);
 
-            meta.req = filterObject(req, requestWhitelist, options.requestFilter);
-            meta.res = filterObject(res, responseWhitelist, options.responseFilter);
+              meta.req = filterObject(req, requestWhitelist, options.requestFilter);
+              meta.res = filterObject(res, responseWhitelist, options.responseFilter);
 
-            bodyWhitelist = req._routeWhitelists.body || [];
+              bodyWhitelist = req._routeWhitelists.body || [];
 
-            if (bodyWhitelist) {
-                meta.req.body = filterObject(req.body, bodyWhitelist, options.requestFilter);
-            };
+              if (bodyWhitelist) {
+                  meta.req.body = filterObject(req.body, bodyWhitelist, options.requestFilter);
+              };
 
-            meta.responseTime = responseTime;
+              meta.responseTime = res.responseTime;
+            }
 
-            var msg = util.format("HTTP %s %s", req.method, req.url);
+            // Using mustache style templating
+            _.templateSettings = {
+              interpolate: /\{\{(.+?)\}\}/g
+            };
+            var template = _.template(options.msg);
+            var msg = template({req: req, res: res});
 
             // This is fire and forget, we don't want logging to hold up the request so don't wait for the callback
             for(var i = 0; i < options.transports.length; i++) {

package/package.json

@@ -1,29 +1,34 @@
 {
-  "author": "Firebase.co <npm@firebase.co> (http://www.firebase.co/)",
+  "author": "Heapsource.com <npm@heapsource.com> (http://www.heapsource.com)",
   "name": "winston-middleware",
   "description": "express.js middleware for flatiron/winston",
-  "keywords": ["winston", "flatiron", "logging", "express", "log", "error", "handler", "middleware"],
-  "version": "0.2.0",
+  "keywords": [
+    "winston",
+    "flatiron",
+    "logging",
+    "express",
+    "log",
+    "error",
+    "handler",
+    "middleware"
+  ],
+  "version": "0.2.2",
   "repository": {
-    "url": "https://github.com/firebaseco/winston-middleware.git"
+    "url": "https://github.com/heapsource/winston-middleware.git"
   },
   "main": "index.js",
   "scripts": {
-    "test": "node test/test.js"
+    "test": "vows --spec"
   },
   "dependencies": {
-    "winston": "0.6.x"
+    "winston": "0.6.x",
+    "underscore": "~1.5.2"
   },
   "devDependencies": {
-    "vows": "0.6.x"
+    "vows": "0.7.x"
   },
   "engines": {
     "node": "*"
   },
-	"licenses" : [
-		{
-			"type" : "MIT",
-			"url" : "https://github.com/firebaseco/winston-middleware/blob/master/LICENSE"
-		}
-	]
+  "license": "MIT"
 }