Skip to content
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

chore(Profiling): Add callouts and links to Android Profiling troubleshooting info #11905

Merged
merged 2 commits into from
Nov 26, 2024
Merged

chore(Profiling): Add callouts and links to Android Profiling troubleshooting info #11905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba2e2ff
adds callouts and links to troubleshooting info
kahest Nov 21, 2024
6212308
fix typo, wording
kahest Nov 22, 2024
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
13 changes: 12 additions & 1 deletion docs/platforms/android/index.mdx
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading