node: implement new continuous profiling API spec

packages/core/src/profiling.ts

@@ -18,6 +18,7 @@ function isProfilingIntegrationWithProfiler(
  * Starts the Sentry continuous profiler.
  * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
  * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
+ * @deprecated Use `startProfileSession()` instead.
  */
 function startProfiler(): void {
   const client = getClient();
@@ -44,6 +45,7 @@ function startProfiler(): void {
 /**
  * Stops the Sentry continuous profiler.
  * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
+ * @deprecated Use `stopProfilerSession()` instead.
  */
 function stopProfiler(): void {
   const client = getClient();
@@ -66,7 +68,57 @@ function stopProfiler(): void {
   integration._profiler.stop();
 }
 
+/**
+ * Starts a new profiler session.
+ */
+function startProfileSession(): void {
+  const client = getClient();
+  if (!client) {
+    DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
+    return;
+  }
+
+  const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
+  if (!integration) {
+    DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
+    return;
+  }
+
+  if (!isProfilingIntegrationWithProfiler(integration)) {
+    DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
+    return;
+  }
+
+  integration._profiler.startProfileSession();
+}
+
+/**
+ * Stops the current profiler session.
+ */
+function stopProfileSession(): void {
+  const client = getClient();
+  if (!client) {
+    DEBUG_BUILD && logger.warn('No Sentry client available, profiling is not started');
+    return;
+  }
+
+  const integration = client.getIntegrationByName<ProfilingIntegration<any>>('ProfilingIntegration');
+  if (!integration) {
+    DEBUG_BUILD && logger.warn('ProfilingIntegration is not available');
+    return;
+  }
+
+  if (!isProfilingIntegrationWithProfiler(integration)) {
+    DEBUG_BUILD && logger.warn('Profiler is not available on profiling integration.');
+    return;
+  }
+
+  integration._profiler.stopProfileSession();
+}
+
 export const profiler: Profiler = {
   startProfiler,
   stopProfiler,
+  startProfileSession,
+  stopProfileSession,
 };

packages/core/src/types-hoist/profiling.ts

@@ -7,15 +7,36 @@ export interface ContinuousProfiler<T extends Client> {
   initialize(client: T): void;
   start(): void;
   stop(): void;
+  startProfileSession(): void;
+  stopProfileSession(): void;
 }
 
 export interface ProfilingIntegration<T extends Client> extends Integration {
   _profiler: ContinuousProfiler<T>;
 }
 
 export interface Profiler {
+  /**
+   * Starts the profiler.
+   * @deprecated Use `startProfileSession()` instead.
+   */
   startProfiler(): void;
+
+  /**
+   * Stops the profiler.
+   * @deprecated Use `stopProfilerSession()` instead.
+   */
   stopProfiler(): void;
+
+  /**
+   * Starts a new profiler session.
+   */
+  startProfileSession(): void;
+
+  /**
+   * Stops the current profiler session.
+   */
+  stopProfileSession(): void;
 }
 
 export type ThreadId = string;

packages/node/src/types.ts

@@ -26,6 +26,8 @@ export interface BaseNodeOptions {
 
   /**
    * Sets profiling sample rate when @sentry/profiling-node is installed
+   *
+   * @deprecated
    */
   profilesSampleRate?: number;
 
@@ -39,9 +41,27 @@ export interface BaseNodeOptions {
    *
    * @returns A sample rate between 0 and 1 (0 drops the profile, 1 guarantees it will be sent). Returning `true` is
    * equivalent to returning 1 and returning `false` is equivalent to returning 0.
+   *
+   * @deprecated
    */
   profilesSampler?: (samplingContext: SamplingContext) => number | boolean;
 
+  /**
+   * Sets profiling session sample rate - only evaluated once per SDK initialization.
+   * @default 0
+   */
+  profileSessionSampleRate?: number;
+
+  /**
+   * Set the lifecycle of the profiler.
+   *
+   * - `manual`: The profiler will be manually started and stopped.
+   * - `trace`: The profiler will be automatically started when when a span is sampled and stopped when there are no more sampled spans.
+   *
+   * @default 'manual'
+   */
+  profileLifecycle?: 'manual' | 'trace';
+
   /** Sets an optional server name (device name) */
   serverName?: string;