fix(profiling): use the same v8-profiler module for memory (#49)

Author: gergelyke

lib/agent/profiler/cpu/index.js

@@ -2,7 +2,6 @@ var debug = require('debug')('risingstack/trace')
 
 var v8profiler = require('../../../optionalDependencies/v8-profiler')
 
-
 function CpuProfiler (options) {
   var _this = this
   this.collectorApi = options.collectorApi
@@ -23,7 +22,7 @@ CpuProfiler.prototype.sendProfile = 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) {
+    profile && profile.export(function (err, result) {
       if (err) {
         return debug(err)
       }
@@ -33,7 +32,7 @@ CpuProfiler.prototype.sendProfile = function () {
         time: Date.now()
       })
       profile.delete()
-    });
+    })
   }, this.profileWindow)
 }
 

lib/agent/profiler/memory/index.js

@@ -1,9 +1,6 @@
-var os = require('os')
-var fs = require('fs')
-
 var debug = require('debug')('risingstack/trace')
 
-var heapdump = require('../../../optionalDependencies/heapdump')
+var v8profiler = require('../../../optionalDependencies/v8-profiler')
 
 function MemoryProfiler (options) {
   var _this = this
@@ -17,25 +14,20 @@ function MemoryProfiler (options) {
 
 MemoryProfiler.prototype.sendSnapshot = function () {
   var _this = this
-  var tempdir = os.tmpdir()
   var now = Date.now()
-  var heapSnapshotName = now + '.heapsnapshot'
-  var snapshotPath = tempdir + '/' + heapSnapshotName
-  heapdump.writeSnapshot(snapshotPath, function (err) {
-    if (err) {
-      return debug('Error writing the heapsnapshot', err)
-    }
+  var snapshot = v8profiler.takeSnapshot()
 
-    fs.readFile(snapshotPath, 'utf-8', function (err, data) {
-      if (err) {
-        return debug('Error reading the heapsnapshot', err)
-      }
+  snapshot && snapshot.export(function (error, result) {
+    if (error) {
+      return debug(error)
+    }
 
-      _this.collectorApi.sendMemorySnapshot({
-        heapSnapshot: data,
-        time: now
-      })
+    _this.collectorApi.sendMemorySnapshot({
+      heapSnapshot: result,
+      time: now
     })
+
+    snapshot.delete()
   })
 }
 

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

@@ -1,9 +1,7 @@
 var expect = require('chai').expect
-var os = require('os')
-var fs = require('fs')
 var EventEmitter = require('events').EventEmitter
 
-var heapdump = require('../../../optionalDependencies/heapdump')
+var v8profiler = require('../../../optionalDependencies/v8-profiler')
 
 var MemoryProfiler = require('./')
 
@@ -13,32 +11,34 @@ describe('The Memory Profiler module', function () {
     var collectorApi = {
       sendMemorySnapshot: this.sandbox.spy()
     }
-
-    var snapShotContent = 'very-snapshot'
+    var deleteSnapshotSpy = this.sandbox.spy()
+    var snapshotContent = 'snapshot'
     var now = 1234
 
     var profiler = MemoryProfiler.create({
       collectorApi: collectorApi,
       controlBus: msgBus
     })
 
-    this.sandbox.stub(heapdump, 'writeSnapshot', function (path, cb) {
-      cb()
+    this.sandbox.stub(v8profiler, 'takeSnapshot', function () {
+      return {
+        export: function (cb) {
+          cb(null, snapshotContent)
+        },
+        delete: deleteSnapshotSpy
+      }
     })
 
     this.sandbox.stub(Date, 'now', function () {
       return now
     })
 
-    this.sandbox.stub(fs, 'readFile', function (path, encoding, cb) {
-      cb(null, snapShotContent)
-    })
-
     profiler.sendSnapshot()
 
     expect(collectorApi.sendMemorySnapshot).to.be.calledWith({
-      heapSnapshot: snapShotContent,
+      heapSnapshot: snapshotContent,
       time: now
     })
+    expect(deleteSnapshotSpy).to.be.called
   })
 })

lib/optionalDependencies/heapdump.js

@@ -6,7 +6,8 @@ try {
   console.error('error: [trace]', 'v8-profiler couldn\'t be required, possibly a compiler issue - continuing')
   v8profiler = {
     startProfiling: function () {},
-    stopProfiling: function () {}
+    stopProfiling: function () {},
+    takeSnapshot: function () {}
   }
 }
 

lib/optionalDependencies/v8-profiler.js

@@ -57,7 +57,6 @@
   "optionalDependencies": {
     "microtime": "2.1.1",
     "event-loop-stats": "1.0.0",
-    "heapdump": "0.3.7",
     "gc-stats": "1.0.0",
     "v8-profiler": "5.6.5"
   },