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.

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

Update Profiling Getting Started for Continuous & UI Profiling #13214

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
53 changes: 36 additions & 17 deletions docs/product/explore/profiling/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,58 @@ sidebar_order: 2
description: "Get started with Profiling, which allows you to see code-level profiling information for your Sentry apps."
---

To set up the profiling integration, use the links for supported SDKs below. Profiling helps you see code-level information about your apps monitored by Sentry.
Continuous Profiling and UI Profiling are the latest iteration of Sentry’s profiling capabilities, but they are currently only supported in select SDKs as described below.

Other platforms are supported via the prior transaction-based Profiling product, but these will not benefit from new capabilities introduced by Continuous and UI Profiling (direct start/stop control over the profile lifecycle and removal of duration limits). For more information on the differences between transaction-based Profiling and Continuous/UI Profiling, read [this documentation](/product/explore/profiling/transaction-vs-continuous-profiling).

If you are currently using transaction-based Profiling and want to migrate to Continuous Profiling or UI Profiling on a supported SDK, read the [migration guide](/product/explore/profiling/continuous-ui-profiling-migration-guide).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is 404ing, is this a piece of content that will be published before this is merged?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'll make sure to merge that before I merge this one


All SDKs that currently support transaction-based Profiling will be migrated over time to support Continuous Profiling and UI Profiling.

## Supported SDKs

### Continuous Profiling

<Alert>

Continuous Profiling can be used both independently and as a complement to the tracing product.

</Alert>

- Standalone and server apps
- [Node.js](/platforms/javascript/guides/node/profiling/#enable-continuous-profiling)
- [Python](/platforms/python/profiling/#enable-continuous-profiling)

### UI Profiling

<Alert>

Profiling depends on Sentry's performance monitoring product being enabled beforehand. To enable performance monitoring in the SDK, check out our [Insights guide](/product/insights/).
UI Profiling can be used both independently and as a complement to the tracing product. Support for Browser JavaScript is coming soon.

</Alert>

### Transaction Profiling
- Mobile
- [Android](/platforms/android/profiling/#continuous-profiling)
- [iOS and macOS](/platforms/apple/guides/ios/profiling/#continuous-profiling)


### Transaction-based Profiling

<Alert>

If Continuous Profiling or UI Profiling are not supported on your SDK, you can fall back to the older transaction-based Profiling implementation for the platforms below.

Transaction-based Profiling requires Sentry's tracing product being enabled beforehand. To enable tracing and performance monitoring features in the SDK, check out our [Insights guide](/product/insights/).

</Alert>

- [Browser JavaScript](/platforms/javascript/profiling/) [beta]
- Mobile
- [Android](/platforms/android/profiling/)
- [iOS and macOS](/platforms/apple/guides/ios/profiling/)
- [React Native](/platforms/react-native/profiling/) [beta]
- [Flutter](/platforms/dart/guides/flutter/profiling/) [experimental, iOS and macOS only]
- [.NET](/platforms/dotnet/guides/maui/profiling/) [experimental, iOS only]
- Standalone and server apps
- [Node.js](/platforms/javascript/guides/node/profiling/)
- [Python](/platforms/python/profiling/)
- [PHP](/platforms/php/profiling/)
- [Ruby](/platforms/ruby/profiling/) [beta]
- [.NET](/platforms/dotnet/profiling/) [experimental]

### Continuous Profiling

<Include name="feature-stage-beta.mdx" />

- Mobile
- [Android](/platforms/android/profiling/#continuous-profiling)
- [iOS and macOS](/platforms/apple/guides/ios/profiling/#continuous-profiling)
- Standalone and server apps
- [Node.js](/platforms/javascript/guides/node/profiling/#enable-continuous-profiling)
- [Python](/platforms/python/profiling/#enable-continuous-profiling)
Loading