Update header list. Add middleware option.

Author: djfarrelly

README.md

@@ -61,7 +61,7 @@ app.use(logMiddleware({
       userId: req.session.userId,
       profileId: req.query.profileId,
     };
-  };
+  },
 }));
 ```
 
@@ -80,7 +80,7 @@ app.use(logMiddleware({
       processingTime: responseTime - req.trackingData.externalRequestTime,
       imagesScanned: req.trackingData.imagesScanned,
     };
-  };
+  },
 }));
 // In your request handler
 app.get('/get-images', (req, res) => {
@@ -91,3 +91,13 @@ app.get('/get-images', (req, res) => {
   });
 });
 ```
+
+#### Params
+
+Add logging of specific query string params using the `getMetadata` option.
+
+```js
+app.use(logMiddleware({
+  params: ['profile_id', 'utm_campaign'],
+}));
+```

lib/utils.js

@@ -56,9 +56,12 @@ module.exports.pick = pick;
 
 
 const headersToLog = [
-  'user-agent',
-  'referer',
   'cache-control',
+  'host',
+  'referer',
+  'user-agent',
+  'x-real-ip',
+  'x-forwarded-for',
 ];
 /**
  * getRequestDataToLog

middleware.js

@@ -14,11 +14,12 @@ module.exports = function middleware(options) {
   const {
     getMetadata,
     getStats,
+    params,
   } = options;
 
   return function logRequest(req, res, next) {
     const startTime = new Date();
-    const request = getRequestDataToLog(req);
+    const request = getRequestDataToLog(req, params);
 
     onFinished(res, () => {
       const finishTime = new Date();

test/testUtils.js

@@ -77,17 +77,23 @@ describe('utils', () => {
           remotePort: 40234,
         },
         headers: {
+          host: 'buffer.com',
           'user-agent': 'Mozilla/5.0',
           referer: 'https://twitter.com',
           'cache-control': 'no-cache',
+          'x-real-ip': '172.18.0.1',
+          'x-forwarded-for': '172.18.0.1',
           'x-something-bogus': false,
-        }
+        },
       };
       const data = getRequestDataToLog(req);
       assert.deepEqual(data.headers, {
+        host: 'buffer.com',
         'user-agent': 'Mozilla/5.0',
         referer: 'https://twitter.com',
         'cache-control': 'no-cache',
+        'x-real-ip': '172.18.0.1',
+        'x-forwarded-for': '172.18.0.1',
       });
     });