feat(collector): add hostname and pid to requests

Author: dszakallas

lib/agent/api/index.js

@@ -5,6 +5,7 @@ var requestSync = require('sync-request')
 var isNumber = require('lodash.isnumber')
 var debug = require('debug')('risingstack/trace')
 var format = require('util').format
+var assign = require('lodash.assign')
 
 var bl = require('bl')
 var libPackage = require('../../../package')
@@ -16,6 +17,8 @@ function CollectorApi (options) {
   this.COLLECTOR_API_RPM_METRICS = url.resolve(options.collectorApiUrl, options.collectorApiRpmMetricsEndpoint)
 
   this.apiKey = options.apiKey
+  this.processId = options.processId
+  this.hostname = options.hostname
   this.serviceName = options.serviceName
   this.baseRetryInterval = 100
   this.retryCount = 0
@@ -76,7 +79,7 @@ CollectorApi.prototype.sendRpmMetrics = function (data) {
   }
 
   var url = util.format(this.COLLECTOR_API_RPM_METRICS, this.serviceKey)
-  this._send(url, data)
+  this._send(url, assign({ hostname: this.hostname, pid: this.processId }, data))
 }
 
 CollectorApi.prototype.sendApmMetrics = function (data) {
@@ -86,12 +89,12 @@ CollectorApi.prototype.sendApmMetrics = function (data) {
   }
 
   var url = util.format(this.COLLECTOR_API_METRICS, this.serviceKey)
-  this._send(url, data)
+  this._send(url, assign({ hostname: this.hostname, pid: this.processId }, data))
 }
 
 CollectorApi.prototype.sendSamples = function (data) {
   var url = this.COLLECTOR_API_SAMPLE
-  this._send(url, data)
+  this._send(url, assign({ hostname: this.hostname, pid: this.processId }, data))
 }
 
 CollectorApi.prototype._getRetryInterval = function () {

lib/agent/api/index.spec.js

@@ -15,7 +15,9 @@ describe('The Trace CollectorApi module', function () {
     collectorApiSampleEndpoint: '/service/sample',
     collectorApiServiceEndpoint: '/service',
     collectorApiApmMetricsEndpoint: '/service/%s/apm-metrics',
-    collectorApiRpmMetricsEndpoint: '/service/%s/rpm-metrics'
+    collectorApiRpmMetricsEndpoint: '/service/%s/rpm-metrics',
+    hostname: 'test.org',
+    processId: '7777'
   }
 
   it('can be instantiated w/ serviceName and apiKey', function () {
@@ -27,7 +29,9 @@ describe('The Trace CollectorApi module', function () {
     var serviceKey = 12
 
     var data = {
-      trace: 'very data'
+      trace: 'very data',
+      hostname: 'test.org',
+      pid: 7777
     }
 
     var path = util.format(defaultConfig.collectorApiRpmMetricsEndpoint, serviceKey)
@@ -40,14 +44,15 @@ describe('The Trace CollectorApi module', function () {
 
     collectorApi.sendRpmMetrics(data)
 
-    expect(sendStub).to.have.been.calledOnce
     expect(sendStub).to.have.been.calledWith(sendUrl, data)
   })
 
   it('sends samples to the collector server', function (done) {
     var collectorApi = CollectorApi.create(defaultConfig)
     var data = {
-      trace: 'very data'
+      trace: 'very data',
+      hostname: 'test.org',
+      pid: 7777
     }
 
     nock(defaultConfig.collectorApiUrl, {

lib/utils/configReader.js

@@ -1,6 +1,7 @@
 'use strict'
 
 var path = require('path')
+var os = require('os')
 var url = require('url')
 var debug = require('debug')('risingstack/trace')
 var defaults = require('lodash.defaults')
@@ -10,6 +11,22 @@ function ConfigReader (config) {
   this.parameterConfig = config || { }
 }
 
+ConfigReader.prototype._getSystemConfig = function () {
+  return {
+    osArch: process.arch,
+    osPlatform: process.platform,
+    osRelease: os.release(),
+    hostname: os.hostname(),
+    cpus: os.cpus().map(function (cpu) {
+      delete cpu.times
+      return cpu
+    }),
+    processName: process.title,
+    processId: process.pid,
+    processVersion: process.version
+  }
+}
+
 ConfigReader.prototype._getEnvVarConfig = function () {
   var envVarConfig = {
     collectInterval: process.env.TRACE_COLLECT_INTERVAL,
@@ -59,12 +76,11 @@ ConfigReader.prototype._getFileConfig = function (file) {
 
 ConfigReader.prototype.getConfig = function () {
   var parameterConfig = this.parameterConfig
+  var systemConfig = this._getSystemConfig()
   var envVarConfig = this._getEnvVarConfig()
   var defaultConfig = this._getDefaultConfig()
 
-  var config = {}
-
-  config = defaults(config, parameterConfig, envVarConfig)
+  var config = defaults({}, parameterConfig, systemConfig, envVarConfig)
 
   var configFilePath = parameterConfig.configPath || envVarConfig.configPath || defaultConfig.configPath
 

lib/utils/configReader.spec.js

@@ -11,16 +11,6 @@ describe('Config Reader module', function () {
     expect(configReader).to.exist
   })
 
-  it('does not override reporter if it is given', function () {
-    var config = { serviceName: 'test', reporter: 'dummy', apiKey: 'api-key' }
-
-    var configReader = ConfigReader.create(config)
-
-    configReader.getConfig()
-
-    expect(config.reporter).to.eql('dummy')
-  })
-
   it('default config should be checked', function () {
     var configReader = ConfigReader.create({
       serviceName: 'test',
@@ -75,18 +65,34 @@ describe('Config Reader module', function () {
     expect(config.test).to.eql('env')
   })
 
-  it('file config should override default config', function () {
+  it('system configuration should be checked', function () {
     var configReader = ConfigReader.create({
       serviceName: 'test',
       reporter: 'dummy',
       collectorApiUrl: 'http://c.a.b',
       apiKey: 'api-key'
     })
 
-    this.sandbox.stub(configReader, '_getEnvVarConfig', function () {
-      return { }
+    var getSystemConfigStub = this.sandbox.stub(configReader, '_getSystemConfig', function () {
+      return { test: 'system' }
     })
 
+    var config = configReader.getConfig()
+
+    expect(getSystemConfigStub).to.have.been.calledOnce
+    expect(config.test).to.eql('system')
+  })
+
+  it('file config should override default config', function () {
+    var configReader = ConfigReader.create({
+      serviceName: 'test',
+      reporter: 'dummy',
+      collectorApiUrl: 'http://c.a.b',
+      apiKey: 'api-key'
+    })
+
+    this.sandbox.stub(configReader, '_getEnvVarConfig').returns({})
+
     this.sandbox.stub(configReader, '_getFileConfig', function () {
       return { test: 'file' }
     })
@@ -116,21 +122,37 @@ describe('Config Reader module', function () {
     expect(config.test).to.eql('env')
   })
 
-  it('parameter config should override environment variable config', function () {
+  it('system config should override all env var config', function () {
+    var configReader = ConfigReader.create({ serviceName: 'test', reporter: 'dummy', apiKey: 'api-key' })
+
+    this.sandbox.stub(configReader, '_getSystemConfig', function () {
+      return { test: 'system' }
+    })
+
+    this.sandbox.stub(configReader, '_getEnvVarConfig', function () {
+      return { test: 'env' }
+    })
+
+    this.sandbox.stub(configReader, '_getFileConfig').returns({})
+
+    var config = configReader.getConfig()
+
+    expect(config.test).to.eql('system')
+  })
+
+  it('parameter config should override system config', function () {
     var configReader = ConfigReader.create({
       serviceName: 'test',
       reporter: 'dummy',
       test: 'param',
       apiKey: 'api-key'
     })
 
-    this.sandbox.stub(configReader, '_getEnvVarConfig', function () {
-      return { test: 'env' }
+    this.sandbox.stub(configReader, '_getSystemConfig', function () {
+      return { test: 'system' }
     })
 
-    this.sandbox.stub(configReader, '_getFileConfig', function () {
-      return { }
-    })
+    this.sandbox.stub(configReader, '_getFileConfig').returns({})
 
     var config = configReader.getConfig()
 
@@ -149,9 +171,7 @@ describe('Config Reader module', function () {
       return { configPath: 'default' }
     })
 
-    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig', function () {
-      return { }
-    })
+    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig').returns({})
 
     configReader.getConfig()
 
@@ -170,9 +190,7 @@ describe('Config Reader module', function () {
       return { configPath: 'env' }
     })
 
-    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig', function () {
-      return { }
-    })
+    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig').returns({})
 
     configReader.getConfig()
 
@@ -188,9 +206,7 @@ describe('Config Reader module', function () {
       apiKey: 'api-key'
     })
 
-    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig', function () {
-      return { }
-    })
+    var getFileConfigStub = this.sandbox.stub(configReader, '_getFileConfig').returns({})
 
     configReader.getConfig()
 
@@ -236,15 +252,16 @@ describe('Config Reader module', function () {
       apiKey: 'api-key'
     })
     var log = this.sandbox.spy(console, 'error')
-    var ignoreHeadersOption = {
+    var wellformed = {
       'user-agent': ['007']
     }
+
     this.sandbox.stub(configReader, '_readConfigFile', function () {
-      return { ignoreHeaders: ignoreHeadersOption }
+      return { ignoreHeaders: wellformed }
     })
     try {
       var config = configReader.getConfig()
-      expect(config.ignoreHeaders).to.eql(ignoreHeadersOption)
+      expect(config.ignoreHeaders).to.eql(wellformed)
       expect(log).to.have.been.calledOnce
       delete process.env.TRACE_IGNORE_HEADERS
     } catch (err) {

package.json

@@ -48,6 +48,7 @@
     "debug": "2.2.0",
     "event-loop-stats": "1.0.0",
     "gc-stats": "1.0.0",
+    "lodash.assign": "4.0.3",
     "lodash.defaults": "4.0.1",
     "lodash.isnumber": "3.0.3",
     "microtime": "2.0.0",