feat: flutter profiling docs

getsentry · Sep 19, 2023 · 752c36f · 752c36f
1 parent aa2c1d3
commit 752c36f
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 5 deletions.
diff --git a/src/docs/product/profiling/getting-started.mdx b/src/docs/product/profiling/getting-started.mdx
@@ -21,6 +21,7 @@ Profiling depends on Sentry's performance monitoring product being enabled befor
 - Mobile
   - [Android](/platforms/android/profiling/)
   - [iOS](/platforms/apple/guides/ios/profiling/)
+  - [Flutter](/platforms/flutter/profiling/) [experimental, iOS and macOS only]
   - [React Native](/platforms/react-native/profiling/) [experimental]
 - Standalone and server apps
   - [Node.js](/platforms/node/profiling/)

diff --git a/src/docs/product/profiling/index.mdx b/src/docs/product/profiling/index.mdx
@@ -12,6 +12,7 @@ description: "Profiling offers a deeper level of visibility on top of traditiona
 
 - [Android (Java and Kotlin only)](/platforms/android/profiling/)
 - [iOS (Swift and Objective-C only)](/platforms/apple/profiling/)
+- [Flutter [experimental, iOS and macOS only]](/platforms/flutter/profiling/)
 - [Python](/platforms/python/profiling/)
 - [Node.js](/platforms/node/profiling/)
 - [PHP (including Laravel and Symfony)](/platforms/php/profiling/)

diff --git a/src/platform-includes/performance/configure-sample-rate/flutter.mdx b/src/platform-includes/performance/configure-sample-rate/flutter.mdx
@@ -6,13 +6,13 @@ import 'package:sentry_flutter/sentry_flutter.dart';
 
 SentryFlutter.init(
   (options) => {
-    options.dsn = '___PUBLIC_DSN___',
+    options.dsn = '___PUBLIC_DSN___';
     // To set a uniform sample rate
-    options.tracesSampleRate = 1.0,
+    options.tracesSampleRate = 1.0;
     // OR if you prefer, determine traces sample rate based on the sampling context
     options.tracesSampler = (samplingContext) {
       // return a number between 0 and 1 or null (to fallback to configured value)
-    },
+    };
   },
   appRunner: () => runApp(MyApp()),
 );

diff --git a/src/platform-includes/performance/traces-sample-rate/flutter.mdx b/src/platform-includes/performance/traces-sample-rate/flutter.mdx
@@ -4,7 +4,7 @@ import 'package:sentry_flutter/sentry_flutter.dart';
 
 SentryFlutter.init(
   (options) => {
-    options.tracesSampleRate = 0.2,
+    options.tracesSampleRate = 0.2;
   },
   appRunner: () => runApp(MyApp()),
 );

diff --git a/src/platforms/common/profiling/index.mdx b/src/platforms/common/profiling/index.mdx
@@ -4,14 +4,14 @@ sidebar_order: 5000
 supported:
   - android
   - apple
+  - flutter
   - go
   - python
   - ruby
   - react-native
 notSupported:
   - unity
   - dart
-  - flutter
   - native
   - javascript
   - javascript.vue
@@ -39,6 +39,16 @@ React Native Profiling is currently in beta. Beta features are still in progress
 
 </PlatformSection>
 
+<PlatformSection supported={["flutter"]}>
+
+<Note>
+
+Flutter Profiling is currently in alpha and only available for iOS and macOS apps. Alpha features are still in progress and may have bugs. We recognize the irony.
+
+</Note>
+
+</PlatformSection>
+
 <PlatformSection supported={["go"]}>
 
 <Note>
@@ -113,6 +123,23 @@ Sentry.init({
 
 </PlatformSection>
 
+<PlatformSection supported={["flutter"]}>
+
+<SignInNote />
+
+```dart
+SentryFlutter.init(
+  (options) => {
+    options.dsn = '___PUBLIC_DSN___';
+    // We recommend adjusting this value in production:
+    options.tracesSampleRate = 1.0;
+  },
+  appRunner: () => runApp(MyApp()),
+);
+```
+
+</PlatformSection>
+
 <PlatformSection supported={["go"]}>
 
 <SignInNote />
@@ -310,6 +337,33 @@ Sentry.init({
 
 </PlatformSection>
 
+<PlatformSection supported={["flutter"]}>
+
+<Note>
+
+Flutter Profiling alpha is available for iOS and macOS since SDK version `7.11.0`.
+
+</Note>
+
+To enable profiling, set the `profilesSampleRate`:
+
+<SignInNote />
+
+```dart
+SentryFlutter.init(
+  (options) => {
+    options.dsn = '___PUBLIC_DSN___';
+    // We recommend adjusting this value in production:
+    options.tracesSampleRate = 1.0;
+    // The sampling rate for profiling is relative to tracesSampleRate:
+    options.profilesSampleRate = 1.0;
+  },
+  appRunner: () => runApp(MyApp()),
+);
+```
+
+</PlatformSection>
+
 <PlatformSection supported={["go"]}>
 
 <Note>

diff --git a/src/platforms/common/profiling/troubleshooting.mdx b/src/platforms/common/profiling/troubleshooting.mdx
@@ -36,6 +36,14 @@ If you don't see any profiling data in [sentry.io](https://sentry.io), you can t
 - 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.
 
+<PlatformSection supported={["flutter"]}>
+
+### Limitations
+
+Profiling is currently available only for iOS and macOS.
+
+</PlatformSection>
+
 <PlatformSection supported={["go"]}>
 
 ### Limitations