feat(profiler): adding cpu

Author: gergelyke

lib/agent/api/index.js

@@ -18,6 +18,7 @@ function CollectorApi (options) {
   this.COLLECTOR_API_EXTERNAL_EDGE_METRICS = url.resolve(options.collectorApiUrl, options.collectorApiExternalEdgeMetricsEndpoint)
   this.COLLECTOR_API_HEALTHCHECK = url.resolve(options.collectorApiUrl, options.collectorApiHealthcheckEndpoint)
   this.COLLECTOR_API_PROFILER_MEMORY_HEAPDUMP = url.resolve(options.collectorApiUrl, options.collectorApiProfilerMemoryHeapdumpEndpoint)
+  this.COLLECTOR_API_PROFILER_CPU_PROFILE = url.resolve(options.collectorApiUrl, options.collectorApiProfilerCpuProfileEndpoint)
   this.COLLECTOR_API_CONTROL = url.resolve(options.collectorApiUrl, options.collectorApiControlEndpoint)
 
   this.collectorLanguage = options.collectorLanguage
@@ -132,6 +133,16 @@ CollectorApi.prototype.sendMemorySnapshot = function (data) {
   this._send(url, this._withInstanceInfo(data))
 }
 
+CollectorApi.prototype.sendCpuProfile = function (data) {
+  if (!isNumber(this.serviceKey)) {
+    debug('Service id not present, cannot send cpu profile')
+    return
+  }
+
+  var url = util.format(this.COLLECTOR_API_PROFILER_CPU_PROFILE, this.serviceKey)
+  this._send(url, this._withInstanceInfo(data))
+}
+
 CollectorApi.prototype.sendExternalEdgeMetrics = function (data) {
   if (!isNumber(this.serviceKey)) {
     debug('Service id not present, cannot send metrics')

lib/agent/api/index.spec.js

@@ -23,6 +23,7 @@ describe('The Trace CollectorApi module', function () {
     collectorApiExternalEdgeMetricsEndpoint: '/service/%s/edge-external',
     collectorApiHealthcheckEndpoint: '/service/%s/healthcheck',
     collectorApiProfilerMemoryHeapdumpEndpoint: '/service/%s/memory-heapdump',
+    collectorApiProfilerCpuProfileEndpoint: '/service/%s/cpu-profile',
     collectorApiControlEndpoint: '/service/%s/control',
     system: {
       hostname: 'test.org',

lib/agent/index.js

@@ -67,6 +67,12 @@ function Agent (options) {
     controlBus: controlBus
   })
 
+  this.cpuProfiler = Profiler.cpu.create({
+    collectorApi: this.collectorApi,
+    config: this.config,
+    controlBus: controlBus
+  })
+
   this.control = Control.create({
     collectorApi: this.collectorApi,
     config: this.config,

lib/agent/profiler/cpu/index.js

@@ -0,0 +1,44 @@
+var debug = require('debug')('risingstack/trace')
+
+var v8profiler = require('../../../optionalDependencies/v8-profiler')
+
+
+function CpuProfiler (options) {
+  var _this = this
+  this.collectorApi = options.collectorApi
+  this.controlBus = options.controlBus
+  this.profileWindow = 10000
+
+  this.controlBus.on('cpu-profile', function (data) {
+    _this.sendProfile()
+  })
+}
+
+CpuProfiler.prototype.sendProfile = function () {
+  var _this = this
+
+  v8profiler.startProfiling('trace-cpu-profile', true)
+
+  setTimeout(function() {
+    var profile = v8profiler.stopProfiling('trace-cpu-profile')
+
+    // if the v8-profiler cannot be compiled, we won't have a profile
+    profile && profile.export(function(err, result) {
+      if (err) {
+        return debug(err)
+      }
+
+      _this.collectorApi.sendCpuProfile({
+        cpuProfile: result,
+        time: Date.now()
+      })
+      profile.delete()
+    });
+  }, this.profileWindow)
+}
+
+function create (options) {
+  return new CpuProfiler(options)
+}
+
+module.exports.create = create

lib/agent/profiler/cpu/index.spec.js

@@ -0,0 +1,53 @@
+var expect = require('chai').expect
+var EventEmitter = require('events').EventEmitter
+
+var v8profiler = require('../../../optionalDependencies/v8-profiler')
+var CpuProfiler = require('./')
+
+describe('The Cpu Profiler module', function () {
+  it('sends profile', function (done) {
+    var msgBus = new EventEmitter()
+    var profileData = 'some-profile-data'
+    var collectorApi = {
+      sendCpuProfile: this.sandbox.spy()
+    }
+    var profile = {
+      export: function (cb) {
+        cb(null, profileData)
+      },
+      delete: this.sandbox.spy()
+    }
+
+    var startProfilingStub = this.sandbox.stub(v8profiler, 'startProfiling', function () {})
+    var stopProfilingStub = this.sandbox.stub(v8profiler, 'stopProfiling', function () {
+      return profile
+    })
+
+    var now = 1234
+
+    var profiler = CpuProfiler.create({
+      collectorApi: collectorApi,
+      controlBus: msgBus
+    })
+
+    profiler.profileWindow = 0
+
+    this.sandbox.stub(Date, 'now', function () {
+      return now
+    })
+
+    profiler.sendProfile()
+
+    setTimeout(function () {
+      expect(startProfilingStub).to.be.calledWith('trace-cpu-profile', true)
+      expect(stopProfilingStub).to.be.calledWith('trace-cpu-profile')
+      expect(collectorApi.sendCpuProfile).to.be.calledWith({
+        cpuProfile: profileData,
+        time: now
+      })
+      expect(profile.delete).to.be.called
+      done()
+    }, 1)
+
+  })
+})

lib/agent/profiler/index.js

@@ -1 +1,2 @@
 module.exports.memory = require('./memory')
+module.exports.cpu = require('./cpu')

lib/config.js

@@ -15,6 +15,7 @@ config.collectorApiIncomingEdgeMetricsEndpoint = '/service/%s/edge-incoming'
 config.collectorApiExternalEdgeMetricsEndpoint = '/service/%s/edge-external'
 config.collectorApiHealthcheckEndpoint = '/service/%s/healthcheck'
 config.collectorApiProfilerMemoryHeapdumpEndpoint = '/service/%s/memory-heapdump'
+config.collectorApiProfilerCpuProfileEndpoint = '/service/%s/cpu-profile'
 config.collectorApiControlEndpoint = '/service/%s/control'
 
 config.configPath = 'trace.config'

lib/optionalDependencies/v8-profiler.js

@@ -0,0 +1,13 @@
+var v8profiler
+
+try {
+  v8profiler = require('v8-profiler')
+} catch (ex) {
+  console.error('error: [trace]', 'v8-profiler couldn\'t be required, possibly a compiler issue - continuing')
+  v8profiler = {
+    startProfiling: function () {},
+    stopProfiling: function () {}
+  }
+}
+
+module.exports = v8profiler

package.json

@@ -52,7 +52,8 @@
     "node-uuid": "1.4.7",
     "qs": "6.2.0",
     "semver": "5.1.0",
-    "sync-request": "3.0.1"
+    "sync-request": "3.0.1",
+    "v8-profiler": "5.6.5"
   },
   "optionalDependencies": {
     "microtime": "2.1.1",