Skip to content

Commit

Permalink
Rename performance monitoring to tracing in all platform docs (#10220)
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanie-anderson committed Jun 4, 2024
1 parent e66e1ed commit 9f35518
Show file tree
Hide file tree
Showing 533 changed files with 2,171 additions and 2,194 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/key-terms/key-terms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Each of these key features in [sentry.io](https://sentry.io) is represented by a

- **Issues** - Displays information about grouped problems in your application. From here, you can go to the **Issue Details** page for a more granular view of any issue. Learn more in the full [Issues documentation](/product/issues/).

- **Performance** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [Performance documentation](/product/performance/).
- **Performance** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [Tracing documentation](/product/performance/).

- **Projects** - Lists the projects of which you're a member, by team, and provides you with a high-level overview of your projects. From here, you can go to the **Project Details** page of each project for a more granular view. Learn more in the full [Projects documentation](/product/projects/).

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/approach/product-docs/write-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Use this approach for a feature that doesn’t require much explanation and has

## How: Wider-Ranging Features - Benefit Breakdown

Use this approach for a page that requires more explanation to break down and/or has a lot of child pages to explain its different benefits, like [Performance Monitoring](/product/performance/).
Use this approach for a page that requires more explanation to break down and/or has a lot of child pages to explain its different benefits, like [Tracing](/product/performance/).

- Describe how each page section/element or child page, helps the customer achieve the WHY of this feature.
- Include links to relevant child pages in the text.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/approach/sdk-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ SDKs provide content that focus on 10 sections (two of which are auto-generated)

Provided for customers who need to upgrade from the Raven version of the SDK. Not needed for newer SDKs.

6) **Performance Monitoring** section
6) **Tracing** section

Covers how to enable tracing (for customers who previously only used error monitoring) as enabled by each SDK, as well as subpages on Sampling and Transactions.

Expand Down
2 changes: 1 addition & 1 deletion docs/organization/early-adopter-features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Limitations:
- [Issue Status](/product/issues/states-triage/) tags
- [Issue Reprocessing](/product/issues/reprocessing/)
- [Span Summary](/product/performance/transaction-summary/#span-summary)
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Performance Monitoring
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Tracing
4 changes: 2 additions & 2 deletions docs/platforms/android/configuration/app-not-respond.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 4
description: "Learn how to turn off or specify ANR."
---

Application Not Responding (ANR) errors are triggered when the main UI thread of an application is blocked for more than five seconds. The Android SDK reports ANR errors as Sentry events. In addition, Sentry calculates [ANR rate](/platforms/android/performance/instrumentation/performance-metrics/#application-not-responding-anr-rate) based on these events and user sessions.
Application Not Responding (ANR) errors are triggered when the main UI thread of an application is blocked for more than five seconds. The Android SDK reports ANR errors as Sentry events. In addition, Sentry calculates [ANR rate](/platforms/android/tracing/instrumentation/performance-metrics/#application-not-responding-anr-rate) based on these events and user sessions.

## ANR implementation details

Expand All @@ -13,7 +13,7 @@ The Android SDK uses different implementations to detect ANRs, depending on what
- Below Android 11: Running a Watchdog thread (v1)
- Android 11 and above: Reading [ApplicationExitInfo](https://developer.android.com/reference/android/app/ApplicationExitInfo) (v2)

The new implementation (v2) uses the same data source as Google Play Console. This means the reported ANR events and [ANR rate](/platforms/android/performance/instrumentation/performance-metrics/#application-not-responding-anr-rate) should match with what you see on Sentry. The new implementation also captures a thread dump with additional information, like held locks, to help you resolve ANRs more efficiently.
The new implementation (v2) uses the same data source as Google Play Console. This means the reported ANR events and [ANR rate](/platforms/android/tracing/instrumentation/performance-metrics/#application-not-responding-anr-rate) should match with what you see on Sentry. The new implementation also captures a thread dump with additional information, like held locks, to help you resolve ANRs more efficiently.

While the original Watchdog approach (v1) reports many false positives and is based on heuristics, it still has some advantages over v2, like capturing screenshots and transactions with profiles at the time of ANR.

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/configuration/gradle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ This way potentially heavy operations are automatically measured without the nee

<Note>

For this data to be captured, you must enable [performance monitoring](/platforms/android/performance/).
For this data to be captured, you must enable [tracing](/platforms/android/tracing/).

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/configuration/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ _(New in version 6.0.0)_

<Note>

This only affects [user interaction transactions](/platforms/android/performance/instrumentation/automatic-instrumentation/#user-interaction-instrumentation).
This only affects [user interaction transactions](/platforms/android/tracing/instrumentation/automatic-instrumentation/#user-interaction-instrumentation).

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/configuration/sampling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ When using custom instrumentation to create a transaction, you can add data to t

Whatever a transaction's sampling decision, that decision will be passed to its child spans and from there to any transactions they subsequently cause in other services.

(See <PlatformLink to="/distributed-tracing/">Distributed Tracing</PlatformLink> for more about how that propagation is done.)
(See <PlatformLink to="/tracing/trace-propagation/">Distributed Tracing</PlatformLink> for more about how that propagation is done.)

If the transaction currently being created is one of those subsequent transactions (in other words, if it has a parent transaction), the upstream (parent) sampling decision will be included in the sampling context data. Your <PlatformIdentifier name="traces-sampler" /> can use this information to choose whether to inherit that decision. In most cases, inheritance is the right choice, to avoid breaking distributed traces. A broken trace will not include all your services.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Learn about using the Sentry Kotlin Compiler Plugin."
The [Sentry Kotlin Compiler Plugin](https://github.com/getsentry/sentry-android-gradle-plugin) is an addition to the Sentry Android Gradle plugin and offers improvements to existing SDK features. As of now the main focus of the plugin is to improve apps which utilize Jetpack Compose by automatically tagging `@Composable` functions.

- <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink>
- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#user-interaction-instrumentation">User Interaction Tracing</PlatformLink>
- <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#user-interaction-instrumentation">User Interaction Tracing</PlatformLink>

<Note>

Expand Down Expand Up @@ -59,4 +59,4 @@ plugins {

### Configuration

As of now no additional steps are necessary. Checkout the docs for <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> and <PlatformLink to="/performance/instrumentation/automatic-instrumentation/#user-interaction-instrumentation">User Interaction Tracing</PlatformLink> to see which features the Sentry Kotlin Compiler Plugin improves.
As of now no additional steps are necessary. Checkout the docs for <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> and <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#user-interaction-instrumentation">User Interaction Tracing</PlatformLink> to see which features the Sentry Kotlin Compiler Plugin improves.
2 changes: 1 addition & 1 deletion docs/platforms/android/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Sentry's Android SDK enables automatic reporting of errors and exceptions, and i
- [Release health](/product/releases/health/), tracking crash-free users and sessions.
- [Attachments](/platforms/android/enriching-events/attachments/) that can enrich your event by storing additional files, such as config or log files.
- [User Feedback](/platforms/android/enriching-events/user-feedback/), providing the ability to collect user information when an event occurs.
- [Performance Monitoring](/product/performance/) that can track:
- [Tracing](/product/performance/) that can track:
- Android activity transactions.
- User interaction transactions such as: view click, scroll, swipe, and so on.
- [Navigation transactions](/platforms/android/configuration/integrations/navigation/).
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/integrations/apollo/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ categories:

<Note>

Capturing transactions requires that you first <PlatformLink to="/performance/">set up performance monitoring</PlatformLink> if you haven't already.
Capturing transactions requires that you first <PlatformLink to="/tracing/">set up tracing</PlatformLink> if you haven't already.

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/integrations/apollo3/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ categories:

<Note>

To be able to capture transactions, you'll need to first <PlatformLink to="/performance/">set up performance monitoring</PlatformLink>.
To be able to capture transactions, you'll need to first <PlatformLink to="/tracing/">set up tracing</PlatformLink>.

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/integrations/file-io/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ plugins {

<Note>

Make sure, that [performance monitoring](/platforms/android/performance/#configure-the-sample-rate) is enabled.
Make sure, that [tracing](/platforms/android/tracing/#configure-the-sample-rate) is enabled.

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ With Jetpack Compose performance metrics the Sentry Android SDK can automaticall

This feature requires an underlying transaction to attach it's spans to. Transactions can be created manually or automatically by configuring

- <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">Activity instrumentation</PlatformLink>
- <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/">Activity instrumentation</PlatformLink>
- [Navigation Instrumentation](#jetpack-compose-navigation)
- [User Interactions](#user-interactions)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ dependencies {

<Note>

Make sure, that [performance monitoring](/platforms/android/performance/#configure-the-sample-rate) is enabled.
Make sure, that [tracing](/platforms/android/tracing/#configure-the-sample-rate) is enabled.

</Note>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/metrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Metrics are supported with Sentry Android SDK version `7.6.0` and above.

Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster.

## Enabling the Metrics Feature
## Configure

Here's how to add Metrics to your application:

Expand Down
40 changes: 0 additions & 40 deletions docs/platforms/android/performance/index.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions docs/platforms/android/performance/instrumentation/index.mdx

This file was deleted.

14 changes: 7 additions & 7 deletions docs/platforms/android/profiling/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ sidebar_order: 5000
<PlatformContent includePath="profiling/index/preface" />
<PlatformContent includePath="profiling/index/why-profiling" />

## Enable Performance Monitoring
## Enable Tracing

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

In `AndroidManifest.xml`:

Expand All @@ -20,7 +20,7 @@ In `AndroidManifest.xml`:
</application>
```

Check out the <PlatformLink to="/performance/">performance setup documentation</PlatformLink> for more detailed information on how to configure sampling. Setting the sample rate to 1.0 means all transactions will be captured.
Check out the <PlatformLink to="/tracing/">tracing setup documentation</PlatformLink> for more detailed information on how to configure sampling. Setting the sample rate to 1.0 means all transactions will be captured.

By default, some transactions will be created automatically for common operations like loading a view controller/activity and app startup.

Expand Down Expand Up @@ -54,14 +54,14 @@ The `io.sentry.traces.profiling.sample-rate` setting is _relative_ to the `io.se

## App Start Profiling

When app start profiling is enabled, the whole app start process is profiled.
This includes all methods from any `ContentProvider`, the `Application` class, and the first Activity, until the <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">first automatic Activity transaction</PlatformLink> is finished.
App start profiling can be enabled with the manifest option `io.sentry.traces.profiling.enable-app-start` as shown above, and it will respect the `io.sentry.traces.sample-rate` and the `io.sentry.traces.profiling.sample-rate`.
When app start profiling is enabled, the whole app start process is profiled.
This includes all methods from any `ContentProvider`, the `Application` class, and the first Activity, until the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/">first automatic Activity transaction</PlatformLink> is finished.
App start profiling can be enabled with the manifest option `io.sentry.traces.profiling.enable-app-start` as shown above, and it will respect the `io.sentry.traces.sample-rate` and the `io.sentry.traces.profiling.sample-rate`.
If you prefer to use a <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">sampling function</PlatformLink>, the SDK sets the `isForNextAppStart` field on the `TransactionContext` to specify it will be used for the next app start profiling.

<Note>

The SDK won't run app start profiling the very first time the app runs, as the SDK won't have read the options by the time the profile should run.
The SDK won't run app start profiling the very first time the app runs, as the SDK won't have read the options by the time the profile should run.
The SDK will set the `isForNextAppStart` flag in `TransactionContext` if app start profiling is enabled.

</Note>
6 changes: 3 additions & 3 deletions docs/platforms/android/profiling/troubleshooting/index.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Troubleshooting
description: "Learn how to troubleshoot your profiling setup."
sidebar_order: 5000
sidebar_order: 9000
---

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

- Ensure that performance monitoring <PlatformLink to="/performance/">is enabled</PlatformLink>.
- Ensure that <PlatformLink to="/tracing/">Tracing is enabled</PlatformLink>.
- Ensure that the automatic instrumentation is sending performance data to Sentry by going to the **Performance** page in [sentry.io](https://sentry.io).
- If the automatic instrumentation is not sending performance data, try using <PlatformLink to="/performance/instrumentation/custom-instrumentation">custom instrumentation</PlatformLink>.
- If the automatic instrumentation is not sending performance data, try using <PlatformLink to="/tracing/instrumentation/custom-instrumentation">custom instrumentation</PlatformLink>.
- Enable <PlatformLink to="/configuration/options/#debug">debug mode</PlatformLink> in the SDK and check the logs.
Loading

0 comments on commit 9f35518

Please sign in to comment.