Skip to content

Commit

Permalink
Progress
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanie-anderson committed May 31, 2024
1 parent 9fcbfdf commit 71a9a3d
Show file tree
Hide file tree
Showing 189 changed files with 713 additions and 748 deletions.
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="/performance/">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="/performance/">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/performance/#configure-the-sample-rate) is enabled.

</Note>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Set Up Distributed Tracing
title: Trace Propagation
description: "Learn how to connect events across applications/services."
sidebar_order: 3000
---
Expand Down
16 changes: 7 additions & 9 deletions docs/platforms/android/performance/index.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: Set Up Tracing
description: "Learn how to enable performance monitoring in your app if it is not already set up."
description: "Learn how to enable tracing in your app and discover valuable performance insights of your application."
sidebar_order: 4000
---

With [performance monitoring](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).
With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).

<Note>

If you’re adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.

</Note>

## Configure

First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:
First, enable tracing and configure the sample rate for transactions. Set the sample rate for your transactions by either:

- Setting a uniform sample rate for all transactions using the <PlatformIdentifier name="traces-sample-rate" /> option in your SDK config to a number between `0` and `1`. (For example, to send 20% of transactions, set <PlatformIdentifier name="traces-sample-rate" /> to `0.2`.)
- Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the <PlatformIdentifier name="traces-sampler" /> config option.
Expand All @@ -23,17 +23,15 @@ The two options are meant to be mutually exclusive. If you set both, <PlatformId

<PlatformContent includePath="performance/configure-sample-rate" />

Learn more about performance monitoring <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">tracesSampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.
Learn more about tracing <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">tracesSampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.

## Verify

Verify that performance monitoring is working correctly by using our <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">automatic instrumentation</PlatformLink> or by starting and finishing a transaction using <PlatformLink to="/performance/instrumentation/custom-instrumentation/">custom instrumentation</PlatformLink>.
Verify that tracing is working correctly by using our <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">automatic instrumentation</PlatformLink> or by starting and finishing a transaction using <PlatformLink to="/performance/instrumentation/custom-instrumentation/">custom instrumentation</PlatformLink>.

Test out tracing by starting and finishing a transaction, which you _must_ do so transactions can be sent to Sentry. Learn how in our <PlatformLink to="/performance/instrumentation/custom-instrumentation/">Custom Instrumentation</PlatformLink> content.

While you're testing, set <PlatformIdentifier name="traces-sample-rate" /> to `1.0`, as that ensures that every transaction will be sent to Sentry.

Once testing is complete, you may want to set a lower <PlatformIdentifier name="traces-sample-rate" /> value, or switch to using <PlatformIdentifier name="traces-sampler" /> to selectively sample and filter your transactions, based on contextual data.
While you're testing, set <PlatformIdentifier name="traces-sample-rate" /> to `1.0`, as that ensures that every transaction will be sent to Sentry. Once testing is complete, you may want to set a lower <PlatformIdentifier name="traces-sample-rate" /> value, or switch to using <PlatformIdentifier name="traces-sampler" /> to selectively sample and filter your transactions, based on contextual data.

## Next Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Learn what transactions are captured after tracing is enabled."

<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="/performance/">set up tracing</PlatformLink> if you haven't already.

Supported in Sentry's Android SDK version `4.3.0` and above.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Learn how to capture performance data on any action in your app."

<Note>

To capture transactions and spans customized to your organization's needs, you must first <PlatformLink to="/performance/">set up performance monitoring.</PlatformLink>
To capture transactions and spans customized to your organization's needs, you must first <PlatformLink to="/performance/">set up tracing.</PlatformLink>

</Note>

Expand Down
4 changes: 1 addition & 3 deletions docs/platforms/android/performance/instrumentation/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: Instrumentation
sidebar_order: 20
description: "Learn how to instrument performance in your app."
description: "Learn how to instrument tracing in your app."
---

Instrumenting performance monitoring is specific to your SDK.

<PageGrid />
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="/performance/">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="/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`.
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>
4 changes: 2 additions & 2 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="/performance/">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>.
- Enable <PlatformLink to="/configuration/options/#debug">debug mode</PlatformLink> in the SDK and check the logs.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Set Up Distributed Tracing
title: Trace Propagation
description: "Learn how to connect events across applications/services."
sidebar_order: 3000
---
Expand Down
14 changes: 6 additions & 8 deletions docs/platforms/apple/common/performance/index.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Set Up Tracing
description: "Learn how to enable performance monitoring in your app if it is not already set up."
description: "Learn how to enable tracing in your app and discover valuable performance insights of your application."
sidebar_order: 4000
---

With [performance monitoring](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).
With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).

Automatic instrumentation for monitoring the performance of your application is currently in preview. You can also use custom instrumentation to capture transactions.

## Configure

First, enable tracing and configure the sampling rate for transactions. Set the sample rate for your transactions by either:
First, enable tracing and configure the sample rate for transactions. Set the sample rate for your transactions by either:

- Setting a uniform sample rate for all transactions using the <PlatformIdentifier name="traces-sample-rate" /> option in your SDK config to a number between `0` and `1`. (For example, to send 20% of transactions, set <PlatformIdentifier name="traces-sample-rate" /> to `0.2`.)
- Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the <PlatformIdentifier name="traces-sampler" /> config option.
Expand All @@ -19,17 +19,15 @@ The two options are meant to be mutually exclusive. If you set both, <PlatformId

<PlatformContent includePath="performance/configure-sample-rate" />

Learn more about performance monitoring <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">tracesSampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.
Learn more about tracing <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">tracesSampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.

## Verify

Verify that performance monitoring is working correctly by using our <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">automatic instrumentation</PlatformLink> or by starting and finishing a transaction using <PlatformLink to="/performance/instrumentation/custom-instrumentation/">custom instrumentation</PlatformLink>.
Verify that tracing is working correctly by using our <PlatformLink to="/performance/instrumentation/automatic-instrumentation/">automatic instrumentation</PlatformLink> or by starting and finishing a transaction using <PlatformLink to="/performance/instrumentation/custom-instrumentation/">custom instrumentation</PlatformLink>.

Test out tracing by starting and finishing a transaction, which you _must_ do so transactions can be sent to Sentry. Learn how in our <PlatformLink to="/performance/instrumentation/custom-instrumentation/">Custom Instrumentation</PlatformLink> content.

While you're testing, set <PlatformIdentifier name="traces-sample-rate" /> to `1.0`, as that ensures that every transaction will be sent to Sentry.

Once testing is complete, you may want to set a lower <PlatformIdentifier name="traces-sample-rate" /> value, or switch to using <PlatformIdentifier name="traces-sampler" /> to selectively sample and filter your transactions, based on contextual data.
While you're testing, set <PlatformIdentifier name="traces-sample-rate" /> to `1.0`, as that ensures that every transaction will be sent to Sentry. Once testing is complete, you may want to set a lower <PlatformIdentifier name="traces-sample-rate" /> value, or switch to using <PlatformIdentifier name="traces-sampler" /> to selectively sample and filter your transactions, based on contextual data.

## Next Steps

Expand Down
Loading

0 comments on commit 71a9a3d

Please sign in to comment.