feat(custom-metrics): upgrade to v2 API

Author: dszakallas

lib/agent/metrics/custom/index.js

@@ -1,11 +1,13 @@
 var inherits = require('util').inherits
 var Agent = require('../../agent')
+var reservoirSampler = require('../../util/samplers/reservoir')
 
 function CustomMetrics (options) {
   this.name = 'Metrics/Custom'
   this.collectorApi = options.collectorApi
   this.config = options.config
   this.collectInterval = this.config.collectInterval
+  this.samplerLimit = 15
 
   this.incrementMetrics = {}
   this.recordMetrics = {}
@@ -36,14 +38,30 @@ CustomMetrics.prototype.record = function (name, value) {
   }
 
   if (this.recordMetrics[name]) {
-    this.recordMetrics[name].push(value)
+    var metric = this.recordMetrics[name]
+    metric.sampler.add(value)
+    metric.sum += value
+    metric.min = metric.min < value ? metric.min : value
+    metric.max = metric.max > value ? metric.max : value
+    ++metric.count
   } else {
-    this.recordMetrics[name] = [value]
+    this.recordMetrics[name] = {
+      sampler: reservoirSampler.create(this.samplerLimit),
+      count: 1,
+      sum: value,
+      max: value,
+      min: value
+    }
+    this.recordMetrics[name].sampler.add(value)
   }
 }
 
 CustomMetrics.prototype.sendMetrics = function (callback) {
   callback = callback || function () {}
+  var self = this
+  Object.keys(this.recordMetrics).forEach(function (key) {
+    prepareRecordMetric(self.recordMetrics[key])
+  })
   this.collectorApi.sendCustomMetrics({
     incrementMetrics: this.incrementMetrics,
     recordMetrics: this.recordMetrics
@@ -62,5 +80,13 @@ function create (options) {
   return new CustomMetrics(options)
 }
 
+function prepareRecordMetric (recordMetric) {
+  var samples = recordMetric.sampler.flush()
+  delete recordMetric.sampler
+  recordMetric.samples = samples
+  recordMetric.avg = recordMetric.sum / recordMetric.count
+  delete recordMetric.sum
+}
+
 module.exports = CustomMetrics
 module.exports.create = create

lib/agent/metrics/custom/index.spec.js

@@ -34,8 +34,40 @@ describe('The CustomMetrics module', function () {
         '/TestCategory/TestName': 5
       },
       recordMetrics: {
-        '/TestCategory/TestRecord': [10, 2]
+        '/TestCategory/TestRecord': {
+          avg: 6,
+          count: 2,
+          max: 10,
+          min: 2,
+          samples: [10, 2]
+        }
       }
     })
   })
+
+  it('samples recordMetrics', function () {
+    var ISOString = 'date-string'
+    var collectorApi = {
+      sendCustomMetrics: this.sandbox.spy()
+    }
+
+    this.sandbox.stub(Date.prototype, 'toISOString', function () {
+      return ISOString
+    })
+
+    var customMetrics = CustomMetrics.create({
+      collectorApi: collectorApi,
+      config: {
+        collectInterval: 1
+      }
+    })
+
+    for (var i = 30; i > 0; --i) {
+      customMetrics.record('/TestCategory/TestRecord', 10)
+    }
+
+    customMetrics.sendMetrics()
+
+    expect(collectorApi.sendCustomMetrics.args[0][0].recordMetrics['/TestCategory/TestRecord'].samples).to.have.length(15)
+  })
 })

lib/agent/tracer/collector.js

@@ -7,7 +7,7 @@ var uuid = require('uuid')
 var assign = require('lodash.assign')
 var levels = require('./severity')
 var some = require('lodash.some')
-var reservoirSampler = require('./samplers/reservoir')
+var reservoirSampler = require('../util/samplers/reservoir')
 
 var EVENT_TYPE = {
   CLIENT_SEND: 'cs',

lib/agent/tracer/samplers/reservoir.js lib/agent/util/samplers/reservoir.jslib/agent/tracer/samplers/reservoir.js renamed to lib/agent/util/samplers/reservoir.js

@@ -19,7 +19,7 @@ config.collectorApiHealthcheckEndpoint = '/service/%s/healthcheck'
 config.collectorApiProfilerMemoryHeapdumpEndpoint = '/service/%s/memory-heapdump'
 config.collectorApiProfilerCpuProfileEndpoint = '/service/%s/cpu-profile'
 config.collectorApiControlEndpoint = '/service/%s/control'
-config.collectorApiCustomMetrics = '/service/%s/custom-metrics'
+config.collectorApiCustomMetrics = '/v2/service/%s/custom-metrics'
 config.collectorApiSecurityDependenciesEndpoint = '/service/%s/dependencies'
 
 config.configPath = 'trace.config'

…/agent/tracer/samplers/reservoir.spec.js lib/agent/util/samplers/reservoir.spec.jslib/agent/tracer/samplers/reservoir.spec.js renamed to lib/agent/util/samplers/reservoir.spec.js lib/agent/tracer/samplers/reservoir.spec.js renamed to lib/agent/util/samplers/reservoir.spec.js

@@ -40,7 +40,7 @@ function mockCustomMetricsRequest (opts) {
       'Authorization': 'Bearer ' + opts.apiKey
     }
   })
-    .post('/service/' + opts.serviceKey + '/custom-metrics')
+    .post('/v2/service/' + opts.serviceKey + '/custom-metrics')
     .times(opts.maxTimes || 1)
     .reply(opts.callback || 200)
 }