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

Clarify Profiling support on Flutter #10869

Merged
merged 5 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions docs/platforms/flutter/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Sentry's Flutter SDK enables automatic reporting of errors and exceptions, and i
- <PlatformLink to="/user-feedback">User Feedback</PlatformLink>, providing the ability to collect user feedback when an unexpected event occurs.
- <PlatformLink to="/enriching-events/screenshots">Screenshot</PlatformLink> and <PlatformLink to="/enriching-events/viewhierarchy">View Hierarchy</PlatformLink> attachments for errors.
- <PlatformLink to="/profiling">Profiling</PlatformLink> collects detailed information about your code at the function level.
- Profiling is currently supported on **iOS** and **macOS**.
- It captures profiles across multiple language layers, including native languages (such as Swift and Objective-C) as well as Dart.
- <PlatformLink to="/data-management/debug-files/source-context">Source Context</PlatformLink> shows snippets of code around the location of stack frames.
- <PlatformLink to="/upload-debug">Sentry Dart Plugin</PlatformLink> makes uploading debug symbols easy and automatic.

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

The profiling feature captures profiles across multiple language layers, including native languages (such as Swift and Objective-C) as well as Dart.

<Note>

Flutter Profiling alpha is available for **iOS** and **macOS** since SDK version `7.12.0`.

</Note>

## Enable Tracing

Profiling depends on Sentry’s Tracing product being enabled beforehand. To enable tracing in the SDK:
Expand All @@ -28,12 +36,6 @@ Check out the <PlatformLink to="/tracing/">tracing setup documentation</Platform

## Enable Profiling

<Note>

Flutter Profiling alpha is available for iOS and macOS since SDK version `7.12.0`.

</Note>

To enable profiling, set the `profilesSampleRate`:

<SignInNote />
Expand Down
Loading