different minor style fixes

Author: alexk-blackops

.gitignore

@@ -1,5 +1,2 @@
 node_modules
-npm-debug.log
-proxy.js
-proxy2.js
-new.js
+npm-debug.log

README.md

@@ -27,7 +27,7 @@ The following options could be passed. 'apiKey' is the only one that required:
 * __apiKey:__ client license key
 * __env:__ environment name
 * __proxy:__ proxy server if you want to send requests via proxy
-* __exitOnError:__ Boolean flag indicating whether to shutdown the server after logging an uncaught exception
+* __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
 
 #### Using with Winston
 
@@ -47,17 +47,17 @@ All the details could be found here - [Winston Transport for Stackify](https://g
 
 If 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:
 ```js
-stackify.log(level, message, meta)
-stackify.trace(message, meta)
-stackify.debug(message, meta)
-stackify.info(message, meta)
-stackify.warn(message, meta)
-stackify.error(message, meta)
+stackify.log(level, message [, meta1, ... , metaN])
+stackify.trace(message [, meta1, ... , metaN])
+stackify.debug(message [, meta1, ... , metaN])
+stackify.info(message [, meta1, ... , metaN])
+stackify.warn(message [, meta1, ... , metaN])
+stackify.error(message [, meta1, ... , metaN])
 ```
+Message must be a string
+meta1 ... metaN - a list of additional parameters of any type.
 The timestamp will be added to every message by default.
 
-Meta parameter should be an object.
-
 Examples of usage:
 ```js
 // Add the module to all the script files where you want to log any messages.
@@ -88,7 +88,7 @@ http.createServer(function (req, res) {
   });
 });
 ```
-where req is request object, instance of native NodeJS `http.IncomingMessage` object
+where req is request object, an instance of native NodeJS `http.IncomingMessage` object
 
 You can use it also with any framework that doesn’t modify native createServer method.
 

config/config.js

@@ -14,9 +14,11 @@ module.exports = {
         QUEUE_CAP          : 10000,
         MIN_BATCH_SIZE     : 10,
         MAX_BATCH_SIZE     : 100,
-        MAX_DUP_ERROR_PER_MINUTE: 5, // Number of instances of a unique error that are allowed to be sent in one minute
+        MAX_DUP_ERROR_PER_MINUTE: 100, // Number of instances of a unique error that are allowed to be sent in one minute
 
     },
     IDENTIFY_DELAY: 300000, // 5 minutes delay if identifyApp call failed
     COOKIE_MASK: 'X-MASKED-X' // cookie headers and values mask
+    LOGGER_VERSION: 'Node.js Stackify v.1.0',
+    X-STACKIFY-PV: 'V1'
 };

lib/api.js

@@ -40,6 +40,7 @@ module.exports.methods = {
             };
 
         // check that settings object is correct
+
         if (!settings) {
             throw new TypeError('Settings are not provided');
         }
@@ -56,10 +57,11 @@ module.exports.methods = {
 
     },
 
-    /* posting logs to API.
-       messages - array of messages,
-       cb - callback function
-       shutdown - optional parameter, indicating if we should retry request attempts when API is down
+    /*
+    *** posting logs to API ***
+    *** messages - array of messages ***
+    *** cb - callback function ***
+    *** shutdown - optional parameter, indicating if we should retry request attempts when API is down ***
     */
     postLogs: function postLogs(messages, cb, shutdown) {
         var delay = 0, // scheduled delay when postLogs call failed
@@ -85,12 +87,16 @@ module.exports.methods = {
 
         sender.send(opt, cb, shutdown ? null : fail);
     },
+    /* 
+    *** posting logs synchronously in case if server is about to close *** 
+    */
     postLogsSync: function postLogsSync(messages) {
         var options = {
             url: CONFIG.PROTOCOL + '://' + CONFIG.HOST + CONFIG.LOG_SAVE_PATH,
             headers : helpers.getHeaders(),
             data: helpers.getPostBody(messages)
         };
+        console.log(options);
         sender.sendSync(options);
     }
 };

lib/exception.js

@@ -3,7 +3,7 @@ var qs      = require('querystring'),
     error   = require('./error'),
     logger  = require('./logger'),
     CONFIG  = require('../config/config');
-    
+
 module.exports = {
     // flag used to prevent catching the same exception twice (inside and outside of the createServer method)
     excCaught : false,
@@ -37,53 +37,46 @@ module.exports = {
     },
     // Express error handling middleware
     expressExceptionHandler : function expressExceptionHandler(err, req, res, next) {
-            var cb = function () {
-                if (CONFIG.EXIT_ON_ERROR === true) {
-                    process.exit(1);
-                } else {
-                    next(err);
-                }
-            };
-
-            if (!err) {
-                return next();
+        var cb = function () {
+            if (CONFIG.EXIT_ON_ERROR === true) {
+                process.exit(1);
+            } else {
+                next(err);
             }
+        };
 
-            if (!this.excCaught) {
-                this.excCaught = true;
-                logger.methods.sendException(err, req, cb);
-            }
+        if (!err) {
+            return next();
+        }
+
+        if (!this.excCaught) {
+            this.excCaught = true;
+            logger.methods.sendException(err, req, cb);
+        }
     },
     // drain the queue and send the messages before server closes
     gracefulExitHandler : function gracefulExitHandler() {
-        return (function() {
-
-            var drain =  function drain() {
-                if (logger.storage.length) {
-                    api.methods.postLogsSync(storage);
-                }
-            };
-
+        return (function () {
             // Start reading from stdin so we don't exit instantly
             process.stdin.resume();
 
-            process.on('exit', function() {
-                drain();
+            process.on('exit', function () {
+                logger.methods.drain();
             });
 
-            // catch some signal events also
+            // catch some signal events too
             process.on('SIGINT', function () {
-                drain();
+                logger.methods.drain();
                 process.exit(1);
             });
 
             process.on('SIGTERM', function () {
-                drain();
+                logger.methods.drain();
                 process.exit(1);
             });
 
             process.on('SIGHUP', function () {
-                drain();
+                logger.methods.drain();
                 process.exit(1);
             });
         }());

lib/helpers.js

@@ -117,7 +117,10 @@ module.exports.getURL = function getURL(req) {
     return href;
 };
 
-// read the name of the app from package.json file
+/*
+*** Function for getting the name of the app from package.json file ***
+*/
+
 module.exports.getAppName = function getAppName() {
     var pjsonPath = path.join(process.env.PWD, 'package.json'),
         pjson;
@@ -131,7 +134,10 @@ module.exports.getAppName = function getAppName() {
     return pjson.name;
 };
 
-// getting post data for the request
+/*
+*** Function for getting the post data for the request ***
+*/
+
 module.exports.getPostBody = function getPostBody(messages) {
     return {
         CDID: CONFIG.APP_DETAILS ? CONFIG.APP_DETAILS.DeviceID : null,
@@ -143,12 +149,16 @@ module.exports.getPostBody = function getPostBody(messages) {
         ServerName: os.hostname(),
         AppName: CONFIG.APPNAME,
         AppLoc: process.env.PWD,
-        Logger: 'Node.js Stackify v.1.0',
+        Logger: CONFIG.LOGGER_VERSION,
         Platform: 'Node.js',
         Msgs : messages
     };
 };
-//getting all the options for requests
+
+/*
+*** Function for getting the request options ***
+*/
+
 module.exports.getOptions = function getOptions(path, body, proxy) {
     var result =  {
         url: CONFIG.PROTOCOL + '://' + CONFIG.HOST + path,
@@ -166,11 +176,15 @@ module.exports.getOptions = function getOptions(path, body, proxy) {
     return result;
 
 };
-// getting request headers
+
+/*
+*** Function for getting request headers ***
+*/
+
 module.exports.getHeaders = function getHeaders() {
     return {
         'Content-Type': 'application/json',
         'X-Stackify-Key': CONFIG.APIKEY,
-        'X-Stackify-PV': 'V1'
+        'X-Stackify-PV': CONFIG.X-STACKIFY-PV
     };
 };

test.js

@@ -29,6 +29,15 @@ app.get("/", function (req, res) {
 app.get("/1", function (req, res) {
     stackify.log('error', 'test');
     stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    stackify.error('msg', {error: new Error('simple error')});
+    
+    process.exit(1);
 });
 
 app.post("/post", function (req, res) {