feat(http): add keep query params option

Author: Shadowbeetle

lib/instrumentations/core/http/request.js

@@ -7,6 +7,8 @@ var format = require('util').format
 
 function httpClient (originalHttpRequest, agent) {
   var whiteListHosts = agent.getConfig().whiteListHosts
+  var config = agent.getConfig()
+  var keepQueryParams = config.keepQueryParams
 
   return function wrappedRequest (requestParams) {
     var collector = agent.tracer.collector
@@ -29,7 +31,13 @@ function httpClient (originalHttpRequest, agent) {
       return originalHttpRequest.apply(this, arguments)
     }
 
-    var resource = util.formatDataUrl(requestParams.path)
+    var resource
+    if (keepQueryParams) {
+      var requestUrl = requestParams.path
+      resource = util.formatDataUrl(requestUrl)
+    } else {
+      resource = requestParams.path.split('?')[0]
+    }
 
     var cs = collector.clientSend({
       protocol: 'http',

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

@@ -439,4 +439,66 @@ describe('The http.request wrapper module', function () {
       targetHost: 'localhost'
     })
   })
+
+  it('should not keep queryParams by default', function () {
+    var r = request(original, agent)
+
+    appliedOriginal.on = this.sandbox.spy(function (name, cb) {
+      if (name === 'response') {
+        cb({
+          headers: {
+            'x-parent': '2',
+            'x-server-send': '12345668',
+            'x-server-receive': '12345698'
+          },
+          statusCode: 200
+        })
+      }
+    })
+
+    r({
+      host: 'localhost',
+      path: '/query?foo=bar',
+      headers: {},
+      method: 'GET'
+    })
+
+    expect(agent.tracer.collector.clientSend.args[0][0].resource).to.eql('/query')
+  })
+
+  it('should keep queryParams if set in config', function () {
+    this.sandbox.stub(agent, 'getConfig').returns({
+      whiteListHosts: [
+        'risingstack.com'
+      ],
+      ignoreHeaders: {
+        'user-agent': ['006', '007']
+      },
+      keepQueryParams: true
+    })
+
+    appliedOriginal.on = this.sandbox.spy(function (name, cb) {
+      if (name === 'response') {
+        cb({
+          headers: {
+            'x-parent': '2',
+            'x-server-send': '12345668',
+            'x-server-receive': '12345698'
+          },
+          statusCode: 200
+        })
+      }
+    })
+
+    var r = request(original, agent)
+
+    r({
+      host: 'localhost',
+      path: '/query?foo=bar',
+      headers: {},
+      method: 'GET'
+    })
+
+    expect(agent.tracer.collector.clientSend.args[0][0].resource).to.eql('/query?foo=bar')
+  })
 })

lib/instrumentations/core/http/server.js

@@ -40,9 +40,16 @@ function httpServer (listener, agent) {
   var ignoreHeaders = config.ignoreHeaders
   var ignorePaths = config.ignorePaths
   var ignoreStatusCodes = config.ignoreStatusCodes
+  var keepQueryParams = config.keepQueryParams
 
   return function (request, response) {
-    var requestUrl = request.url.split('?')[0]
+    var resource
+    var requestUrl = request.url
+    if (keepQueryParams) {
+      resource = util.formatDataUrl(requestUrl)
+    } else {
+      resource = request.url.split('?')[0]
+    }
 
     var headers = request.headers
 
@@ -74,8 +81,6 @@ function httpServer (listener, agent) {
       communicationId: communicationId
     }
 
-    var resource = util.formatDataUrl(requestUrl)
-
     var payload = {
       protocol: 'http',
       host: headers.host,

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

@@ -458,4 +458,54 @@ describe('The http.Server.prototype wrapper module', function () {
     response.writeHead()
     expect(agent.tracer.collector.serverSend.args[0][1]).to.eql(serverRecvResult.briefcase)
   })
+
+  it('should not keep queryParams by default', function () {
+    var s = server(original, agent)
+
+    var request = {
+      headers: {
+        host: 'host',
+        'x-span-id': 'comm-id',
+        'x-request-id': 'tr-id',
+        'x-parent': '1'
+      },
+      url: '/query?foo=bar',
+      method: 'GET'
+    }
+    s(request, response)
+
+    response.writeHead()
+
+    expect(agent.tracer.collector.serverRecv.args[0][0].resource).to.eql('/query')
+  })
+
+  it('should keep queryParams if set in config', function () {
+    this.sandbox.stub(agent, 'getConfig').returns({
+      whiteListHosts: [
+        'risingstack.com'
+      ],
+      ignoreHeaders: {
+        'user-agent': ['006', '007']
+      },
+      keepQueryParams: true
+    })
+
+    var s = server(original, agent)
+
+    var request = {
+      headers: {
+        host: 'host',
+        'x-span-id': 'comm-id',
+        'x-request-id': 'tr-id',
+        'x-parent': '1'
+      },
+      url: '/query?foo=bar',
+      method: 'GET'
+    }
+    s(request, response)
+
+    response.writeHead()
+
+    expect(agent.tracer.collector.serverRecv.args[0][0].resource).to.eql('/query?foo=bar')
+  })
 })

lib/utils/configReader.js

@@ -63,7 +63,8 @@ ConfigReader.prototype._getEnvVarConfig = function () {
     disableInstrumentations: process.env.TRACE_DISABLE_INSTRUMENTATIONS
       ? process.env.TRACE_DISABLE_INSTRUMENTATIONS.split(',')
       : undefined,
-    proxy: process.env.TRACE_PROXY || process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY
+    proxy: process.env.TRACE_PROXY || process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY,
+    keepQueryParams: process.env.TRACE_KEEP_QUERY_PARAMS
   }
 
   var ignoreHeaders