Skip to content

Commit dcb8068

Browse files
authored
Improve Profiling changelog entry (#4767)
* Enhance documentation for Sentry continuous profiling Expanded details on Sentry continuous profiling feature, including configuration options and default settings. * Update CHANGELOG.md
1 parent 9023083 commit dcb8068

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,17 @@
66

77
- Add session replay id to Sentry Logs ([#4740](https://github.com/getsentry/sentry-java/pull/4740))
88
- Add support for continuous profiling of JVM applications on macOS and Linux ([#4556](https://github.com/getsentry/sentry-java/pull/4556))
9-
- Sentry continuous profiling on the JVM is using async-profiler under the hood.
9+
- [Sentry continuous profiling](https://docs.sentry.io/product/explore/profiling/) on the JVM is using async-profiler under the hood.
10+
- By default this feature is disabled. Set a profile sample rate and chose a lifecycle (see below) to enable it.
11+
- Add the `sentry-async-profiler` dependency to your project
12+
- Set a sample rate for profiles, e.g. `1.0` to send all of them. You may use `options.setProfileSessionSampleRate(1.0)` in code or `profile-session-sample-rate=1.0` in `sentry.properties`
13+
- Set a profile lifecycle via `options.setProfileLifecycle(ProfileLifecycle.TRACE)` in code or `profile-lifecycle=TRACE` in `sentry.properties`
14+
- By default the lifecycle is set to `MANUAL`, meaning you have to explicitly call `Sentry.startProfiler()` and `Sentry.stopProfiler()`
15+
- You may change it to `TRACE` which will create a profile for each transaction
16+
- To automatically upload Profiles for each transaction in a Spring Boot application
17+
- set `sentry.profile-session-sample-rate=1.0` and `sentry.profile-lifecycle=TRACE` in `application.properties`
18+
- or set `sentry.profile-session-sample-rate: 1.0` and `sentry.profile-lifecycle: TRACE` in `application.yml`
19+
- Profiling can also be combined with our OpenTelemetry integration
1020

1121
### Fixes
1222

0 commit comments

Comments
 (0)