Skip to content

Commit dfb0dfd

Browse files
authored
chore: Update Android SDK overhead page (#12123)
* review improvements * update * update
1 parent b58a1ce commit dfb0dfd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/platforms/android/overhead/index.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: SDK Overhead
3-
description: "Learn about Sentry's Android SDK overhead."
3+
description: "Learn about Sentry's Android SDK overhead and how you can tailor your configuration to minimize it."
44
sidebar_order: 7500
55
---
66

@@ -10,7 +10,7 @@ Adding new features or dependencies to your app incurs additional costs on resou
1010

1111
The SDK is designed to have minimal to no impact on user experience. To achieve this, we utilize an array of tools to continuously measure and optimize the performance of our implementations.
1212

13-
We also employ various techniques to ensure we don't add strain on the system's resources along the hot path - on Mobile, this very often means that we offload processing steps, I/O, and other things to a background thread, or we postpone processing to a later time if possible.
13+
We also employ various techniques to ensure we don't add strain on the system's resources along the hot path. On Mobile, this very often means that we offload processing steps, I/O, and other things to a background thread, or we postpone processing to a later time if possible.
1414

1515
If you find (for example via local Profiling, or using Sentry to improve the performance of your app) that the SDK does not operate within the guidelines mentioned below, please [open an issue](https://github.com/getsentry/sentry-java/issues/new/choose) on our SDK repo and make sure you provide as much context as you can.
1616

@@ -22,7 +22,7 @@ The SDK also provides methods to manually capture events: <PlatformLink to="/usa
2222

2323
## Screenshots and View Hierarchy
2424

25-
If you activate these features, the SDK will capture <PlatformLink to="/enriching-events/screenshots">Screenshots</PlatformLink> and <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> of the app's UI at the time of the error crash. This incurs a small overhead that is unnoticeable during normal operation.
25+
If you activate these features, the SDK will capture <PlatformLink to="/enriching-events/screenshots">Screenshots</PlatformLink> and <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> of the app's UI at the time of an error or crash. This incurs a small overhead that is unnoticeable during normal operation.
2626

2727
If your app raises many errors in a tight loop, it can become too much to process quickly enough, and UI jank can be the result, so make sure you handle such cases appropriately. The SDK provides callbacks to fine-tune when to capture <PlatformLink to="/enriching-events/screenshots#customize-screenshot-capturing">Screenshots</PlatformLink> and <PlatformLink to="/enriching-events/viewhierarchy#customize-view-hierarchy-capturing">View Hierarchy</PlatformLink>, which can also be used to reduce performance impact in scenarios where you don't need screenshots or view hierarchies.
2828

@@ -45,3 +45,5 @@ As stated in our <Link to="/product/explore/profiling/performance-overhead">prod
4545
## Session Replay
4646

4747
As stated in our <Link to="/product/explore/session-replay/mobile/performance-overhead">product docs on the topic</Link>, Session Replay adds some overhead, but should have minimal impact on the performance of your application. For more details on the measured overhead, read the <PlatformLink to="/session-replay/performance-overhead/">performance overhead docs for this SDK</PlatformLink>.
48+
49+
Note that this feature is still under development and we're working on optimizing performance.

0 commit comments

Comments
 (0)