chore(node)!: Remove legacy profiling options (profilesSampleRate and profilesSampler) (#23216)

Node profiling now uses only `profileSessionSampleRate` and
`profileLifecycle`. This PR removes all code that belonged to the
previous options.

Updated tests (removed tests for legacy options) and added E2E
assertions (was only checking the build previously).

Browser profiling will be updated in a follow-up PR.


Closes of #23021

Author: s1gr1d

dev-packages/e2e-tests/test-applications/node-profiling-cjs/index.ts

@@ -1,16 +1,44 @@
+import * as assert from 'node:assert/strict';
+import type { Envelope, ProfileChunkEnvelope } from '@sentry/core';
 import * as Sentry from '@sentry/node';
 import { nodeProfilingIntegration } from '@sentry/profiling-node';
 
-const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+const sentEnvelopes: Envelope[] = [];
 
 Sentry.init({
-  traceLifecycle: 'static',
-  dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
+  dsn: 'https://public@example.com/1',
   integrations: [nodeProfilingIntegration()],
-  tracesSampleRate: 1.0,
-  profilesSampleRate: 1.0,
+  tracesSampleRate: 1,
+  profileSessionSampleRate: 1,
+  profileLifecycle: 'trace',
+  transport: () => ({
+    send: envelope => {
+      sentEnvelopes.push(envelope);
+      return Promise.resolve({});
+    },
+    flush: () => Promise.resolve(true),
+  }),
 });
 
-Sentry.startSpan({ name: 'Precompile test' }, async () => {
-  await wait(500);
-});
+async function main(): Promise<void> {
+  await Sentry.startSpan({ name: 'Precompile test' }, async () => {
+    await new Promise(resolve => setTimeout(resolve, 1_000));
+  });
+  await Sentry.flush(2_000);
+
+  const profileChunkEnvelopes = sentEnvelopes.filter(
+    (envelope): envelope is ProfileChunkEnvelope => envelope[1][0]?.[0].type === 'profile_chunk',
+  );
+  assert.equal(profileChunkEnvelopes.length, 1);
+
+  const [header, payload] = profileChunkEnvelopes[0][1][0];
+  assert.deepEqual(header, { type: 'profile_chunk', platform: 'node' });
+  assert.equal(payload.platform, 'node');
+  assert.equal(payload.version, '2');
+  assert.match(payload.profiler_id, /^[a-f0-9]{32}$/);
+  assert.match(payload.chunk_id, /^[a-f0-9]{32}$/);
+  assert.ok(payload.profile.samples.length > 1);
+  assert.ok(payload.profile.stacks.length > 0);
+}
+
+void main();

dev-packages/e2e-tests/test-applications/node-profiling-cjs/package.json

@@ -11,6 +11,7 @@
   },
   "dependencies": {
     "@playwright/test": "~1.56.0",
+    "@sentry/core": "file:../../packed/sentry-core-packed.tgz",
     "@sentry/node": "file:../../packed/sentry-node-packed.tgz",
     "@sentry/profiling-node": "file:../../packed/sentry-profiling-node-packed.tgz",
     "@types/node": "^18.19.1",

dev-packages/e2e-tests/test-applications/node-profiling-esm/index.ts

@@ -1,16 +1,44 @@
+import * as assert from 'node:assert/strict';
+import type { Envelope, ProfileChunkEnvelope } from '@sentry/core';
 import * as Sentry from '@sentry/node';
 import { nodeProfilingIntegration } from '@sentry/profiling-node';
 
-const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
+const sentEnvelopes: Envelope[] = [];
 
 Sentry.init({
-  traceLifecycle: 'static',
-  dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
+  dsn: 'https://public@example.com/1',
   integrations: [nodeProfilingIntegration()],
-  tracesSampleRate: 1.0,
-  profilesSampleRate: 1.0,
+  tracesSampleRate: 1,
+  profileSessionSampleRate: 1,
+  profileLifecycle: 'trace',
+  transport: () => ({
+    send: envelope => {
+      sentEnvelopes.push(envelope);
+      return Promise.resolve({});
+    },
+    flush: () => Promise.resolve(true),
+  }),
 });
 
-Sentry.startSpan({ name: 'Precompile test' }, async () => {
-  await wait(500);
-});
+async function main(): Promise<void> {
+  await Sentry.startSpan({ name: 'Precompile test' }, async () => {
+    await new Promise(resolve => setTimeout(resolve, 1_000));
+  });
+  await Sentry.flush(2_000);
+
+  const profileChunkEnvelopes = sentEnvelopes.filter(
+    (envelope): envelope is ProfileChunkEnvelope => envelope[1][0]?.[0].type === 'profile_chunk',
+  );
+  assert.equal(profileChunkEnvelopes.length, 1);
+
+  const [header, payload] = profileChunkEnvelopes[0][1][0];
+  assert.deepEqual(header, { type: 'profile_chunk', platform: 'node' });
+  assert.equal(payload.platform, 'node');
+  assert.equal(payload.version, '2');
+  assert.match(payload.profiler_id, /^[a-f0-9]{32}$/);
+  assert.match(payload.chunk_id, /^[a-f0-9]{32}$/);
+  assert.ok(payload.profile.samples.length > 1);
+  assert.ok(payload.profile.stacks.length > 0);
+}
+
+void main();

dev-packages/e2e-tests/test-applications/node-profiling-esm/package.json

@@ -11,6 +11,7 @@
   },
   "dependencies": {
     "@playwright/test": "~1.56.0",
+    "@sentry/core": "file:../../packed/sentry-core-packed.tgz",
     "@sentry/node": "file:../../packed/sentry-node-packed.tgz",
     "@sentry/profiling-node": "file:../../packed/sentry-profiling-node-packed.tgz",
     "@types/node": "^18.19.1",

docs/migration/continuous-profiling.md

@@ -22,7 +22,7 @@ We've introduced `profileSessionSampleRate` to control what percentage of SDK in
 - Controlling profiling costs across distributed services
 - Managing profiling in serverless environments where you may only want to profile a subset of instances
 
-### Deprecations
+### Removed Legacy Options
 
-The `profilesSampleRate` option has been deprecated in favor of the new sampling controls.
-The `profilesSampler` option hsa been deprecated in favor of manual profiler control.
+The `profilesSampleRate` option has been removed in favor of the new sampling controls.
+The `profilesSampler` option hsa been removed in favor of manual profiler control.

packages/core/src/profiling.ts

@@ -14,9 +14,10 @@ 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.
+ * Starts a manually controlled Sentry profiling session.
+ *
+ * Profiling starts only when the profiling integration sampled the current session and `profileLifecycle` is set to `manual`.
+ * While running, the profiler periodically sends profile chunks to Sentry until `stopProfiler()` is called.
  */
 function startProfiler(): void {
   const client = getClient();
@@ -41,8 +42,10 @@ function startProfiler(): void {
 }
 
 /**
- * Stops the Sentry continuous profiler.
- * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
+ * Stops a manually controlled Sentry profiling session.
+ *
+ * If a manual profiling session is running, stops the profiler and sends the currently collected profile chunk to Sentry.
+ * Calls are ignored when using the trace lifecycle or when no profiling session is running.
  */
 function stopProfiler(): void {
   const client = getClient();

packages/node/src/types.ts

@@ -1,4 +1,4 @@
-import type { ClientOptions, Options, SamplingContext, Scope, ServerRuntimeOptions } from '@sentry/core';
+import type { ClientOptions, Options, Scope, ServerRuntimeOptions } from '@sentry/core';
 import type { NodeTransportOptions } from './transports';
 
 /**
@@ -37,28 +37,6 @@ export interface BaseNodeOptions extends OpenTelemetryServerRuntimeOptions {
    * @hidden This is primarily used internally to support platforms like Next on OpenNext/Cloudflare.
    */
   runtime?: { name: string; version?: string };
-  /**
-   * Sets profiling sample rate when @sentry/profiling-node is installed
-   *
-   * @deprecated
-   */
-  profilesSampleRate?: number;
-
-  /**
-   * Function to compute profiling sample rate dynamically and filter unwanted profiles.
-   *
-   * Profiling is enabled if either this or `profilesSampleRate` is defined. If both are defined, `profilesSampleRate` is
-   * ignored.
-   *
-   * Will automatically be passed a context object of default and optional custom data.
-   *
-   * @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 for the entire profiling session (evaluated once per SDK initialization).
    *

packages/profiling-node/README.md

@@ -32,20 +32,22 @@ Sentry.init({
   dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
   debug: true,
   tracesSampleRate: 1,
-  profilesSampleRate: 1, // Set profiling sampling rate.
+  profileSessionSampleRate: 1,
+  profileLifecycle: 'trace',
   integrations: [nodeProfilingIntegration()],
 });
 ```
 
-Sentry SDK will now automatically profile all root spans, even the ones which may be started as a result of using an
-automatic instrumentation integration.
+The Sentry SDK will now collect profile chunks while spans are active, including spans started by automatic instrumentation.
 
 ```javascript
 Sentry.startSpan({ name: 'some workflow' }, () => {
   // The code in here will be profiled
 });
 ```
 
+With `profileLifecycle: 'manual'` (the default), you can start and stop the profiler by calling `Sentry.profiler.startProfiler()` and `Sentry.profiler.stopProfiler()`.
+
 ### Building the package from source
 
 Profiling uses native modules to interop with the v8 javascript engine which means that you may be required to build it