some minor improvements

Author: escott-

Readme.md

@@ -1,21 +1,21 @@
 # micrologger
 
-Meaningful application and request logs to be used with koa microservices
+Simple but meaningful application and request logs to be used with koa microservices
 
 Support for rotating files and/or sending to a logging collector fluentd (more to come)
 
-Add to the top of your koa application and pass in koa app:
+Add to the top of your koa application and pass in koa app to get started:
 
 ```js
 const app = require('koa')();
 const logger = require('micrologger');
-logger(app);
+app.use(logger());
 ```
 This will give you all application and request logs:
 
 Make sure to pass NODE_ENV=development for local development
 
-Rotating log files will be saved to 'logs/out.log' in the root of your app.  Rotating files can be turned off by passing in logToFile:false
+Rotating log files will be saved to 'logs/out.log' in the root of your app.  Pass logToFile:true in the options and pass in NODE_ENV=developemnt to use rotating files
 
 That is all you need for micrologger to start collecting and sending logs.
 
@@ -109,12 +109,12 @@ You can add fluentd as a collector
 add the fluent block below and all the logs will be sent to fluentd
 
 ```js
-logger(app, {
+app.use(logger({
   fluent: {
     host: '127.0.0.1',
     port: '24224'
   }
-});
+}))
 ```
 
 ```sh
@@ -136,7 +136,7 @@ Example of application error in /logs/out.log
 ## Log info/error
 ```js
 logger.info('Info Message');
-logger.info('Some error message');
+logger.error('Some error message');
 ```
 The info and error message will be logged with the following structure:
 
@@ -165,18 +165,17 @@ The info and error message will be logged with the following structure:
 ## All options
 
 ```js
-logger(app, {
+app.use(logger({
   logsToFile: false,
-  requestLogs: false,
-  appLogs: false,
+  appLogs: true,
   backgroundColor: 'dark',
   fluent: {
     host: '127.0.0.1',
     port: '24224'
   }
-})
+}))
 ```
-* logToFile: (default is true)
-* requestLogs: (default is true)
-* appLogs: (default is true)
-* backgroundColor: this is the background color of your terminal.  options are dark/light (default is dark)
+* logToFile: (optional, default is false)
+* appLogs: (optional, default is true) if set to false application errors will not be logged.  This does not include request errors
+* backgroundColor: (optional) this is the background color of your terminal.  options are dark/light (default is dark)
+* fluent with host, port

index.js

@@ -6,23 +6,33 @@ const os = require('os')
   , sock = zeromq.socket('pub')
   , chalk = require('chalk')
   , humanize = require('humanize-number')
+  , stripAnsi = require('strip-ansi')
   , uuid = require('uuid')
   , stream = require('stream')
   , logrotate = require('logrotate-stream')
   , reqPath = require('app-root-path').require
   , name = reqPath('/package.json').name
 
 let collector;
-let logToFile = true;
+let logToFile = false;
 let color = chalk.bold.white;
-function app(app, opts) {
+let req;
+let error = false;
+function log(opts) {
   if(opts && opts.backgroundColor) {
     if(opts.backgroundColor === 'white'){
       color = chalk.bold.black;
     } else {
       color = chalk.bold.white;
     }
   }
+  if(opts && opts.zmq) {
+    sock.connect(`tcp://${opts.zmq.addr}`);
+    collector = 'zmq';
+  }
+  if(opts && opts.logToFile === true) {
+    logToFile = true
+  } 
   if(opts && opts.fluent) {
     fluentlogger.configure('tag_prefix', {
       host: opts.fluent.host,
@@ -32,100 +42,17 @@ function app(app, opts) {
     });
     collector = 'fluent';
   }
-  if(opts && opts.zmq) {
-    sock.connect(`tcp://${opts.zmq.addr}`);
-    collector = 'zmq';
-  }
-  if(opts && opts.logToFile === false) {
-    logToFile = false
-  } 
-  if(!opts || opts && opts.appLogs !== false) {
+  if(opts && opts.appLogs !== false) {
     logUncaughtError();
   } 
-  if(!opts || opts && opts.requestLogs !== false) {
-    app.use(request());
-  } 
-}
-
-function logUncaughtError (err) {
-  process.on('uncaughtException', function(err) {
-    err = err.stack.replace(/(?:\r\n|\r|\n)\s\s+/g, ' ');
-    let log = {
-      class: 'application',
-      ident: name,
-      host: os.hostname(),
-      pid: process.pid,
-      severity: 'INFO',
-      message: err
-    }
-    if(logToFile) {
-      pipeLogsToFile(log);
-    }
-    if(process.env.NODE_ENV === 'development') {
-      console.log(chalk.red.bold(err));
-    } else {
-      collectLogs('application', log);
-    }
-    setTimeout(process.exit.bind(process, 1), 1000);
-  });
-}
-
-function logInfo (data) {
-  let log = {
-    class: 'application',
-    ident: name,
-    host: os.hostname(),
-    pid: process.pid,
-    severity: 'INFO',
-    message: data
-  }
-  if(logToFile) {
-    pipeLogsToFile(log);
-  }
-  if(process.env.NODE_ENV === 'development') {
-    console.log(color(data));
-  } else {
-    collectLogs('application', log);
-  }
-}
-
-function logError (err) {
-  let log = {
-    class: 'application',
-    ident: name,
-    host: os.hostname(),
-    pid: process.pid,
-    severity: 'ERROR',
-    message: err
-  }
-  if(logToFile) {
-    pipeLogsToFile(log);
-  }
-  if(process.env.NODE_ENV === 'development') {
-    console.log(chalk.red.bold(err));
-  } else {
-    collectLogs('application', log);
-  }
-}
-
-function pipeLogsToFile (data) {
-  let bufferStream = new stream.PassThrough();
-  bufferStream.end(new Buffer(JSON.stringify(data) + '\n'));
-  if (!fs.existsSync('./logs')){		
-    fs.mkdirSync('./logs');		
-  }
-  let toLogFile = logrotate({ file: './logs/out.log', size: '500k', keep: 7 });
-  bufferStream.pipe(toLogFile);
-}
-
-function request() {
   return function *(next) {
     let ctx = this;
     let res = ctx.res;
     let reqTime = new Date;
     let classname = (ctx.request.headers['x-correlation-id']) ? 'service_request' : 'client_request';
     let correlationId = ctx.request.headers['x-correlation-id'] || uuid.v4();
     ctx.request.headers['x-correlation-id'] = correlationId;
+    req = true;
     try {
       yield next;
     } catch (err) {
@@ -145,7 +72,7 @@ function request() {
         request_id: requestId,
         ident: name,
         class: classname,
-        message: `${ctx.request.method} ${ctx.request.url}`,
+        message: `<-- ${ctx.request.method} ${ctx.request.url}`,
         host: os.hostname(),
         client: ctx.request.ip || ctx.request.headers['x-forwarded-for'],
         path: ctx.request.url,
@@ -159,7 +86,7 @@ function request() {
         request_id: requestId,
         ident: name,
         class: classname,
-        message: `${ctx.response.status} ${ctx.response.message} ${ctx.request.url}`,
+        message: `--> ${ctx.response.status} ${ctx.response.message} ${ctx.request.url}`,
         host: os.hostname(),
         client: ctx.request.ip || ctx.request.headers['x-forwarded-for'],
         path: ctx.request.url,
@@ -171,25 +98,91 @@ function request() {
         severity: ctx.response.status >= 400 ? 'ERROR' : 'INFO',
         metadata: {}
       }
-      if(logToFile){
-        pipeLogsToFile(request);
-        pipeLogsToFile(response);
+      logInfo(request.message);
+      if(response.severity === 'ERROR') {
+        logError(response.message);
+      } else {
+        logInfo(response.message);
       }
       if(process.env.NODE_ENV === 'development') {
-        console.log(chalk.cyan.underline.bold(request.message));
-        if(response.severity === 'ERROR') {
-          console.log(chalk.red.bold(response.message));
-        } else {
-          console.log(chalk.green.bold(response.message));
+        if(logToFile){
+          pipeLogsToFile(request);
+          pipeLogsToFile(response); 
         }
-      } else {
+      } else if(collector) {
         collectLogs('request', request);
         collectLogs('response', response);
       }
     }
   }
 }
 
+function logUncaughtError () {
+  process.on('uncaughtException', function(err) {
+    err = stripAnsi(err.stack);
+    error = true;
+    logError(err)
+    setTimeout(process.exit.bind(process, 1), 1000);
+  });
+}
+
+function logInfo (data) {
+  data = stripAnsi(data);
+  let log = {
+    class: 'application',
+    ident: name,
+    host: os.hostname(),
+    pid: process.pid,
+    severity: 'INFO',
+    message: data
+  }
+  if(data.indexOf('<--') !== -1){
+    console.log(chalk.cyan.underline.bold(data));
+  } else if(data.indexOf('-->') !== -1) {
+    console.log(chalk.green.bold(data));
+  } else {
+    console.log(color(data));
+    if(process.env.NODE_ENV === 'development') {
+      if(logToFile){
+        pipeLogsToFile(log);
+      }
+    } else if(collector) {
+        collectLogs('application', log);
+    }
+  }
+}
+
+function logError (err) {
+  err = stripAnsi(err);
+  let log = {
+    class: 'application',
+    ident: name,
+    host: os.hostname(),
+    pid: process.pid,
+    severity: 'ERROR',
+    message: err
+  }
+  console.error(chalk.red.bold(err));
+  if(process.env.NODE_ENV === 'development') {
+    if(logToFile){
+      pipeLogsToFile(log);
+    }
+  } else if(collector && error) {
+    collectLogs('application', log);
+    error = false;
+  }
+}
+
+function pipeLogsToFile (data) {
+  let bufferStream = new stream.PassThrough();
+  bufferStream.end(new Buffer(JSON.stringify(data) + '\n'));
+  if (!fs.existsSync('./logs')){		
+    fs.mkdirSync('./logs');		
+  }
+  let toLogFile = logrotate({ file: './logs/out.log', size: '500k', keep: 7 });
+  bufferStream.pipe(toLogFile);
+}
+
 function collectLogs(type, data) {
   switch (collector) {
     case 'fluent':
@@ -211,6 +204,6 @@ function time(start) {
   return humanize(delta);
 }
 
-module.exports = app
+module.exports = log
 module.exports.info = logInfo
-module.exports.error = logError
+module.exports.error = logError

package.json

@@ -1,6 +1,6 @@
 {
   "name": "micrologger",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "koa microservice application and request logging",
   "main": "index.js",
   "scripts": {
@@ -21,11 +21,13 @@
   "author": "Erik Scott",
   "license": "MIT",
   "dependencies": {
+    "ain2": "^2.0.0",
     "app-root-path": "^2.0.1",
     "chalk": "^1.1.3",
     "fluent-logger": "^2.2.0",
     "humanize-number": "0.0.2",
     "logrotate-stream": "^0.2.5",
+    "strip-ansi": "^3.0.1",
     "uuid": "^3.0.1",
     "zmq": "^2.15.3"
   },