Add sentry.replay_id to flutter logs (#3257)

Author: denrase

CHANGELOG.md

@@ -11,6 +11,7 @@
 
 - Refactor `AndroidReplayRecorder` to use the new worker isolate api [#3296](https://github.com/getsentry/sentry-dart/pull/3296/)
 - Offload `captureEnvelope` to background isolate for Cocoa and Android [#3232](https://github.com/getsentry/sentry-dart/pull/3232)
+- Add `sentry.replay_id` to flutter logs ([#3257](https://github.com/getsentry/sentry-dart/pull/3257))
 
 ## 9.7.0
 

packages/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterReplayRecorder.kt

@@ -4,6 +4,8 @@ import android.os.Handler
 import android.os.Looper
 import android.util.Log
 import io.flutter.plugin.common.MethodChannel
+import io.sentry.Sentry
+import io.sentry.protocol.SentryId
 import io.sentry.android.replay.Recorder
 import io.sentry.android.replay.ReplayIntegration
 import io.sentry.android.replay.ScreenshotRecorderConfig
@@ -15,10 +17,17 @@ internal class SentryFlutterReplayRecorder(
   override fun start() {
     Handler(Looper.getMainLooper()).post {
       try {
+        val replayId = integration.getReplayId().toString()
+        var replayIsBuffering = false
+        Sentry.configureScope { scope ->
+          // Buffering mode: we have a replay ID but it's not set on scope yet
+          replayIsBuffering = scope.replayId == SentryId.EMPTY_ID
+        }
         channel.invokeMethod(
           "ReplayRecorder.start",
           mapOf(
-            "replayId" to integration.getReplayId().toString(),
+            "replayId" to replayId,
+            "replayIsBuffering" to replayIsBuffering,
           ),
         )
       } catch (ignored: Exception) {

packages/flutter/example/lib/main.dart

@@ -87,7 +87,7 @@ Future<void> setupSentry(
       options.maxRequestBodySize = MaxRequestBodySize.always;
       options.navigatorKey = navigatorKey;
 
-      options.replay.sessionSampleRate = 1.0;
+      options.replay.sessionSampleRate = 0.0;
       options.replay.onErrorSampleRate = 1.0;
 
       options.enableLogs = true;

packages/flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterReplayScreenshotProvider.m

@@ -25,9 +25,15 @@ - (void)imageWithView:(UIView *_Nonnull)view
   // Replay ID may be null if session replay is disabled.
   // Replay is still captured for on-error replays.
   NSString *replayId = [PrivateSentrySDKOnly getReplayId];
+  // On iOS, we only have access to scope's replay ID, so we cannot detect buffer mode
+  // If replay ID exists, it's always in active session mode (not buffering)
+  BOOL replayIsBuffering = NO;
   [self->channel
       invokeMethod:@"captureReplayScreenshot"
-         arguments:@{@"replayId" : replayId ? replayId : [NSNull null]}
+         arguments:@{
+           @"replayId" : replayId ? replayId : [NSNull null],
+           @"replayIsBuffering" : @(replayIsBuffering)
+         }
             result:^(id value) {
               if (value == nil) {
                 NSLog(@"SentryFlutterReplayScreenshotProvider received null "

packages/flutter/lib/src/integrations/replay_log_integration.dart

@@ -0,0 +1,63 @@
+// ignore_for_file: invalid_use_of_internal_member
+
+import 'package:sentry/sentry.dart';
+import '../sentry_flutter_options.dart';
+import '../native/sentry_native_binding.dart';
+
+/// Integration that adds replay-related information to logs using lifecycle callbacks
+class ReplayLogIntegration implements Integration<SentryFlutterOptions> {
+  static const String integrationName = 'ReplayLog';
+
+  final SentryNativeBinding? _native;
+  ReplayLogIntegration(this._native);
+
+  SentryFlutterOptions? _options;
+  SdkLifecycleCallback<OnBeforeCaptureLog>? _addReplayInformation;
+
+  @override
+  Future<void> call(Hub hub, SentryFlutterOptions options) async {
+    if (!options.replay.isEnabled) {
+      return;
+    }
+    final sessionSampleRate = options.replay.sessionSampleRate ?? 0;
+    final onErrorSampleRate = options.replay.onErrorSampleRate ?? 0;
+
+    _options = options;
+    _addReplayInformation = (OnBeforeCaptureLog event) {
+      final scopeReplayId = hub.scope.replayId;
+      final replayId = scopeReplayId ?? _native?.replayId;
+      final replayIsBuffering = replayId != null && scopeReplayId == null;
+
+      if (sessionSampleRate > 0 && replayId != null && !replayIsBuffering) {
+        event.log.attributes['sentry.replay_id'] = SentryLogAttribute.string(
+          scopeReplayId.toString(),
+        );
+      } else if (onErrorSampleRate > 0 &&
+          replayId != null &&
+          replayIsBuffering) {
+        event.log.attributes['sentry.replay_id'] = SentryLogAttribute.string(
+          replayId.toString(),
+        );
+        event.log.attributes['sentry._internal.replay_is_buffering'] =
+            SentryLogAttribute.bool(true);
+      }
+    };
+    options.lifecycleRegistry
+        .registerCallback<OnBeforeCaptureLog>(_addReplayInformation!);
+    options.sdk.addIntegration(integrationName);
+  }
+
+  @override
+  Future<void> close() async {
+    final options = _options;
+    final addReplayInformation = _addReplayInformation;
+
+    if (options != null && addReplayInformation != null) {
+      options.lifecycleRegistry
+          .removeCallback<OnBeforeCaptureLog>(addReplayInformation);
+    }
+
+    _options = null;
+    _addReplayInformation = null;
+  }
+}

packages/flutter/lib/src/native/c/sentry_native.dart

@@ -276,6 +276,9 @@ class SentryNative with SentryNativeSafeInvoker implements SentryNativeBinding {
   @override
   bool get supportsReplay => false;
 
+  @override
+  SentryId? get replayId => null;
+
   @override
   FutureOr<void> setReplayConfig(ReplayConfig config) {
     _logNotSupported('replay config');

packages/flutter/lib/src/native/cocoa/sentry_native_cocoa.dart

@@ -22,6 +22,9 @@ class SentryNativeCocoa extends SentryNativeChannel {
   @override
   bool get supportsReplay => options.platform.isIOS;
 
+  @override
+  SentryId? get replayId => _replayId;
+
   @override
   Future<void> init(Hub hub) async {
     // We only need these when replay is enabled (session or error capture)
@@ -32,15 +35,20 @@ class SentryNativeCocoa extends SentryNativeChannel {
           case 'captureReplayScreenshot':
             _replayRecorder ??= CocoaReplayRecorder(options);
 
-            final replayId = call.arguments['replayId'] == null
+            final replayIdArg = call.arguments['replayId'];
+            final replayIsBuffering =
+                call.arguments['replayIsBuffering'] as bool? ?? false;
+
+            final replayId = replayIdArg == null
                 ? null
-                : SentryId.fromId(call.arguments['replayId'] as String);
+                : SentryId.fromId(replayIdArg as String);
 
             if (_replayId != replayId) {
               _replayId = replayId;
               hub.configureScope((s) {
+                // Only set replay ID on scope if not buffering (active session mode)
                 // ignore: invalid_use_of_internal_member
-                s.replayId = replayId;
+                s.replayId = !replayIsBuffering ? replayId : null;
               });
             }
 
@@ -57,6 +65,13 @@ class SentryNativeCocoa extends SentryNativeChannel {
     return super.init(hub);
   }
 
+  @override
+  FutureOr<SentryId> captureReplay() async {
+    final replayId = await super.captureReplay();
+    _replayId = replayId;
+    return replayId;
+  }
+
   @override
   Future<void> close() async {
     await _envelopeSender?.close();

packages/flutter/lib/src/native/java/sentry_native_java.dart

@@ -22,6 +22,10 @@ class SentryNativeJava extends SentryNativeChannel {
   @override
   bool get supportsReplay => true;
 
+  @override
+  SentryId? get replayId => _replayId;
+  SentryId? _replayId;
+
   @override
   Future<void> init(Hub hub) async {
     // We only need these when replay is enabled (session or error capture)
@@ -30,14 +34,25 @@ class SentryNativeJava extends SentryNativeChannel {
       channel.setMethodCallHandler((call) async {
         switch (call.method) {
           case 'ReplayRecorder.start':
-            final replayId =
-                SentryId.fromId(call.arguments['replayId'] as String);
+            final replayIdArg = call.arguments['replayId'];
+            final replayIsBufferingArg = call.arguments['replayIsBuffering'];
+
+            final replayId = replayIdArg != null
+                ? SentryId.fromId(replayIdArg as String)
+                : null;
+
+            final replayIsBuffering = replayIsBufferingArg != null
+                ? replayIsBufferingArg as bool
+                : false;
+
+            _replayId = replayId;
 
             _replayRecorder = AndroidReplayRecorder.factory(options);
             await _replayRecorder!.start();
             hub.configureScope((s) {
+              // Only set replay ID on scope if not buffering (active session mode)
               // ignore: invalid_use_of_internal_member
-              s.replayId = replayId;
+              s.replayId = !replayIsBuffering ? replayId : null;
             });
             break;
           case 'ReplayRecorder.onConfigurationChanged':
@@ -80,6 +95,13 @@ class SentryNativeJava extends SentryNativeChannel {
     return super.init(hub);
   }
 
+  @override
+  FutureOr<SentryId> captureReplay() async {
+    final replayId = await super.captureReplay();
+    _replayId = replayId;
+    return replayId;
+  }
+
   @override
   FutureOr<void> captureEnvelope(
       Uint8List envelopeData, bool containsUnhandledException) {

packages/flutter/lib/src/native/sentry_native_binding.dart

@@ -64,6 +64,8 @@ abstract class SentryNativeBinding {
 
   bool get supportsReplay;
 
+  SentryId? get replayId;
+
   FutureOr<void> setReplayConfig(ReplayConfig config);
 
   FutureOr<SentryId> captureReplay();

packages/flutter/lib/src/native/sentry_native_channel.dart

@@ -240,6 +240,9 @@ class SentryNativeChannel
   @override
   bool get supportsReplay => false;
 
+  @override
+  SentryId? get replayId => null;
+
   @override
   FutureOr<void> setReplayConfig(ReplayConfig config) =>
       channel.invokeMethod('setReplayConfig', {
@@ -251,7 +254,7 @@ class SentryNativeChannel
       });
 
   @override
-  Future<SentryId> captureReplay() => channel
+  FutureOr<SentryId> captureReplay() => channel
       .invokeMethod('captureReplay')
       .then((value) => SentryId.fromId(value as String));