Add winston logging library. Log each API request and error.

Author: kunalkapadia

config/express.js

@@ -6,6 +6,8 @@ import compress from 'compression';
 import methodOverride from 'method-override';
 import cors from 'cors';
 import httpStatus from 'http-status';
+import expressWinston from 'express-winston';
+import winstonInstance from './winston';
 import routes from '../server/routes';
 import config from './env';
 import * as utilityService from '../server/services/utility';
@@ -25,6 +27,18 @@ app.use(methodOverride());
 // enable CORS - Cross Origin Resource Sharing
 app.use(cors());
 
+// enable detailed API logging in dev env
+if (config.NODE_ENV === 'development') {
+	expressWinston.requestWhitelist.push('body');
+	expressWinston.responseWhitelist.push('body');
+	app.use(expressWinston.logger({
+		winstonInstance,
+		meta: true, 	// optional: log meta data about request (defaults to true)
+		msg: 'HTTP {{req.method}} {{req.url}} {{res.statusCode}} {{res.responseTime}}ms',
+		colorStatus: true 	// Color the status code (default green, 3XX cyan, 4XX yellow, 5XX red).
+	}));
+}
+
 // mount all routes on /api path
 app.use('/api', routes);
 
@@ -40,11 +54,16 @@ app.use((req, res, next) => {
 	return next(err);
 });
 
+// log error in winston transports
+app.use(expressWinston.errorLogger({
+	winstonInstance
+}));
+
 // error handler, send stacktrace only during development
 app.use((err, req, res, next) =>		// eslint-disable-line no-unused-vars
 	res.status(err.status).json({
 		message: err.isPublic ? err.message : httpStatus[err.status],
-		error: config.NODE_ENV === 'development' ? err : {}
+		stack: config.NODE_ENV === 'development' ? err.stack : {}
 	})
 );
 

config/winston.js

@@ -0,0 +1,12 @@
+import winston from 'winston';
+
+const logger = new (winston.Logger)({
+	transports: [
+		new (winston.transports.Console)({
+			json: true,
+			colorize: true
+		})
+	]
+});
+
+export default logger;

package.json

@@ -25,9 +25,11 @@
     "debug": "^2.2.0",
     "dotenv": "^2.0.0",
     "express": "~4.13.1",
+    "express-winston": "^1.2.0",
     "http-status": "^0.2.0",
     "method-override": "^2.3.5",
-    "morgan": "~1.6.1"
+    "morgan": "~1.6.1",
+    "winston": "^2.1.1"
   },
   "devDependencies": {
     "babel": "^5.8.23",