feat(ignorePath): possibility to filter out urls based on path

Author: gergelyke

README.md

@@ -53,7 +53,10 @@ module.exports = {
   apiKey: 'KEEP_ME_SECRET',
   ignoreHeaders: {
     'user-agent': ['007']
-  }
+  },
+  ignorePaths: [
+    '/healthcheck'
+  ]
 }
 ```
 

example/config/trace.config.js

@@ -7,5 +7,8 @@
    apiKey: 'KEEP_ME_SECRET',
    ignoreHeaders: {
      'user-agent': ['007']
-   }
+   },
+   ignorePaths: [
+     '/healtcheck'
+   ]
  }

lib/instrumentations/core/http/server.js

@@ -1,37 +1,48 @@
-var url = require('url')
-
-var qs = require('qs')
 var microtime = require('../../../optionalDependencies/microtime')
 var isNumber = require('lodash.isnumber')
 var debug = require('debug')('risingstack/trace')
 
 var util = require('./util')
 var consts = require('../../../consts')
 
+function isPathIgnored (ignorePaths, currentPath) {
+  if (!ignorePaths || !ignorePaths.length) {
+    return false
+  }
+
+  for (var i = 0; i < ignorePaths.length; i++) {
+    if (currentPath.match(ignorePaths[i])) {
+      return true
+    }
+  }
+
+  return false
+}
+
 function wrapListener (listener, agent, mustCollectStore) {
-  var ignoreHeaders = agent.getConfig().ignoreHeaders
+  var config = agent.getConfig()
+  var ignoreHeaders = config.ignoreHeaders
+  var ignorePaths = config.ignorePaths
 
   return function (request, response) {
+    var requestUrl = request.url.split('?')[0]
     var serverReceiveTime
 
     var headers = request.headers
     var spanId = headers['x-span-id']
 
-    var skipped = ignoreHeaders && Object.keys(ignoreHeaders).some(function (key) {
+    var isSkippedHeader = ignoreHeaders && Object.keys(ignoreHeaders).some(function (key) {
       return headers[key] && (ignoreHeaders[key].indexOf('*') > -1 || ignoreHeaders[key].indexOf(headers[key]) > -1)
     })
 
-    if (skipped) {
-      debug('trace event (sr); request skipped because of ignoreHeaders', headers)
+    if (isSkippedHeader || isPathIgnored(ignorePaths, requestUrl)) {
+      debug('trace event (sr); request skipped because of ignore options', headers)
       return listener.apply(this, arguments)
     }
 
-    var requestUrl = url.parse(request.url)
-    var requestQuery = qs.parse(requestUrl.query).requestId
-
     var originalWriteHead = response.writeHead
 
-    var requestId = headers['request-id'] || headers['x-request-id'] || requestQuery || agent.generateId()
+    var requestId = headers['request-id'] || headers['x-request-id'] || agent.generateId()
 
     debug('trace event (sr); request: %s', requestId, headers)
 
@@ -53,7 +64,7 @@ function wrapListener (listener, agent, mustCollectStore) {
       id: requestId,
       spanId: spanId,
       host: headers.host,
-      url: util.formatDataUrl(requestUrl.pathname),
+      url: util.formatDataUrl(requestUrl),
       time: serverReceiveTime,
       method: method,
       protocol: consts.PROTOCOLS.HTTP,
@@ -76,7 +87,7 @@ function wrapListener (listener, agent, mustCollectStore) {
         id: requestId,
         spanId: headers['x-span-id'],
         host: headers.host,
-        url: util.formatDataUrl(requestUrl.pathname),
+        url: util.formatDataUrl(requestUrl),
         time: serverSendTime,
         protocol: consts.PROTOCOLS.HTTP,
         statusCode: response.statusCode,

lib/instrumentations/core/http/server.spec.js

@@ -68,13 +68,32 @@ describe('The http.Server.prototype wrapper module', function () {
       s({
         headers: {
           'user-agent': '007'
-        }
+        },
+        url: '/'
       })
 
       expect(original).to.be.calledWith({
         headers: {
           'user-agent': '007'
-        }
+        },
+        url: '/'
+      })
+    })
+
+    it('skips the request if the path is a match', function () {
+      config.ignorePaths = [
+        '/healthcheck'
+      ]
+      var s = server(original, agent, mustCollectStore)
+
+      s({
+        url: '/healthcheck',
+        headers: {}
+      })
+
+      expect(original).to.be.calledWith({
+        url: '/healthcheck',
+        headers: {}
       })
     })
 
@@ -87,13 +106,15 @@ describe('The http.Server.prototype wrapper module', function () {
       s({
         headers: {
           'user-agent': '007'
-        }
+        },
+        url: '/'
       })
 
       expect(original).to.be.calledWith({
         headers: {
           'user-agent': '007'
-        }
+        },
+        url: '/'
       })
     })
 
@@ -108,7 +129,7 @@ describe('The http.Server.prototype wrapper module', function () {
           host: 'localhost'
         },
         pathname: '/',
-        url: '/?id=2',
+        url: '/?id=1',
         method: 'POST'
       }
       var response = {
@@ -172,7 +193,7 @@ describe('The http.Server.prototype wrapper module', function () {
           'x-must-collect': '1'
         },
         pathname: '/',
-        url: '/?id=2',
+        url: '/',
         method: 'POST'
       }
       var response = {