Skip to content

Update Android continuous profiling instructions and options #13219

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
stefanosiano merged 9 commits into from
Apr 8, 2025
Merged

Update Android continuous profiling instructions and options #13219

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b706745
updated Android continuous profiling instructions and options
stefanosiano Apr 3, 2025
4659691
updated onboarding ranges
stefanosiano Apr 3, 2025
4d96a6a
added code snippet for java and kotlin in android onboarding
stefanosiano Apr 3, 2025
989bf87
added code snippet for java and kotlin in android onboarding
stefanosiano Apr 3, 2025
f2876d3
removed code snippet for java and kotlin in android getting started
stefanosiano Apr 4, 2025
b7b0d9b
Apply suggestions from code review
stefanosiano Apr 7, 2025
7b00e75
removed start/stop profiler code snippet in verify section of the And…
stefanosiano Apr 7, 2025
8174584
Merge remote-tracking branch 'origin/stefanosiano/android-continuous-…
stefanosiano Apr 7, 2025
7fce377
Added deprecation notes for transaction-based profiling
stefanosiano Apr 7, 2025
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
8 changes: 7 additions & 1 deletion docs/platforms/android/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,12 @@ Set this boolean to `false` to disable tracing for `OPTIONS` requests. This opti

## Profiling Options

<Alert title="Note">

Profiling requires SDK versions 8.7.0 or higher. Lower versions can use the legacy profiling.

</Alert>

<ConfigKey name="profile-session-sample-rate">

A number between `0` and `1`, controlling the percentage chance the session will be profiled. `0` represents 0% while `1` represents 100%. The default is null (disabled).
Expand All @@ -329,7 +335,7 @@ A boolean value that determines whether the app start process will be profiled.

## Legacy Profiling Options

<Alert title="✨ Note">
<Alert title="Note">

SDK versions lower than 8.6.0 may use the legacy profiling using the following options.

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Configuration is done via the application `AndroidManifest.xml`. Here's an examp

Verify that your app is sending events to Sentry by adding the following snippet, which includes an intentional error. You should see the error reported in Sentry within a few minutes.

```java {"onboardingOptions": {"profiling": "9-10", "profiling": "16-17"}}
```java {"onboardingOptions": {"profiling": "9-10, 16-17"}}
import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import java.lang.Exception;
Expand All @@ -118,7 +118,7 @@ public class MyActivity extends AppCompatActivity {
}
```

```kotlin {"onboardingOptions": {"profiling": "8-9", "profiling": "15-16"}}
```kotlin {"onboardingOptions": {"profiling": "8-9, 15-16"}}
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import io.sentry.Sentry
Expand Down