feat(tracer): implement transaction event support

Author: dszakallas

lib/agent/agent.js

@@ -0,0 +1,28 @@
+var Timer = require('./timer')
+
+function Agent (name, interval, task) {
+  this.name = name
+  if (interval != null && typeof task === 'function') {
+    this.timer = new Timer(function () {
+      task()
+    }, interval)
+  }
+}
+
+Agent.prototype.start = function () {
+  if (this.timer) {
+    this.timer.start()
+  }
+}
+
+Agent.prototype.stop = function () {
+  if (this.timer) {
+    this.timer.end()
+  }
+}
+
+Agent.prototype.initialize = function () { }
+
+Agent.prototype.destruct = function () { this.stop() }
+
+module.exports = Agent

lib/agent/api/index.js

@@ -12,7 +12,6 @@ var bl = require('bl')
 var libPackage = require('../../../package')
 
 function CollectorApi (options) {
-  this.COLLECTOR_API_SAMPLE = url.resolve(options.collectorApiUrl, options.collectorApiSampleEndpoint)
   this.COLLECTOR_API_SERVICE = url.resolve(options.collectorApiUrl, options.collectorApiServiceEndpoint)
   this.COLLECTOR_API_METRICS = url.resolve(options.collectorApiUrl, options.collectorApiApmMetricsEndpoint)
   this.COLLECTOR_API_RPM_METRICS = url.resolve(options.collectorApiUrl, options.collectorApiRpmMetricsEndpoint)
@@ -38,17 +37,17 @@ function CollectorApi (options) {
 }
 
 // USE THIS WITH CAUTION, IT WILL BE BLOCKING
-CollectorApi.prototype._sendSync = function (destinationUrl, data) {
+CollectorApi.prototype._sendSync = function (destinationUrl, data, options) {
   debug('sending data to trace servers sync: ', stringify(data))
   try {
     requestSync('POST', destinationUrl, {
       json: data,
-      headers: {
+      headers: assign({
         'Authorization': 'Bearer ' + this.apiKey,
         'Content-Type': 'application/json',
         'X-Reporter-Version': libPackage.version,
         'X-Reporter-Language': this.collectorLanguage
-      },
+      }, options && options.headers),
       timeout: 1000
     })
   } catch (ex) {
@@ -63,7 +62,7 @@ CollectorApi.prototype._withInstanceInfo = function (data) {
   }, data)
 }
 
-CollectorApi.prototype._send = function (destinationUrl, data, callback) {
+CollectorApi.prototype._send = function (destinationUrl, data, callback, options) {
   var opts = url.parse(destinationUrl)
   var payload = stringify(data)
 
@@ -76,13 +75,13 @@ CollectorApi.prototype._send = function (destinationUrl, data, callback) {
     method: 'POST',
     // if the proxy is not set, it will fallback to the default agent
     agent: this.proxyAgent,
-    headers: {
+    headers: assign({
       'Authorization': 'Bearer ' + this.apiKey,
       'Content-Type': 'application/json',
       'X-Reporter-Version': libPackage.version,
       'X-Reporter-Language': this.collectorLanguage,
       'Content-Length': Buffer.byteLength(payload)
-    }
+    }, options && options.headers)
   }
 
   var req = https.request(requestOptions, function (res) {
@@ -218,21 +217,6 @@ CollectorApi.prototype.sendCustomMetrics = function (data) {
   }))
 }
 
-CollectorApi.prototype.sendSamples = function (samples, sync) {
-  var url = this.COLLECTOR_API_SAMPLE
-  var metadata = {
-    version: '2',
-    instance: this._withInstanceInfo({}),
-    service: {
-      key: this.serviceKey ? this.serviceKey : undefined,
-      name: this.serviceName
-    }
-  }
-
-  var data = assign({}, samples, metadata)
-  sync ? this._sendSync(url, data) : this._send(url, data)
-}
-
 CollectorApi.prototype.sendDependencies = function (dependencies) {
   var url = util.format(this.COLLECTOR_API_SECURITY_DEPENDENCIES, this.serviceKey)
   this._send(url, dependencies)

lib/agent/api/index.spec.js

@@ -7,7 +7,6 @@ var CollectorApi = require('./')
 var expect = require('chai').expect
 var nock = require('nock')
 var libPackage = require('../../../package')
-var assign = require('lodash.assign')
 
 describe('The Trace CollectorApi module', function () {
   var defaultConfig
@@ -117,40 +116,6 @@ describe('The Trace CollectorApi module', function () {
     expect(sendStub).to.have.been.calledWith(sendUrl, data)
   })
 
-  it('enhances samples with required properties', function (done) {
-    var collectorApi = CollectorApi.create(defaultConfig)
-    var data = {
-      test: 'clearly a mock'
-    }
-
-    nock(defaultConfig.collectorApiUrl, {
-      reqheaders: {
-        'Authorization': 'Bearer testApiKey',
-        'Content-Type': 'application/json',
-        'X-Reporter-Version': libPackage.version,
-        'X-Reporter-Language': defaultConfig.collectorLanguage
-      }
-    })
-      .post(defaultConfig.collectorApiSampleEndpoint, function (body) {
-        expect(body).to.eql(assign({
-          version: '2',
-          instance: {
-            hostname: defaultConfig.system.hostname,
-            pid: defaultConfig.system.processId
-          },
-          service: {
-            name: defaultConfig.serviceName
-          }
-        }, data))
-        return JSON.stringify(data)
-      })
-      .reply(201, function () {
-        done()
-      })
-
-    collectorApi.sendSamples(data)
-  })
-
   it('sends incomingEdgeMetrics with the required properties', function (done) {
     var serviceKey = 12
     var collectorApi = CollectorApi.create(defaultConfig)

lib/agent/control/control.js

@@ -1,24 +1,23 @@
 var debug = require('debug')('risingstack/trace')
 
-var Timer = require('../timer')
+var inherits = require('util').inherits
+var Agent = require('../agent')
 
 function Control (options) {
-  var _this = this
-  this.name = 'Control'
-
   this.collectorApi = options.collectorApi
   this.controlBus = options.controlBus
   this.config = options.config
   this.updateInterval = this.config.updateInterval
+
   this.latestCommandId = undefined
 
   this.getUpdates()
 
-  this.timer = new Timer(function () {
-    _this.getUpdates()
-  }, this.updateInterval)
+  Agent.call(this, 'Control', this.updateInterval, this.getUpdates.bind(this))
 }
 
+inherits(Control, Agent)
+
 Control.prototype.getUpdates = function () {
   var _this = this
   this.collectorApi.getUpdates({

lib/agent/healthcheck/index.js

@@ -1,17 +1,16 @@
-var Timer = require('../timer')
+var inherits = require('util').inherits
+var Agent = require('../agent')
 
 function Healthcheck (options) {
-  this.name = 'Healthcheck'
-  var _this = this
   this.collectorApi = options.collectorApi
   this.config = options.config
   this.healthcheckInterval = this.config.healthcheckInterval
 
-  this.timer = new Timer(function () {
-    _this.ping()
-  }, this.healthcheckInterval)
+  Agent.call(this, 'Healthcheck', this.healthcheckInterval, this.ping.bind(this))
 }
 
+inherits(Healthcheck, Agent)
+
 Healthcheck.prototype.ping = function () {
   this.collectorApi.ping()
 }