feat: Pass the enableProfiling configuration through to the native SDK

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Feat: Client Reports (#829)
 * Fix: Add missing iOS contexts (#761)
+* Feat: Pass the enableProfiling configuration through to the native SDK (#851)
 
 ### Sentry Self-hosted Compatibility
 

flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt

@@ -132,6 +132,13 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       args.getIfNotNull<Boolean>("anrEnabled") { options.isAnrEnabled = it }
       args.getIfNotNull<Boolean>("sendDefaultPii") { options.isSendDefaultPii = it }
       args.getIfNotNull<Boolean>("enableNdkScopeSync") { options.isEnableScopeSync = it }
+      args.getIfNotNull<Boolean>("enableProfiling") {
+        options.isProfilingEnabled = it
+
+        if (options.isProfilingEnabled) {
+          options.tracesSampleRate = 1.0 // read tracesSampleRate from args which is yet not given
+        }
+      }
 
       val nativeCrashHandling = (args["enableNativeCrashHandling"] as? Boolean) ?: true
       // nativeCrashHandling has priority over anrEnabled

flutter/example/android/app/src/main/AndroidManifest.xml

@@ -42,5 +42,7 @@
         <meta-data
             android:name="flutterEmbedding"
             android:value="2" />
+
+        <meta-data android:name="io.sentry.traces.profiling.enable" android:value="true" />
     </application>
 </manifest>

flutter/example/android/app/src/main/kotlin/io/sentry/samples/flutter/MainActivity.kt

@@ -3,12 +3,16 @@ package io.sentry.samples.flutter
 import io.flutter.embedding.android.FlutterActivity
 import io.flutter.embedding.engine.FlutterEngine
 import io.flutter.plugin.common.MethodChannel
+import io.sentry.ITransaction
 import io.sentry.Sentry
+import io.sentry.SpanStatus
 import kotlin.concurrent.thread
 
 class MainActivity : FlutterActivity() {
   private val _channel = "example.flutter.sentry.io"
 
+  private var transaction: ITransaction? = null
+
   override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
     super.configureFlutterEngine(flutterEngine)
     MethodChannel(flutterEngine.dartExecutor.binaryMessenger, _channel).setMethodCallHandler {
@@ -39,6 +43,12 @@ class MainActivity : FlutterActivity() {
         "platform_exception" -> {
           throw RuntimeException("Catch this platform exception!")
         }
+        "startProfiling" -> {
+          transaction = Sentry.startTransaction("myTransactionWithProfiling", "task")
+        }
+        "stopProfiling" -> {
+          transaction?.finish(SpanStatus.OK)
+        }
         else -> {
           result.notImplemented()
         }

flutter/example/lib/main.dart

@@ -26,6 +26,7 @@ Future<void> main() async {
       options.reportPackages = false;
       options.addInAppInclude('sentry_flutter_example');
       options.considerInAppFramesByDefault = false;
+      options.enableProfiling = true;
     },
     // Init your App.
     appRunner: () => runApp(
@@ -375,6 +376,18 @@ class AndroidExample extends StatelessWidget {
         },
         child: const Text('Platform exception'),
       ),
+      ElevatedButton(
+        onPressed: () async {
+          await execute('startProfiling');
+        },
+        child: const Text('Start native profiling'),
+      ),
+      ElevatedButton(
+        onPressed: () async {
+          await execute('stopProfiling');
+        },
+        child: const Text('Stop native profiling'),
+      ),
     ]);
   }
 }

flutter/ios/Classes/SentryFlutterPluginApple.swift

@@ -262,6 +262,10 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
             options.enableOutOfMemoryTracking = enableOutOfMemoryTracking
         }
 
+        if let enableProfiling = arguments["enableProfiling"] as? Bool {
+            options.enableProfiling = enableProfiling
+        }
+
         if let sendClientReports = arguments["sendClientReports"] as? Bool {
             options.sendClientReports = sendClientReports
         }

flutter/ios/sentry_flutter.podspec

@@ -12,7 +12,7 @@ Sentry SDK for Flutter with support to native through sentry-cocoa.
                          :tag => s.version.to_s }
   s.source_files     = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
-  s.dependency 'Sentry', '~> 7.13.0'
+  s.dependency 'Sentry', '~> 7.14.0'
   s.ios.dependency 'Flutter'
   s.osx.dependency 'FlutterMacOS'
   s.ios.deployment_target = '9.0'

flutter/lib/src/default_integrations.dart

@@ -361,6 +361,7 @@ class NativeSdkIntegration extends Integration<SentryFlutterOptions> {
         'enableOutOfMemoryTracking': options.enableOutOfMemoryTracking,
         'enableNdkScopeSync': options.enableNdkScopeSync,
         'enableAutoPerformanceTracking': options.enableAutoPerformanceTracking,
+        'enableProfiling': options.enableProfiling,
         'sendClientReports': options.sendClientReports,
       });
 

flutter/lib/src/sentry_flutter_options.dart

@@ -171,6 +171,11 @@ class SentryFlutterOptions extends SentryOptions {
   /// [SentryFlutter.setAppStartEnd].
   bool autoAppStart = true;
 
+  /// Enable capturing CPU profiles alongside transactions.
+  /// Only available on iOS and Android. This is currently a beta feature that is
+  /// not available to all Sentry customers.
+  bool enableProfiling = false;
+
   /// By using this, you are disabling native [Breadcrumb] tracking and instead
   /// you are just tracking [Breadcrumb]s which result from events available
   /// in the current Flutter environment.

flutter/test/native_sdk_integration_test.dart

@@ -52,7 +52,8 @@ void main() {
         'enableOutOfMemoryTracking': true,
         'enableNdkScopeSync': false,
         'enableAutoPerformanceTracking': true,
-        'sendClientReports': true
+        'enableProfiling': false,
+        'sendClientReports': true,
       });
     });
 
@@ -85,6 +86,7 @@ void main() {
         ..enableOutOfMemoryTracking = false
         ..enableNdkScopeSync = true
         ..enableAutoPerformanceTracking = false
+        ..enableProfiling = true
         ..sendClientReports = false;
 
       options.sdk.addIntegration('foo');
@@ -121,7 +123,8 @@ void main() {
         'enableOutOfMemoryTracking': false,
         'enableNdkScopeSync': true,
         'enableAutoPerformanceTracking': false,
-        'sendClientReports': false
+        'enableProfiling': true,
+        'sendClientReports': false,
       });
     });