Skip to content

docs(js): Replace legacy profiling options with session-based API #19427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
chargome wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −20
Draft

docs(js): Replace legacy profiling options with session-based API #19427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions docs/platforms/javascript/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -858,14 +858,6 @@ Determines how profiling sessions are controlled. It has two modes:

</SdkOption>

<SdkOption name="profilesSampleRate" type='number'>

**Deprecated:** Use `profileSessionSampleRate` instead to configure continuous profiling from version `7.4.0` onwards.

A number between `0` and `1`, controlling the percentage chance a given sampled transaction will be profiled. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled.

</SdkOption>

</PlatformSection>

<PlatformSection notSupported={["javascript.electron"]}>
Expand Down Expand Up @@ -897,14 +889,6 @@ Determines how profiling sessions are controlled. It has two modes:

</SdkOption>

<SdkOption name="profilesSampleRate" type='number'>

**Deprecated:** Use `profileSessionSampleRate` instead to configure continuous profiling from version 10.27.0 onwards.

A number between `0` and `1`, controlling the percentage chance a given sampled transaction will be profiled. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled.

</SdkOption>

</PlatformSection>

<PlatformSection supported={["javascript.cordova", "javascript.capacitor"]}>
Expand Down
19 changes: 16 additions & 3 deletions docs/platforms/javascript/guides/firebase/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,20 @@ Create an initialization file (for example, `instrument.js`) that imports and in

```javascript {filename:instrument.js}
const Sentry = require("@sentry/node");
// ___PRODUCT_OPTION_START___ profiling
const { nodeProfilingIntegration } = require("@sentry/profiling-node");
// ___PRODUCT_OPTION_END___ profiling

Sentry.init({
dsn: "___PUBLIC_DSN___",

// ___PRODUCT_OPTION_START___ profiling

integrations: [
// Add our Profiling integration
nodeProfilingIntegration(),
],
// ___PRODUCT_OPTION_END___ profiling
// ___PRODUCT_OPTION_START___ performance

// Add Tracing by setting tracesSampleRate
Expand All @@ -112,9 +122,12 @@ Sentry.init({
// ___PRODUCT_OPTION_END___ performance
// ___PRODUCT_OPTION_START___ profiling

// Set profilesSampleRate to 1.0 to profile 100% of sampled transactions.
// This is relative to tracesSampleRate
profilesSampleRate: 1.0,
// Enable profiling for a percentage of sessions
// Learn more at
// https://docs.sentry.io/platforms/javascript/configuration/options/#profileSessionSampleRate
profileSessionSampleRate: 1.0,
// Profile automatically while there's an active sampled span
profileLifecycle: "trace",
// ___PRODUCT_OPTION_END___ profiling
});
```
Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/javascript/guides/hono/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,12 @@ Sentry.init({
// ___PRODUCT_OPTION_END___ performance
// ___PRODUCT_OPTION_START___ profiling

// Set profilesSampleRate relative to tracesSampleRate
// Enable profiling for a percentage of sessions
// Learn more at
// https://docs.sentry.io/platforms/javascript/configuration/options/#profileSessionSampleRate
profileSessionSampleRate: 1.0,
// Profile automatically while there's an active sampled span
profileLifecycle: "trace",
// ___PRODUCT_OPTION_END___ profiling
});
```
Expand Down
Loading