Adapt to API changes in pprof-nodejs

Author: nsavoire

package.json

@@ -70,7 +70,7 @@
     "@datadog/native-iast-rewriter": "2.0.1",
     "@datadog/native-iast-taint-tracking": "^1.5.0",
     "@datadog/native-metrics": "^2.0.0",
-    "@datadog/pprof": "2.2.3",
+    "@datadog/pprof": "3.0.0",
     "@datadog/sketches-js": "^2.1.0",
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/core": "^1.14.0",

packages/dd-trace/src/profiling/profilers/wall.js

@@ -3,12 +3,19 @@
 class NativeWallProfiler {
   constructor (options = {}) {
     this.type = 'wall'
-    this._samplingInterval = options.samplingInterval || 1e6 / 99 // 99hz
+    this._samplingIntervalMicros = options.samplingInterval || 1e6 / 99 // 99hz
+    this._flushIntervalMillis = options.flushInterval || 60 * 1e3 // 60 seconds
+    this._codeHotspotsEnabled = !!options.codeHotspotsEnabled
     this._mapper = undefined
     this._pprof = undefined
+
+    this._logger = options.logger
+    this._started = false
   }
 
   start ({ mapper } = {}) {
+    if (this._started) return
+
     this._mapper = mapper
     this._pprof = require('@datadog/pprof')
 
@@ -20,27 +27,31 @@ class NativeWallProfiler {
       process._stopProfilerIdleNotifier = () => {}
     }
 
-    this._record()
+    this._pprof.time.start({
+      intervalMicros: this._samplingIntervalMicros,
+      durationMillis: this._flushIntervalMillis,
+      sourceMapper: this._mapper,
+      customLabels: this._codeHotspotsEnabled,
+      lineNumbers: false })
+
+    this._started = true
   }
 
   profile () {
-    if (!this._stop) return
-    return this._stop(true)
+    if (!this._started) return
+    return this._pprof.time.stop(true)
   }
 
   encode (profile) {
     return this._pprof.encode(profile)
   }
 
   stop () {
-    if (!this._stop) return
-    this._stop()
-    this._stop = undefined
-  }
+    if (!this._started) return
 
-  _record () {
-    this._stop = this._pprof.time.start(this._samplingInterval, null,
-      this._mapper, false)
+    const profile = this._pprof.time.stop()
+    this._started = false
+    return profile
   }
 }
 

packages/dd-trace/test/profiling/profilers/wall.spec.js

@@ -9,14 +9,13 @@ const sinon = require('sinon')
 describe('profilers/native/wall', () => {
   let NativeWallProfiler
   let pprof
-  let stop
 
   beforeEach(() => {
-    stop = sinon.stub().returns('profile')
     pprof = {
       encode: sinon.stub().returns(Promise.resolve()),
       time: {
-        start: sinon.stub().returns(stop)
+        start: sinon.stub(),
+        stop: sinon.stub().returns('profile')
       }
     }
 
@@ -45,24 +44,35 @@ describe('profilers/native/wall', () => {
     process._stopProfilerIdleNotifier = stop
 
     sinon.assert.calledOnce(pprof.time.start)
-    sinon.assert.calledWith(pprof.time.start, 1e6 / 99)
+    sinon.assert.calledWith(pprof.time.start,
+      { intervalMicros: 1e6 / 99,
+        durationMillis: 60000,
+        sourceMapper: undefined,
+        customLabels: false,
+        lineNumbers: false })
   })
 
   it('should use the provided configuration options', () => {
     const samplingInterval = 500
     const profiler = new NativeWallProfiler({ samplingInterval })
 
     profiler.start()
+    profiler.stop()
 
-    sinon.assert.calledWith(pprof.time.start, samplingInterval)
+    sinon.assert.calledWith(pprof.time.start,
+      { intervalMicros: 500,
+        durationMillis: 60000,
+        sourceMapper: undefined,
+        customLabels: false,
+        lineNumbers: false })
   })
 
   it('should not stop when not started', () => {
     const profiler = new NativeWallProfiler()
 
     profiler.stop()
 
-    sinon.assert.notCalled(stop)
+    sinon.assert.notCalled(pprof.time.stop)
   })
 
   it('should stop the internal time profiler', () => {
@@ -71,7 +81,7 @@ describe('profilers/native/wall', () => {
     profiler.start()
     profiler.stop()
 
-    sinon.assert.calledOnce(stop)
+    sinon.assert.calledOnce(pprof.time.stop)
   })
 
   it('should stop the internal time profiler only once', () => {
@@ -81,7 +91,7 @@ describe('profilers/native/wall', () => {
     profiler.stop()
     profiler.stop()
 
-    sinon.assert.calledOnce(stop)
+    sinon.assert.calledOnce(pprof.time.stop)
   })
 
   it('should collect profiles from the internal time profiler', () => {
@@ -93,8 +103,9 @@ describe('profilers/native/wall', () => {
 
     expect(profile).to.equal('profile')
 
-    sinon.assert.calledOnce(stop)
+    sinon.assert.calledOnce(pprof.time.stop)
     sinon.assert.calledOnce(pprof.time.start)
+    profiler.stop()
   })
 
   it('should encode profiles from the pprof time profiler', () => {
@@ -106,6 +117,8 @@ describe('profilers/native/wall', () => {
 
     profiler.encode(profile)
 
+    profiler.stop()
+
     sinon.assert.calledOnce(pprof.encode)
   })
 
@@ -115,7 +128,13 @@ describe('profilers/native/wall', () => {
     const mapper = {}
 
     profiler.start({ mapper })
+    profiler.stop()
 
-    sinon.assert.calledWith(pprof.time.start, 1e6 / 99, null, mapper, false)
+    sinon.assert.calledWith(pprof.time.start,
+      { intervalMicros: 1e6 / 99,
+        durationMillis: 60000,
+        sourceMapper: mapper,
+        customLabels: false,
+        lineNumbers: false })
   })
 })