From 2d44da260d24153bf6e8e026b77904659cda2247 Mon Sep 17 00:00:00 2001 From: Indragie Karunaratne Date: Wed, 2 Apr 2025 15:32:56 -0700 Subject: [PATCH 1/3] Update Profiling Getting Started for Continuous & UI Profiling --- .../explore/profiling/getting-started.mdx | 39 +++++++++++++------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/product/explore/profiling/getting-started.mdx b/docs/product/explore/profiling/getting-started.mdx index 201d9f621a980a..0b2a42cf24a3db 100644 --- a/docs/product/explore/profiling/getting-started.mdx +++ b/docs/product/explore/profiling/getting-started.mdx @@ -4,39 +4,54 @@ 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). + +All SDKs that currently support transaction-based Profiling will be migrated over time to support Continuous Profiling and UI Profiling. ## Supported SDKs +### Transaction-based Profiling + -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/). +Transaction-based Profiling depends on Sentry's tracing product being enabled beforehand. To enable tracing and performance monitoring features in the SDK, check out our [Insights guide](/product/insights/). -### Transaction Profiling - - [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 - + + +Continuous Profiling can be used both independently and as a complement to the tracing product. + + -- 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) + +### UI Profiling + + + +UI Profiling can be used both independently and as a complement to the tracing product. Support for Browser JavaScript is coming soon. + + + +- Mobile + - [Android](/platforms/android/profiling/#continuous-profiling) + - [iOS and macOS](/platforms/apple/guides/ios/profiling/#continuous-profiling) From 5977255a44cfc1942708b41546cc2bd6b5f32317 Mon Sep 17 00:00:00 2001 From: Indragie Karunaratne Date: Thu, 3 Apr 2025 18:37:58 -0700 Subject: [PATCH 2/3] Update docs/product/explore/profiling/getting-started.mdx Co-authored-by: Alex Krawiec --- docs/product/explore/profiling/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product/explore/profiling/getting-started.mdx b/docs/product/explore/profiling/getting-started.mdx index 0b2a42cf24a3db..317be9ea68313c 100644 --- a/docs/product/explore/profiling/getting-started.mdx +++ b/docs/product/explore/profiling/getting-started.mdx @@ -18,7 +18,7 @@ All SDKs that currently support transaction-based Profiling will be migrated ove -Transaction-based Profiling depends on Sentry's tracing product being enabled beforehand. To enable tracing and performance monitoring features in the SDK, check out our [Insights guide](/product/insights/). +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/). From 37227bc1a70d5b78cf8ca4a653784646e652386a Mon Sep 17 00:00:00 2001 From: Indragie Karunaratne Date: Thu, 3 Apr 2025 21:59:25 -0700 Subject: [PATCH 3/3] Address Cody's feedback --- .../explore/profiling/getting-started.mdx | 40 ++++++++++--------- 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/docs/product/explore/profiling/getting-started.mdx b/docs/product/explore/profiling/getting-started.mdx index 317be9ea68313c..30c02752f5d776 100644 --- a/docs/product/explore/profiling/getting-started.mdx +++ b/docs/product/explore/profiling/getting-started.mdx @@ -14,24 +14,6 @@ All SDKs that currently support transaction-based Profiling will be migrated ove ## Supported SDKs -### Transaction-based Profiling - - - -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/). - - - -- [Browser JavaScript](/platforms/javascript/profiling/) [beta] -- Mobile - - [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 - - [PHP](/platforms/php/profiling/) - - [Ruby](/platforms/ruby/profiling/) [beta] - - [.NET](/platforms/dotnet/profiling/) [experimental] - ### Continuous Profiling @@ -55,3 +37,25 @@ UI Profiling can be used both independently and as a complement to the tracing p - Mobile - [Android](/platforms/android/profiling/#continuous-profiling) - [iOS and macOS](/platforms/apple/guides/ios/profiling/#continuous-profiling) + + +### Transaction-based Profiling + + + +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/). + + + +- [Browser JavaScript](/platforms/javascript/profiling/) [beta] +- Mobile + - [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 + - [PHP](/platforms/php/profiling/) + - [Ruby](/platforms/ruby/profiling/) [beta] + - [.NET](/platforms/dotnet/profiling/) [experimental] +