Skip to content

Commit

Permalink
chore(Profiling): Add callouts and links to Android Profiling trouble…
Browse files Browse the repository at this point in the history
…shooting info (#11905)

* adds callouts and links to troubleshooting info

* fix typo, wording
  • Loading branch information
kahest authored Nov 26, 2024
1 parent 69bd829 commit a69c8e6
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/platforms/android/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,21 @@ Select which Sentry features you'd like to install in addition to Error Monitori
options={[
'error-monitoring',
'performance',
'profiling',
{
id: 'profiling',
checked: false
},
]}
/>

<OnboardingOption optionId="profiling">

<Alert level="warning">
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.
</Alert>

</OnboardingOption>

## Install

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.
Expand Down
4 changes: 4 additions & 0 deletions docs/platforms/android/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ sidebar_order: 5000
<PlatformContent includePath="profiling/index/preface" />
<PlatformContent includePath="profiling/index/why-profiling" />

<Alert level="warning" title="Important">
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.
</Alert>

## Enable Tracing

Profiling depends on Sentry’s Tracing product being enabled beforehand. To enable tracing in the SDK:
Expand Down
10 changes: 10 additions & 0 deletions docs/platforms/android/profiling/troubleshooting/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ description: "Learn how to troubleshoot your profiling setup."
sidebar_order: 9000
---

## I see elevated number of crashes in the Android Runtime when profiling is activated

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.

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.

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>.

## I don't see any profiling data in [sentry.io](https://sentry.io)

If you don't see any profiling data in [sentry.io](https://sentry.io), you can try the following:

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

0 comments on commit a69c8e6

Please sign in to comment.