Skip to content

Commit a69c8e6

Browse files
authored
chore(Profiling): Add callouts and links to Android Profiling troubleshooting info (#11905)
* adds callouts and links to troubleshooting info * fix typo, wording
1 parent 69bd829 commit a69c8e6

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

docs/platforms/android/index.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,21 @@ Select which Sentry features you'd like to install in addition to Error Monitori
3030
options={[
3131
'error-monitoring',
3232
'performance',
33-
'profiling',
33+
{
34+
id: 'profiling',
35+
checked: false
36+
},
3437
]}
3538
/>
3639

40+
<OnboardingOption optionId="profiling">
41+
42+
<Alert level="warning">
43+
Profiling uses the Android runtime's `tracer` under the hood to sample threads. There are known issues that this `tracer` can cause crashes in certain circumstances. See this <PlatformLink to="/profiling/troubleshooting#i-see-elevated-number-of-crashes-in-the-android-runtime-when-profiling-is-activated">troubleshooting</PlatformLink> entry for more information.
44+
</Alert>
45+
46+
</OnboardingOption>
47+
3748
## Install
3849

3950
Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works.

docs/platforms/android/profiling/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ sidebar_order: 5000
77
<PlatformContent includePath="profiling/index/preface" />
88
<PlatformContent includePath="profiling/index/why-profiling" />
99

10+
<Alert level="warning" title="Important">
11+
Profiling uses the Android runtime's `tracer` under the hood to sample threads. There are known issues that this `tracer` can cause crashes in certain circumstances. See this <PlatformLink to="/profiling/troubleshooting#i-see-elevated-number-of-crashes-in-the-android-runtime-when-profiling-is-activated">troubleshooting</PlatformLink> entry for more information.
12+
</Alert>
13+
1014
## Enable Tracing
1115

1216
Profiling depends on Sentry’s Tracing product being enabled beforehand. To enable tracing in the SDK:

docs/platforms/android/profiling/troubleshooting/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ description: "Learn how to troubleshoot your profiling setup."
44
sidebar_order: 9000
55
---
66

7+
## I see elevated number of crashes in the Android Runtime when profiling is activated
8+
9+
Profiling uses the Android runtime's `tracer` under the hood to sample threads. There are known issues that this `tracer` can cause crashes in certain circumstances. Read on for more information, and subscribe to this <Link to="https://github.com/getsentry/sentry-java/issues/3679">GitHub issue</Link> for updates.
10+
11+
As of October 2024, two of these crashes (see <Link to="https://github.com/getsentry/sentry-java/issues/3561#issuecomment-2361054644">1</Link>, <Link to="https://github.com/getsentry/sentry-java/issues/3653">2</Link>) have been acknowledged and fixed by Google. The fixes are being rolled out to affected devices by Google, but the crashing behavior might still be present on devices that didn't receive the fix yet.
12+
13+
There is one <Link to="https://github.com/getsentry/sentry-java/issues/2604">other issue</Link>, where the likely root cause is incorrect native thread handling by app code or third party code. This means that it can also not be fixed in the Sentry SDK. If you experience this, please comment on the <Link to="https://github.com/getsentry/sentry-java/issues/2604">GitHub issue</Link>.
14+
15+
## I don't see any profiling data in [sentry.io](https://sentry.io)
16+
717
If you don't see any profiling data in [sentry.io](https://sentry.io), you can try the following:
818

919
- Ensure that <PlatformLink to="/tracing/">Tracing is enabled</PlatformLink>.

0 commit comments

Comments
 (0)