Skip to content

docs(javascript): Describe trace profiling lifecycle using spans #19917

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

Merged
nicohrubec merged 3 commits into from
Oct 12, 2026
Merged

docs(javascript): Describe trace profiling lifecycle using spans #19917

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5830a58
docs(javascript): Describe trace profiling lifecycle using spans
nicohrubec Oct 12, 2026
28a0581
Update docs/platforms/javascript/common/configuration/options.mdx
nicohrubec Oct 12, 2026
97bfbca
chore: Retrigger CI
nicohrubec Oct 12, 2026
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
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@ This option is required to enable profiling (default is `0`).
Determines how profiling sessions are controlled. It has two modes:

- `'manual'` (default): You control when profiling starts and stops using the `startProfiler()` and `stopProfiler()` functions. In this mode, profile sampling is only affected by `profileSessionSampleRate`.<PlatformSection notSupported={["javascript.bun", "javascript.capacitor", "javascript.deno", "javascript.cloudflare"]}> Read more about these functions in the <PlatformLink to="/profiling/">profiling API documentation</PlatformLink>.</PlatformSection>
- `'trace'`: Profiling starts and stops automatically with transactions, as long as tracing is enabled. The profiler runs as long as there is at least one sampled transaction. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`).
- `'trace'`: Profiling starts and stops automatically with root spans, as long as tracing is enabled. The profiler runs while there is at least one active, sampled root span, up to a maximum of 5 minutes per root span. In this mode, profiling is affected by both `profileSessionSampleRate` and your tracing sample rate (`tracesSampleRate` or `tracesSampler`).

</SdkOption>

Expand Down
Loading