@datadog/pprof 0.2.1 → 0.3.0

package/bindings/profiler.cc

@@ -242,18 +242,21 @@ Local<Value> TranslateTimeProfile(const CpuProfile* profile,
 
 class TimeProfiler : public Nan::ObjectWrap {
  public:
-  static inline Nan::Persistent<v8::Function> & constructor() {
-    static Nan::Persistent<v8::Function> my_constructor;
-    return my_constructor;
+  explicit TimeProfiler(int interval)
+    : samplingInterval(interval) {}
+
+  void Dispose() {
+    if (cpuProfiler != nullptr) {
+      cpuProfiler->Dispose();
+      cpuProfiler = nullptr;
+    }
   }
 
-  explicit TimeProfiler(int interval) {
-    Isolate* isolate = Isolate::GetCurrent();
+  static NAN_METHOD(Dispose) {
+    TimeProfiler* timeProfiler =
+        Nan::ObjectWrap::Unwrap<TimeProfiler>(info.Holder());
 
-    // A new CPU profiler object will be created each time profiling is started
-    // to work around https://bugs.chromium.org/p/v8/issues/detail?id=11051.
-    cpuProfiler = CpuProfiler::New(isolate);
-    cpuProfiler->SetSamplingInterval(interval);
+    timeProfiler->Dispose();
   }
 
   static NAN_METHOD(New) {
@@ -285,10 +288,10 @@ class TimeProfiler : public Nan::ObjectWrap {
     const bool recordSamples = false;
 
     if (includeLines) {
-      cpuProfiler->StartProfiling(name, CpuProfilingMode::kCallerLineNumbers,
-                                  recordSamples);
+      GetProfiler()->StartProfiling(name, CpuProfilingMode::kCallerLineNumbers,
+                                    recordSamples);
     } else {
-      cpuProfiler->StartProfiling(name, recordSamples);
+      GetProfiler()->StartProfiling(name, recordSamples);
     }
   }
 
@@ -316,13 +319,10 @@ class TimeProfiler : public Nan::ObjectWrap {
   }
 
   Local<Value> StopProfiling(Local<String> name, bool includeLines) {
-    CpuProfile* profile = cpuProfiler->StopProfiling(name);
+    CpuProfile* profile = GetProfiler()->StopProfiling(name);
     Local<Value> translated_profile =
         TranslateTimeProfile(profile, includeLines);
     profile->Delete();
-    // Dispose of CPU profiler to work around memory leak.
-    cpuProfiler->Dispose();
-    cpuProfiler = NULL;
     return translated_profile;
   }
 
@@ -357,13 +357,35 @@ class TimeProfiler : public Nan::ObjectWrap {
     tpl->InstanceTemplate()->SetInternalFieldCount(1);
 
     Nan::SetPrototypeMethod(tpl, "start", Start);
+    Nan::SetPrototypeMethod(tpl, "dispose", Dispose);
     Nan::SetPrototypeMethod(tpl, "stop", Stop);
 
     constructor().Reset(Nan::GetFunction(tpl).ToLocalChecked());
     Nan::Set(target, className, Nan::GetFunction(tpl).ToLocalChecked());
   }
  private:
-  CpuProfiler* cpuProfiler;
+  int samplingInterval = 0;
+  CpuProfiler* cpuProfiler = nullptr;
+
+  static inline Nan::Persistent<v8::Function> & constructor() {
+    static Nan::Persistent<v8::Function> my_constructor;
+    return my_constructor;
+  }
+
+  ~TimeProfiler() {
+    Dispose();
+  }
+
+  // A new CPU profiler object will be created each time profiling is started
+  // to work around https://bugs.chromium.org/p/v8/issues/detail?id=11051.
+  CpuProfiler* GetProfiler() {
+    if (cpuProfiler == nullptr) {
+      Isolate* isolate = Isolate::GetCurrent();
+      cpuProfiler = CpuProfiler::New(isolate);
+      cpuProfiler->SetSamplingInterval(samplingInterval);
+    }
+    return cpuProfiler;
+  }
 };
 
 extern "C" NODE_MODULE_EXPORT void

package/out/src/time-profiler.d.ts

@@ -32,5 +32,5 @@ export interface TimeProfilerOptions {
     lineNumbers?: boolean;
 }
 export declare function profile(options: TimeProfilerOptions): Promise<import("../../proto/profile").perftools.profiles.IProfile>;
-export declare function start(intervalMicros?: Microseconds, name?: string, sourceMapper?: SourceMapper, lineNumbers?: boolean): () => import("../../proto/profile").perftools.profiles.IProfile;
+export declare function start(intervalMicros?: Microseconds, name?: string, sourceMapper?: SourceMapper, lineNumbers?: boolean): (restart?: boolean) => import("../../proto/profile").perftools.profiles.IProfile;
 export {};

package/out/src/time-profiler.js

@@ -29,6 +29,7 @@ const delay_1 = require("delay");
 const profile_serializer_1 = require("./profile-serializer");
 const time_profiler_bindings_1 = require("./time-profiler-bindings");
 const DEFAULT_INTERVAL_MICROS = 1000;
+const majorVersion = process.version.slice(1).split('.').map(Number)[0];
 function profile(options) {
     return __awaiter(this, void 0, void 0, function* () {
         const stop = start(options.intervalMicros || DEFAULT_INTERVAL_MICROS, options.name, options.sourceMapper, options.lineNumbers);
@@ -37,30 +38,46 @@ function profile(options) {
     });
 }
 exports.profile = profile;
+function ensureRunName(name) {
+    return name || `pprof-${Date.now()}-${Math.random()}`;
+}
+// NOTE: refreshing doesn't work if giving a profile name.
 function start(intervalMicros = DEFAULT_INTERVAL_MICROS, name, sourceMapper, lineNumbers = true) {
-    const runName = name || `pprof-${Date.now()}-${Math.random()}`;
     const profiler = new time_profiler_bindings_1.TimeProfiler(intervalMicros);
-    profiler.start(runName, lineNumbers);
-    // Node.js contains an undocumented API for reporting idle status to V8.
-    // This lets the profiler distinguish idle time from time spent in native
-    // code. Ideally this should be default behavior. Until then, use the
-    // undocumented API.
-    // See https://github.com/nodejs/node/issues/19009#issuecomment-403161559.
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    if (typeof process._startProfilerIdleNotifier === 'function') {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        process._startProfilerIdleNotifier();
+    let runName = start();
+    return majorVersion < 16 ? stopOld : stop;
+    function start() {
+        const runName = ensureRunName(name);
+        profiler.start(runName, lineNumbers);
+        return runName;
+    }
+    // Node.js versions prior to v16 leak memory if not disposed and recreated
+    // between each profile. As disposing deletes current profile data too,
+    // we must stop then dispose then start.
+    function stopOld(restart = false) {
+        const result = profiler.stop(runName, lineNumbers);
+        profiler.dispose();
+        if (restart) {
+            runName = start();
+        }
+        return profile_serializer_1.serializeTimeProfile(result, intervalMicros, sourceMapper);
     }
-    return function stop() {
+    // For Node.js v16+, we want to start the next profile before we stop the
+    // current one as otherwise the active profile count could reach zero which
+    // means V8 might tear down the symbolizer thread and need to start it again.
+    function stop(restart = false) {
+        let nextRunName;
+        if (restart) {
+            nextRunName = start();
+        }
         const result = profiler.stop(runName, lineNumbers);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        if (typeof process._stopProfilerIdleNotifier === 'function') {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            process._stopProfilerIdleNotifier();
+        if (nextRunName) {
+            runName = nextRunName;
         }
-        const profile = profile_serializer_1.serializeTimeProfile(result, intervalMicros, sourceMapper);
-        return profile;
-    };
+        if (!restart)
+            profiler.dispose();
+        return profile_serializer_1.serializeTimeProfile(result, intervalMicros, sourceMapper);
+    }
 }
 exports.start = start;
 //# sourceMappingURL=time-profiler.js.map

package/out/src/time-profiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"time-profiler.js","sourceRoot":"","sources":["../../ts/src/time-profiler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;AAEH,iCAA0B;AAE1B,6DAA0D;AAE1D,qEAAsD;AAEtD,MAAM,uBAAuB,GAAiB,IAAI,CAAC;AAsBnD,SAAsB,OAAO,CAAC,OAA4B;;QACxD,MAAM,IAAI,GAAG,KAAK,CAChB,OAAO,CAAC,cAAc,IAAI,uBAAuB,EACjD,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,WAAW,CACpB,CAAC;QACF,MAAM,eAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpC,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CAAA;AATD,0BASC;AAED,SAAgB,KAAK,CACnB,iBAA+B,uBAAuB,EACtD,IAAa,EACb,YAA2B,EAC3B,WAAW,GAAG,IAAI;IAElB,MAAM,OAAO,GAAG,IAAI,IAAI,SAAS,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IAC/D,MAAM,QAAQ,GAAG,IAAI,qCAAY,CAAC,cAAc,CAAC,CAAC;IAClD,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrC,wEAAwE;IACxE,yEAAyE;IACzE,qEAAqE;IACrE,oBAAoB;IACpB,0EAA0E;IAC1E,8DAA8D;IAC9D,IAAI,OAAQ,OAAe,CAAC,0BAA0B,KAAK,UAAU,EAAE;QACrE,8DAA8D;QAC7D,OAAe,CAAC,0BAA0B,EAAE,CAAC;KAC/C;IACD,OAAO,SAAS,IAAI;QAClB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACnD,8DAA8D;QAC9D,IAAI,OAAQ,OAAe,CAAC,yBAAyB,KAAK,UAAU,EAAE;YACpE,8DAA8D;YAC7D,OAAe,CAAC,yBAAyB,EAAE,CAAC;SAC9C;QACD,MAAM,OAAO,GAAG,yCAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;QAC3E,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC;AA7BD,sBA6BC"}
+{"version":3,"file":"time-profiler.js","sourceRoot":"","sources":["../../ts/src/time-profiler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;AAEH,iCAA0B;AAE1B,6DAA0D;AAE1D,qEAAsD;AAEtD,MAAM,uBAAuB,GAAiB,IAAI,CAAC;AAEnD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAsBxE,SAAsB,OAAO,CAAC,OAA4B;;QACxD,MAAM,IAAI,GAAG,KAAK,CAChB,OAAO,CAAC,cAAc,IAAI,uBAAuB,EACjD,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,WAAW,CACpB,CAAC;QACF,MAAM,eAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpC,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;CAAA;AATD,0BASC;AAED,SAAS,aAAa,CAAC,IAAa;IAClC,OAAO,IAAI,IAAI,SAAS,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;AACxD,CAAC;AAED,0DAA0D;AAC1D,SAAgB,KAAK,CACnB,iBAA+B,uBAAuB,EACtD,IAAa,EACb,YAA2B,EAC3B,WAAW,GAAG,IAAI;IAElB,MAAM,QAAQ,GAAG,IAAI,qCAAY,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,OAAO,GAAG,KAAK,EAAE,CAAC;IACtB,OAAO,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAE1C,SAAS,KAAK;QACZ,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACrC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,0EAA0E;IAC1E,uEAAuE;IACvE,wCAAwC;IACxC,SAAS,OAAO,CAAC,OAAO,GAAG,KAAK;QAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACnD,QAAQ,CAAC,OAAO,EAAE,CAAC;QACnB,IAAI,OAAO,EAAE;YACX,OAAO,GAAG,KAAK,EAAE,CAAC;SACnB;QACD,OAAO,yCAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;IAED,yEAAyE;IACzE,2EAA2E;IAC3E,6EAA6E;IAC7E,SAAS,IAAI,CAAC,OAAO,GAAG,KAAK;QAC3B,IAAI,WAAW,CAAC;QAChB,IAAI,OAAO,EAAE;YACX,WAAW,GAAG,KAAK,EAAE,CAAC;SACvB;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACnD,IAAI,WAAW,EAAE;YACf,OAAO,GAAG,WAAW,CAAC;SACvB;QACD,IAAI,CAAC,OAAO;YAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACjC,OAAO,yCAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AA3CD,sBA2CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datadog/pprof",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "pprof support for Node.js",
   "repository": "datadog/pprof-nodejs",
   "main": "out/src/index.js",