Merge pull request #7 from alexk-blackops/master

eric-martin · eric-martin · commit 232a5a14b49a · 2015-03-16T13:11:57.000-05:00
Debugging mode + Env option minor fix
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ The following options could be passed. 'apiKey' is the only one that required:
 * __env:__ environment name
 * __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
 * __proxy:__ proxy server if you want to send requests via proxy.
+* __debug:__ boolean flag, turning on the debug mode. When set to true the log file (`stackify-debug.log`) is created in the working directory and all of the library actions is being written to it, defaults to false.
+
 
 *Notice:* stackify-logger sends synchronous requests if you call `process.exit()`. Sending via proxy wouldn't be possible in this case.
 
diff --git a/index.js b/index.js
@@ -1,4 +1,5 @@
 var api       = require('./lib/api'), // wrappers for API calls
+    debug     = require('./lib/debug'), // debug mode module
     exception = require('./lib/exception'),  // exception handler module
     logger    = require('./lib/logger'), // logging methods module
     CONFIG    = require('./config/config');
@@ -7,6 +8,7 @@ module.exports = {
     // start sending logs
     start: function (options) {
         CONFIG.SELECTED_LOGGER = CONFIG.LOGGER_VERSION;
+        debug.set(options.debug);
         api.methods.identifyApp(options);
         exception.catchException(options.exitOnError || false);
         exception.gracefulExitHandler();
@@ -18,13 +20,14 @@ module.exports = {
     info: logger.methods.info,
     warn: logger.methods.warn,
     error: logger.methods.error,
-    
+
     //common method for handling logged messages
     push: logger.methods.push,
     // setting logger name to Winston logger if it's used
     setLoggerName: function (name) {
         if (name === 'Winston') {
             CONFIG.SELECTED_LOGGER = CONFIG.WINSTON_LOGGER_VERSION;
+            debug.write('Winston Stackify Transport added');
         }
     },
 
diff --git a/lib/api.js b/lib/api.js
@@ -5,24 +5,24 @@ var os      = require('os'),
     CONFIG  = require('../config/config'),
     exc     = require('./exception'),
     helpers = require('./helpers'),
+    debug   = require('./debug'),
 
     lastApiError;
 
 module.exports.lastApiError = lastApiError;
 module.exports.methods = {
 
     identifyApp: function identifyApp(settings) {
-        var appname = helpers.getAppName(),
+        var options = {},
+            appname = helpers.getAppName(),
             body = {
                 DeviceName: os.hostname(),
                 AppName: appname,
                 ConfiguredAppName: appname,
-                AppLocaton: process.env.PWD,
-                ConfiguredEnvName: settings ? settings.env : (process.env.NODE_ENV || null)
+                AppLocaton: process.env.PWD
             },
-            opt = helpers.getOptions(CONFIG.IDENTIFY_PATH, body, settings ? settings.proxy : undefined),
             callback = function (data) {
-                console.log('successfully identified');
+                debug.write('Successfully identified');
 
                 CONFIG.APP_DETAILS = data;
 
@@ -34,24 +34,34 @@ module.exports.methods = {
 
             },
             fail = function () {
+                debug.write('Identification failed');
                 setTimeout(function () {
-                    sender.send(opt, callback, fail);
+                    sender.send(options, callback, fail);
                 }, CONFIG.IDENTIFY_DELAY);
             };
 
         // check that settings object is correct
 
         if (!settings) {
+            debug.write('Settings are not provided');
             throw new TypeError('Settings are not provided');
         }
 
         if (settings.apiKey && typeof (settings.apiKey) === 'string') {
             CONFIG.APIKEY = settings.apiKey;
-            opt.headers['X-Stackify-Key'] = settings.apiKey;
             CONFIG.APPNAME = appname;
-            CONFIG.ENV = settings.env || process.env.NODE_ENV || null;
-            sender.send(opt, callback, fail);
+
+            if (settings.env) {
+                body.ConfiguredEnvName = settings.env;
+            }
+
+            options = helpers.getOptions(CONFIG.IDENTIFY_PATH, body, settings ? settings.proxy : undefined);
+            options.headers['X-Stackify-Key'] = settings.apiKey;
+
+            debug.write('Identifying the app');
+            sender.send(options, callback, fail);
         } else {
+            debug.write('You have to pass API key to initialize Stackify Logger');
             throw new TypeError('You have to pass API key');
         }
 
@@ -65,12 +75,12 @@ module.exports.methods = {
     */
     postLogs: function postLogs(messages, cb, shutdown) {
         var delay = 0, // scheduled delay when postLogs call failed
-            opt = helpers.getOptions(CONFIG.LOG_SAVE_PATH, helpers.getPostBody(messages), CONFIG.PROXY),
+            options = helpers.getOptions(CONFIG.LOG_SAVE_PATH, helpers.getPostBody(messages), CONFIG.PROXY),
 
             //retry the request if it failed
             fail = function (code) {
                 var sinceFirstError;
-
+                debug.write('Sending logs failed');
                 if (code === 401) {
                     delay = CONFIG.DELAY.FIVE_MINUTES;
                     lastApiError = new Date().getTime();
@@ -81,11 +91,11 @@ module.exports.methods = {
                 }
 
                 setTimeout(function () {
-                    sender.send(opt, cb, fail);
+                    sender.send(options, cb, fail);
                 }, delay);
             };
-
-        sender.send(opt, cb, shutdown ? null : fail);
+        debug.write('Sending logs: batch size: ' + messages.length + ' messages');
+        sender.send(options, cb, shutdown ? null : fail);
     },
     /*
     *** posting logs synchronously in case if server is about to close ***
diff --git a/lib/debug.js b/lib/debug.js
@@ -0,0 +1,73 @@
+var fs        = require('fs'),
+    path      = require('path'),
+    util      = require('util'),
+    log_path  = path.join(process.cwd(), 'stackify-debug.log'),
+    debug     = false,
+    stream    = false,
+    makeMsg   = function (msg) {
+        return new Date().toString() + ' ' + msg + '\n';
+    },
+    // create writable stream if debug mode is turned on
+    init      = function () {
+        stream = fs.createWriteStream(log_path, {flags: 'a'});
+        stream.write(makeMsg('Debugging started'));
+        stream.on('error', function (err) {
+            console.error('Error occured during writing to the log file ', util.inspect(err));
+        });
+    };
+
+module.exports = {
+
+    set: function (option) {
+        debug = (option === true) ? true :  false;
+        if (debug) {
+            init();
+        }
+    },
+
+    write: function (msg) {
+        if (debug) {
+            stream.write(makeMsg(msg));
+        }
+    },
+
+    writeResponse: function (response, close) {
+        var body = (typeof response.body === 'object') ? JSON.stringify(response.body, null, 4) : response.body,
+            msg = 'url: ' + response.request.uri.href + ':' + response.request.uri.port + ', method: '
+                          + response.req.method + ', status: ' + response.statusCode + '\nresponse: ' + body;
+        if (close) {
+            this.close('Response received\n' + msg);
+        } else {
+            this.write('Response received\n' + msg);
+        }
+    },
+
+    writeRequest: function (request, close) {
+        if (request.body.Msgs) {
+            request.body.Msgs = request.body.Msgs.length + ' messages';
+        }
+        if (close) {
+            this.close('Request sent\n' + JSON.stringify(request, null, 4));
+        } else {
+            this.write('Request sent\n' + JSON.stringify(request, null, 4));
+        }
+    },
+
+    // special case - write synchronously to file if synchronous request before exit failed
+    writeSync: function (msg) {
+        try {
+            fs.appendFileSync(log_path, msg);
+        } catch (err) {
+            console.error('Error occured during writing to the log file ', util.inspect(err));
+        }
+    },
+
+    close: function (msg) {
+        var exit_msg = 'Exiting the app',
+            message  = msg || exit_msg;
+
+        if (stream) {
+            stream.end(makeMsg(message) + (msg ? makeMsg(exit_msg) : ''));
+        }
+    }
+};
diff --git a/lib/error.js b/lib/error.js
@@ -72,7 +72,7 @@ module.exports = {
                     AppName: CONFIG.APPNAME,
                     AppLocation: process.env.PWD,
                     ConfiguredAppName: CONFIG.APPNAME,
-                    ConfiguredEnvironmentName: CONFIG.ENV
+                    ConfiguredEnvironmentName: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.ENV : null
                 },
                 OccurredEpochMillis: Date.now(),
                 Error: {
diff --git a/lib/helpers.js b/lib/helpers.js
@@ -142,7 +142,7 @@ module.exports.getPostBody = function getPostBody(messages) {
         AppNameID: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.AppNameID : null,
         AppEnvID: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.AppEnvID : null,
         EnvID: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.EnvID : null,
-        Env: CONFIG.ENV,
+        Env: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.ENV : null,
         ServerName: os.hostname(),
         AppName: CONFIG.APPNAME,
         AppLoc: process.env.PWD,
diff --git a/lib/logger.js b/lib/logger.js
@@ -2,6 +2,7 @@ var api     = require('./api'),
     CONFIG  = require('../config/config'),
     helpers = require('./helpers'),
     error   = require('./error'),
+    debug   = require('./debug'),
 
     storage = [],
 
@@ -29,7 +30,7 @@ var api     = require('./api'),
                send another batch (if there are enough messages in the queue)
             */
             success = function (response) {
-                if (response.success) {
+                if (response && response.success) {
                     storage = storage.slice(chunk); // remove this chunk from the queue
                     length -= chunk;
                     api.lastApiError = 0; // reset the last HTTP error
@@ -50,6 +51,7 @@ var api     = require('./api'),
                     }
                 }
             };
+        debug.write('Checking the queue: ' + data.length + ' messages');
         // re-count the delay
         if (length >= CONFIG.MSG.MAX_BATCH_SIZE) {
             delay = Math.max(Math.round(delay / 2.0), CONFIG.DELAY.ONE_SECOND_DELAY);
@@ -138,6 +140,8 @@ module.exports.methods = {
             }
         };
 
+        debug.write('Exception caught');
+
         clearTimeout(timeout);
         this.push('error', err.message, [err], req, err);
         check();
@@ -146,6 +150,8 @@ module.exports.methods = {
     drain : function drain() {
         if (storage.length) {
             api.methods.postLogsSync(storage);
+        } else {
+            debug.close();
         }
     },
 
@@ -156,10 +162,12 @@ module.exports.methods = {
 
         // check the message level
         if (levels.indexOf(level.toLowerCase()) < 0) {
+            debug.write(level + ' level doesn\'t exist');
             throw new TypeError(level + ' level doesn\'t exist');
         }
         // check the message itself
         if (typeof msg !== 'string') {
+            debug.write('Message must be a string');
             throw new TypeError('Message must be a string');
         }
         this.push(level, msg, meta);
diff --git a/lib/sender.js b/lib/sender.js
@@ -5,16 +5,19 @@
 Low level function for sending http/https requests
 */
 var http         = require('http'),
+    util         = require('util'),
 
     request      = require('request'),
     requestSync  = require('sync-request'),
 
+    debug        = require('./debug'),
+    exc          = require('./exception'),
     logger       = require('./logger'),
     CONFIG       = require('../config/config.js');
 
 module.exports.send = function send(options, cb, fail) {
-
     var callback = function (error, response, body) {
+        debug.writeResponse(response, exc.excCaught);
         if (!error) {
             if (response.statusCode === 200) {
                 if (cb) {
@@ -26,23 +29,25 @@ module.exports.send = function send(options, cb, fail) {
                 }
             }
         } else {
-            console.error(error.stack);
+            debug.write('Request failed\n', util.inspect(error.stack));
             logger.methods.push('error', error.message, [{error: error}]);
         }
     };
+
     request(options, callback);
+    debug.writeRequest(options);
 };
 
 module.exports.sendSync = function sendSync(options) {
-
     try {
         var res = requestSync('POST', options.url, {
             json: options.data,
             headers: options.headers
         });
+        options.data.Msgs = options.data.Msgs.length + ' messages';
+        debug.close('Sending logs synchronously before exiting the app\n' + JSON.stringify(options, null, 4));
     } catch (err) {
-        console.error(err.stack);
+        debug.writeSync('Sending failed. Error stack: \n' + JSON.stringify(err.stack, null, 4));
         process.exit(1);
     }
-
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "stackify-logger",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Stackify logs and errors for Node.Js",
   "main": "index.js",
   "scripts": {
@@ -11,16 +11,27 @@
     "logger",
     "log"
   ],
-  "author": "Stackify",
+  "author": {
+    "name": "Stackify"
+  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/stackify/stackify-log-nodejs.git"
+    "url": "http://github.com/stackify/stackify-log-nodejs.git"
   },
   "homepage": "https://github.com/stackify/stackify-log-nodejs",
   "dependencies": {
     "request": "~2.48.x",
     "stack-trace": "0.0.9",
     "sync-request": "^1.0.1"
-  }
+  },
+  "readme": "#Stackify Log API for Node.js\n\nErrors and Logs Overview:\n\nhttp://docs.stackify.com/m/7787/l/189767\n\nSign Up for a Trial:\n\nhttp://www.stackify.com/sign-up/\n\n## Installation\n```bash\n$ npm install stackify-logger\n```\n\n## Usage\n\n```js\nvar stackify = require(‘stackify-logger’);\n```\nStart sending logs:\n```js\n// this should be executed only once in the app\nstackify.start(options);\n```\nThe following options could be passed. 'apiKey' is the only one that required:\n* __apiKey:__ client license key\n* __env:__ environment name\n* __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false\n* __proxy:__ proxy server if you want to send requests via proxy.\n\n*Notice:* stackify-logger sends synchronous requests if you call `process.exit()`. Sending via proxy wouldn't be possible in this case.\n\n#### Using direct logger\n\nIf you are not using Winston logger you can use default Stackify logger. It has 5 levels of messages: `trace`, `debug`, `info`, `warn` and `error`. To send the message to Stackify API you should run one of the following methods in any place of your code where you want to track some information:\n```js\nstackify.log(level, message [, meta])\nstackify.trace(message [, meta])\nstackify.debug(message [, meta])\nstackify.info(message [, meta])\nstackify.warn(message [, meta])\nstackify.error(message [, meta])\n```\n\n**Message** must be a string.\n\n**meta** - an additional parameter of any type.\n\nExamples of usage:\n```js\n// Add the module to all the script files where you want to log any messages.\nvar stackify = require('stackify-logger');\n\nstackify.log('info', 'hey!');\nstackify.debug('any message');\nstackify.info('any message', {anything: 'this is metadata'});\nstackify.warn('attention');\nstackify.log('error', {error : new Error()});\n```\nWhen logging an error message you can pass an Error object in metadata like in the last example, so the exception details would be available.\n\n#### Exception handling\nBy executing `stackify.start()` you set a handler for uncaught exceptions.\nMake sure you run it before any methods that set exception handlers.\n\n##### Using with Express\nGlobal handler doesn't work inside Express route methods.\nYou should use error-handling middleware function `stackify.expressExceptionHandler`. Since middleware is executed serially, it's order of inclusion is important. Make sure you add it before any other error-handling middleware.\n\n```js\nvar express = require('express');\nvar app = express();\n\n/* \n*** block of route handlers ***\n*** *** **** **** **** **** ***\n*/\n\napp.use(stackify.expressExceptionHandler);\n```\n\nTo handle exceptions correctly put this right after all route handlers.\n\n## Troubleshooting\nWhen request to Stackify fails for some reason, an error message is being printed to your `process.stderr` stream \n\n## License\n\nCopyright 2014 Stackify, LLC.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
+  "readmeFilename": "README.md",
+  "gitHead": "d0b7a4ade02acf6dc17d5c1e96d67a78edc9ed7f",
+  "bugs": {
+    "url": "https://github.com/stackify/stackify-log-nodejs/issues"
+  },
+  "_id": "stackify-logger@1.0.1",
+  "_shasum": "33730db585d53b43988b359145d76629e7ec35f1",
+  "_from": "stackify-logger@"
 }
