feat(ignore): add ignoreOutgoingHosts configuration

Author: gergelyke

README.md

@@ -60,12 +60,13 @@ module.exports = {
   ignoreStatusCodes: [
     401,
     404
+  ],
+  ignoreOutgoingHosts: [
+    'google.com'
   ]
 }
 ```
 
-**Here please pay special attention to the `ignoreHeaders` option. With this, you can specify which requests should not be accounted. This can be extremely useful if you want to filter out the noise generated by your health checks for example.**
-
 *Note: Custom reporters are no longer supported in trace 2.x*
 
 *Note: If you are running your app with NODE_ENV=test, Trace won't start*

lib/config.js

@@ -1,4 +1,3 @@
-var url = require('url')
 var config = {}
 
 config.collectInterval = 2 * 60 * 1000
@@ -17,10 +16,6 @@ config.collectorApiHealthcheckEndpoint = '/service/%s/healthcheck'
 
 config.configPath = 'trace.config'
 
-var collectorApiHost = url.parse(config.collectorApiUrl).host
-
-config.whiteListHosts = [
-  collectorApiHost
-]
+config.whiteListHosts = []
 
 module.exports = config

lib/config.spec.js

@@ -60,12 +60,24 @@ ConfigReader.prototype._getEnvVarConfig = function () {
     apiKey: process.env.TRACE_API_KEY
   }
 
+  var ignoreHeaders
+  var ignoreOutgoingHosts
+
   if (process.env.TRACE_IGNORE_HEADERS) {
     try {
-      var ignoreHeaders = JSON.parse(process.env.TRACE_IGNORE_HEADERS)
+      ignoreHeaders = JSON.parse(process.env.TRACE_IGNORE_HEADERS)
       defaults(envVarConfig, { ignoreHeaders: ignoreHeaders })
     } catch (err) {
-      console.error(format('%s trace: warning: Cannot parse TRACE_IGNORE_HEADERS. Error: %s', new Date(), err.message))
+      console.error(format('%s trace: warning: Cannot parse TRACE_IGNORE_HEADERS. Error: %s', err.message))
+    }
+  }
+
+  if (process.env.TRACE_IGNORE_OUTGOING_HOSTS) {
+    try {
+      ignoreOutgoingHosts = JSON.parse(process.env.TRACE_IGNORE_OUTGOING_HOSTS)
+      defaults(envVarConfig, { ignoreOutgoingHosts: ignoreOutgoingHosts })
+    } catch (err) {
+      console.error(format('%s trace: warning: Cannot parse TRACE_IGNORE_OUTGOING_HOSTS. Error: %s', err.message))
     }
   }
 
@@ -80,15 +92,30 @@ ConfigReader.prototype._readConfigFile = function (file) {
   return require(file)
 }
 
-ConfigReader.prototype._getFileConfig = function (file) {
-  if (file) {
-    try {
-      fs.statSync(path.resolve(file + '.js'))
-    } catch (ex) {
-      debug('Configuration file not found')
-      return { }
-    }
+ConfigReader.prototype._isConfigFileExists = function (file) {
+  var failCounter = 0
+  try {
+    fs.statSync(path.resolve(file + '.js'))
+  } catch (ex) {
+    failCounter += 1
+  }
+
+  try {
+    fs.statSync(path.resolve(file))
+  } catch (ex) {
+    failCounter += 1
+  }
 
+  if (failCounter < 2) {
+    return true
+  } else {
+    debug('Configuration file not found')
+    return false
+  }
+}
+
+ConfigReader.prototype._getFileConfig = function (file) {
+  if (file && this._isConfigFileExists(file)) {
     try {
       return this._readConfigFile(path.resolve(file))
     } catch (ex) {
@@ -183,7 +210,9 @@ ConfigReader.prototype.getConfig = function () {
     defaultConfig
   )
 
-  config.whiteListHosts = [url.parse(config.collectorApiUrl).host]
+  config.whiteListHosts = [
+    url.parse(config.collectorApiUrl).host
+  ].concat(config.ignoreOutgoingHosts || [])
 
   this.checkApiToken(config.apiKey)
 

lib/utils/configReader.js

@@ -87,6 +87,99 @@ describe('Config Reader module', function () {
     expect(config.test).to.eql('system')
   })
 
+  it('whitelists default collectorApiUrl host', function () {
+    var configReader = ConfigReader.create({
+      apiKey: testApiToken,
+      serviceName: 'test'
+    })
+
+    var config = configReader.getConfig()
+
+    expect(config.whiteListHosts).to.be.eql([ 'trace-collector-api.risingstack.com' ])
+  })
+
+  it('whitelists collectorApiUrl host from config', function () {
+    var configReader = ConfigReader.create({
+      collectorApiUrl: 'http://c.a.b',
+      apiKey: testApiToken,
+      serviceName: 'test'
+    })
+
+    var config = configReader.getConfig()
+
+    expect(config.whiteListHosts).to.be.eql([ 'c.a.b' ])
+  })
+
+  it('appends whitelist hosts from parameter config', function () {
+    var configReader = ConfigReader.create({
+      collectorApiUrl: 'http://c.a.b',
+      ignoreOutgoingHosts: [ 'fake.host1.com', 'fake.host2.com' ],
+      apiKey: testApiToken,
+      serviceName: 'test'
+    })
+
+    var config = configReader.getConfig()
+
+    expect(config.whiteListHosts).to.be.eql([ 'c.a.b', 'fake.host1.com', 'fake.host2.com' ])
+  })
+
+  it('appends whitelist hosts from environment config', function () {
+    process.env.TRACE_IGNORE_OUTGOING_HOSTS = JSON.stringify(
+      [ 'fake.host1.com', 'fake.host2.com' ]
+    )
+
+    var configReader = ConfigReader.create({
+      collectorApiUrl: 'http://c.a.b',
+      apiKey: testApiToken,
+      serviceName: 'test'
+    })
+
+    try {
+      var config = configReader.getConfig()
+      expect(config.whiteListHosts).to.be.eql([ 'c.a.b', 'fake.host1.com', 'fake.host2.com' ])
+
+      delete process.env.TRACE_IGNORE_OUTGOING_HOSTS
+    } catch (err) {
+      delete process.env.TRACE_IGNORE_OUTGOING_HOSTS
+      throw err
+    }
+  })
+
+  it('does not throw error if TRACE_IGNORE_OUTGOING_HOSTS is malformed, and uses the next highest priority source for the ignoreHeaders config', function () {
+    process.env.TRACE_IGNORE_OUTGOING_HOSTS = 'This is not a valid JSON'
+    var configReader = ConfigReader.create({
+      apiKey: testApiToken,
+      serviceName: 'test',
+      configPath: 'test'
+    })
+    var log = this.sandbox.spy(console, 'error')
+    var expected = [ 'c.a.b', 'fake.host1.com', 'fake.host2.com' ]
+
+    this.sandbox.stub(configReader, '_readConfigFile', function () {
+      return { ignoreOutgoingHosts: expected.slice(1) }
+    })
+
+    this.sandbox.stub(configReader, '_getDefaultConfig', function () {
+      return {
+        collectorApiUrl: 'http://c.a.b'
+      }
+    })
+
+    this.sandbox.stub(fs, 'statSync', function () {
+      return { }
+    })
+
+    try {
+      var config = configReader.getConfig()
+      expect(config.whiteListHosts).to.eql(expected)
+      expect(log).to.have.been.calledOnce
+      delete process.env.TRACE_IGNORE_OUTGOING_HOSTS
+    } catch (err) {
+      delete process.env.TRACE_IGNORE_OUTGOING_HOSTS
+      throw err
+    }
+  })
+
   it('file config should override default config', function () {
     var configReader = ConfigReader.create({
       serviceName: 'test',