Merge pull request #5 from gitterHQ/feature/fluent-logging

In-app fluent logging

lib/error-reporter.js

 /*jshint globalstrict:true, trailing:false, unused:true, node:true */
 "use strict";
+var processName = require('./process-name')
+
 exports.create = function(options) {
   var raven = require('raven');
   var path = require('path');
@@ -20,9 +22,9 @@ exports.create = function(options) {
         release: release
       }, supplied);
-      var upstartJob = process.env.UPSTART_JOB || process.env.JOB;
-      if (upstartJob) {
-        tags.job = upstartJob.replace(/\-\d*$/,''); // gitter-webapp-1 becomes gitter-webapp
+      var appName = processName.getShortProcessName();
+      if (appName) {
+        tags.job = appName;
       }
       return tags;
     } catch(e) {

lib/install-diagnostics.js

@@ -3,16 +3,7 @@
 var util = require('util');
 var os   = require('os');
 var path = require('path');
-
-function getProcessIdentifier() {
-  var upstartJob = process.env.UPSTART_JOB || process.env.JOB;
-  if (upstartJob) return upstartJob;
-
-  var main = require.main;
-  if (!main || !main.filename) return 'unknown';
-
-  return path.basename(main.filename, '.js');
-}
+var processName = require('./process-name')
 function getDateIdentifier() {
   function pad(d) {
@@ -46,11 +37,11 @@ exports.install = function(options) {
   var logger = options.logger;
   process.on('SIGUSR2', function() {
-    var identifier = getProcessIdentifier();
+    var appName = processName.getFullProcessName();
     var filename = util.format('heap.%s.%s.%s.%s.heapsnapshot',
       os.hostname(),
-      identifier,
+      appName,
       process.pid,
       getDateIdentifier());

lib/logger.js

 /*jshint globalstrict:true, trailing:false, unused:true, node:true */
 "use strict";
+var processName = require('./process-name')
+
 exports.create = function(options) {
   var winston = require("winston");
   var fs = require('fs');
@@ -108,7 +110,31 @@ exports.create = function(options) {
       defaultLogger.remove({ name: name });
     }
-    if(nconf.get('logging:logToFile') && nconf.get('LOG_FILE')) {
+    if(nconf.get("logging:logToUDP")) {
+      var appName = processName.getGenericProcessName();
+      if (appName) {
+        require('winston-udp')
+        var os = require('os')
+        defaultLogger.add(winston.transports.UDP, {
+          host: nconf.get('logging:udpHost') || '127.0.0.1',
+          port: nconf.get('logging:udpPort') || 24224,
+          timestamp: function() {
+            return Date.now();
+          },
+          formatter: function(options) {
+            return JSON.stringify({
+              "app": appName,
+              "env": process.env.NODE_ENV,
+              "level": options.level,
+              "message": options.message,
+              "host": os.hostname(),
+              "meta": options.meta
+            });
+          }
+        });
+      }
+    }
+    if (nconf.get('logging:logToFile') && nconf.get('LOG_FILE')) {
       defaultLogger.add(winston.transports.File, {
         filename: nconf.get('LOG_FILE'),
         level: nconf.get("logging:level"),

lib/process-name.js

+'use strict';
+
+var path = require('path');
+
+/**
+ * These functions are used to determine the current app name.
+ * Before each function there is an example of the returned
+ * value when the input is "gitter-webapp-1".
+ *
+ * Returns "gitter-webapp-1"
+ */
+function getFullProcessName() {
+  var upstartJob = process.env.UPSTART_JOB || process.env.JOB;
+  if (upstartJob) return upstartJob;
+
+  var main = require.main;
+  if (!main || !main.filename) return 'unknown';
+
+  return path.basename(main.filename, '.js');
+}
+
+/* Returns "gitter-webapp" */
+function getGenericProcessName(){
+  return getFullProcessName().replace(/\-\d*$/,'');
+}
+
+/* Returns "webapp" */
+function getShortProcessName(){
+  return getGenericProcessName().replace(/^gitter-/, '');
+}
+
+
+module.exports = {
+  getFullProcessName: getFullProcessName,
+  getGenericProcessName: getGenericProcessName,
+  getShortProcessName: getShortProcessName
+};

lib/stats-client.js

 /*jshint globalstrict:true, trailing:false, unused:true, node:true */
 "use strict";
+var processName = require('./process-name')
 function emergencyLog() {
   console.error.apply(console, arguments);
@@ -39,10 +40,9 @@ exports.create = function(options) {
       globalTags = globalTags.concat(statsdNodeJsVersionTags());
     }
-    var upstartJob = process.env.UPSTART_JOB || process.env.JOB;
-    if (upstartJob) {
-      upstartJob = upstartJob.replace(/\-\d*$/,''); // gitter-webapp-1 becomes gitter-webapp
-      globalTags.push('job:' + upstartJob);
+    var appName = processName.getShortProcessName();
+    if (appName) {
+      globalTags.push('job:' + appName);
     }
     // Add the main entry point into the app as a tag

package.json

@@ -44,7 +44,8 @@
     "response-time": "^2.3.1",
     "shutdown": "^0.2.3",
     "universal-analytics": "^0.3.4",
-    "winston": "^0.7.3"
+    "winston": "^2.2.0",
+    "winston-udp": "^0.0.6"
   },
   "devDependencies": {
     "mocha": "^1.18.2",

tests/stats-client-test.js

@@ -20,7 +20,6 @@ describe('gitter-stats-client', function() {
     });
     var client = statsClient.create({ config: config, tags: ['test:1'] });
-    console.log(client);
     assert(client);
     assert(client.global_tags.indexOf('test:1') >= 0);
   });