some minor fixes

Author: alexk-blackops

README.md

@@ -26,12 +26,16 @@ stackify.start(options);
 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
+* __proxy:__ proxy server if you want to send requests via proxy.
+
+* Notice: * stackify-logger sends synchronous requests before any `process.exit()` calls in your code. Sending via proxy wouldn't be possible in this case.
+
 * __exitOnError:__ boolean flag indicating whether to shutdown the server after logging an uncaught exception, defaults to false
 
 #### Using with Winston
 
 ```bash
+$ npm install winston
 $ npm install winston-stackify
 ```
 
@@ -54,7 +58,8 @@ stackify.info(message [, meta1, ... , metaN])
 stackify.warn(message [, meta1, ... , metaN])
 stackify.error(message [, meta1, ... , metaN])
 ```
-Message must be a string
+
+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.
 
@@ -111,6 +116,9 @@ app.use(stackify.expressExceptionHandler);
 
 To handle exceptions correctly put this right after all route handlers.
 
+#### Troubleshooting
+When request to Stackify fails for some reason, an error message is being printed to your `process.stderr` stream 
+
 ## License
 
 Copyright 2014 Stackify, LLC.

config/config.js

@@ -18,7 +18,7 @@ module.exports = {
 
     },
     IDENTIFY_DELAY: 300000, // 5 minutes delay if identifyApp call failed
-    COOKIE_MASK: 'X-MASKED-X' // cookie headers and values mask
+    COOKIE_MASK: 'X-MASKED-X', // cookie headers and values mask
     LOGGER_VERSION: 'Node.js Stackify v.1.0',
-    X-STACKIFY-PV: 'V1'
+    X_STACKIFY_PV: 'V1'
 };

lib/helpers.js

@@ -122,7 +122,7 @@ module.exports.getURL = function getURL(req) {
 */
 
 module.exports.getAppName = function getAppName() {
-    var pjsonPath = path.join(process.env.PWD, 'package.json'),
+    var pjsonPath = path.join(process.cwd(), 'package.json'),
         pjson;
     try {
         pjson = require(pjsonPath);
@@ -185,6 +185,6 @@ module.exports.getHeaders = function getHeaders() {
     return {
         'Content-Type': 'application/json',
         'X-Stackify-Key': CONFIG.APIKEY,
-        'X-Stackify-PV': CONFIG.X-STACKIFY-PV
+        'X-Stackify-PV': CONFIG.X_STACKIFY_PV
     };
 };

lib/logger.js

@@ -28,23 +28,25 @@ var api     = require('./api'),
             /* if request is succesful remove messages from the queue,
                send another batch (if there are enough messages in the queue)
             */
-            success = function () {
-                storage = storage.slice(chunk); // remove this chunk from the queue
-                length -= chunk;
-                api.lastApiError = 0; // reset the last HTTP error
-
-                if (length) {
-                    chunk  = Math.min(length, CONFIG.MSG.MAX_BATCH_SIZE);
-                    data   = storage.slice(0, chunk);
-                    api.methods.postLogs(data, success, shutdown);
-                } else {
-                    // full batch is sent, set timeout for the next request
-                    if (cb) {
-                        // if exception is caught run next middleware or check if we need to shutdown the server
-                        cb();
+            success = function (response) {
+                if (response.success) {
+                    storage = storage.slice(chunk); // remove this chunk from the queue
+                    length -= chunk;
+                    api.lastApiError = 0; // reset the last HTTP error
+
+                    if (length) {
+                        chunk  = Math.min(length, CONFIG.MSG.MAX_BATCH_SIZE);
+                        data   = storage.slice(0, chunk);
+                        api.methods.postLogs(data, success, shutdown);
                     } else {
-                        sendingLogsInProgress = false;
-                        timeout = setTimeout(sendLogs, delay);
+                        // full batch is sent, set timeout for the next request
+                        if (cb) {
+                            // if exception is caught run next middleware or check if we need to shutdown the server
+                            cb();
+                        } else {
+                            sendingLogsInProgress = false;
+                            timeout = setTimeout(sendLogs, delay);
+                        }
                     }
                 }
             };

lib/sender.js

@@ -26,6 +26,7 @@ module.exports.send = function send(options, cb, fail) {
                 }
             }
         } else {
+            console.error(error.stack);
             logger.methods.push('error', error.message, [{error: error}]);
         }
     };