feat: Mobile Vitals - Native Frames

CHANGELOG.md

@@ -1,13 +1,15 @@
 # Changelog
 
-## Unreleased
+# Unreleased
 
 * Feat: Mobile Vitals - Native App Start (#749)
+* Feat: Mobile Vitals - Native Frames (#772)
 
 ## 6.4.0-beta.3
 
 * Feat: Allow to set startTimestamp & endTimestamp manually to SentrySpan (#676)
 * Bump: Sentry-Cocoa to 7.10.0 (#777)
+* Feat: Mobile Vitals - Native App Start (#749)
 * Feat: Additional Dart/Flutter context information (#778)
 * Bump: Kotlin plugin to 1.5.31 (#763)
 * Fix: Missing userId on iOS when userId is not set (#782)

dart/lib/src/hub.dart

@@ -15,6 +15,9 @@ import 'tracing.dart';
 /// Configures the scope through the callback.
 typedef ScopeCallback = void Function(Scope);
 
+/// Called when a transaction is finished.
+typedef OnTransactionFinish = FutureOr<void> Function(ISentrySpan transaction);
+
 /// SDK API contract which combines a client and scope management
 class Hub {
   static SentryClient _getClient(SentryOptions options) {
@@ -347,6 +350,7 @@ class Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       startTransactionWithContext(
@@ -360,6 +364,7 @@ class Hub {
         waitForChildren: waitForChildren,
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd,
+        onFinish: onFinish,
         customSamplingContext: customSamplingContext,
       );
 
@@ -372,6 +377,7 @@ class Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
   }) {
     if (!_isEnabled) {
       _options.logger(
@@ -402,6 +408,7 @@ class Hub {
         waitForChildren: waitForChildren ?? false,
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd ?? false,
+        onFinish: onFinish,
       );
       if (bindToScope ?? false) {
         item.scope.span = tracer;

dart/lib/src/hub_adapter.dart

@@ -113,6 +113,7 @@ class HubAdapter implements Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
   }) =>
       Sentry.startTransactionWithContext(
         transactionContext,
@@ -134,6 +135,7 @@ class HubAdapter implements Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       Sentry.startTransaction(
@@ -145,6 +147,7 @@ class HubAdapter implements Hub {
         waitForChildren: waitForChildren,
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd,
+        onFinish: onFinish,
         customSamplingContext: customSamplingContext,
       );
 

dart/lib/src/noop_hub.dart

@@ -92,6 +92,7 @@ class NoOpHub implements Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       NoOpSentrySpan();
@@ -105,6 +106,7 @@ class NoOpHub implements Hub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
   }) =>
       NoOpSentrySpan();
 

dart/lib/src/protocol/sentry_transaction.dart

@@ -11,7 +11,7 @@ class SentryTransaction extends SentryEvent {
   static const String _type = 'transaction';
   late final List<SentrySpan> spans;
   final SentryTracer _tracer;
-  late final List<SentryMeasurement>? measurements;
+  late final List<SentryMeasurement> measurements;
 
   SentryTransaction(
     this._tracer, {
@@ -56,7 +56,7 @@ class SentryTransaction extends SentryEvent {
 
     final spanContext = _tracer.context;
     spans = _tracer.children;
-    this.measurements = measurements;
+    this.measurements = measurements ?? [];
 
     this.contexts.trace = spanContext.toTraceContext(
       sampled: _tracer.sampled,
@@ -74,11 +74,10 @@ class SentryTransaction extends SentryEvent {
     json['start_timestamp'] =
         formatDateAsIso8601WithMillisPrecision(startTimestamp);
 
-    final ms = measurements;
-    if (ms != null && ms.isNotEmpty) {
+    if (measurements.isNotEmpty) {
       final map = <String, dynamic>{};
-      for (final m in ms) {
-        map[m.name] = m.toJson();
+      for (final measurement in measurements) {
+        map[measurement.name] = measurement.toJson();
       }
       json['measurements'] = map;
     }

dart/lib/src/sentry.dart

@@ -229,6 +229,7 @@ class Sentry {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       _hub.startTransaction(
@@ -240,6 +241,7 @@ class Sentry {
         waitForChildren: waitForChildren,
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd,
+        onFinish: onFinish,
         customSamplingContext: customSamplingContext,
       );
 
@@ -252,6 +254,7 @@ class Sentry {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
   }) =>
       _hub.startTransactionWithContext(
         transactionContext,
@@ -261,6 +264,7 @@ class Sentry {
         waitForChildren: waitForChildren,
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd,
+        onFinish: onFinish,
       );
 
   /// Gets the current active transaction or span.

dart/lib/src/sentry_measurement.dart

@@ -1,6 +1,18 @@
 class SentryMeasurement {
   SentryMeasurement(this.name, this.value);
 
+  /// Amount of frames drawn during a transaction
+  SentryMeasurement.totalFrames(this.value) : name = 'frames_total';
+
+  /// Amount of slow frames drawn during a transaction.
+  /// A slow frame is any frame longer than 1s / refreshrate.
+  /// So for example any frame slower than 16ms for a refresh rate of 60hz.
+  SentryMeasurement.slowFrames(this.value) : name = 'frames_slow';
+
+  /// Amount of frozen frames drawn during a transaction.
+  /// Typically defined as frames slower than 500ms.
+  SentryMeasurement.frozenFrames(this.value) : name = 'frames_frozen';
+
   SentryMeasurement.coldAppStart(Duration duration)
       : assert(!duration.isNegative),
         name = 'app_start_cold',

dart/lib/src/sentry_tracer.dart

@@ -15,8 +15,10 @@ class SentryTracer extends ISentrySpan {
   late final SentrySpan _rootSpan;
   final List<SentrySpan> _children = [];
   final Map<String, dynamic> _extra = {};
+  final List<SentryMeasurement> _measurements = [];
 
   Timer? _autoFinishAfterTimer;
+  Function(SentryTracer)? _onFinish;
   var _finishStatus = SentryTracerFinishStatus.notFinishing();
   late final bool _trimEnd;
 
@@ -33,11 +35,15 @@ class SentryTracer extends ISentrySpan {
   /// [SentryNavigatorObserver] idle transactions, where we finish the
   /// transaction after a given "idle time" and we don't want this "idle time"
   /// to be part of the transaction.
-  SentryTracer(SentryTransactionContext transactionContext, this._hub,
-      {DateTime? startTimestamp,
-      bool waitForChildren = false,
-      Duration? autoFinishAfter,
-      bool trimEnd = false}) {
+  SentryTracer(
+    SentryTransactionContext transactionContext,
+    this._hub, {
+    DateTime? startTimestamp,
+    bool waitForChildren = false,
+    Duration? autoFinishAfter,
+    bool trimEnd = false,
+    Function(SentryTracer)? onFinish,
+  }) {
     _rootSpan = SentrySpan(
       this,
       transactionContext,
@@ -53,6 +59,7 @@ class SentryTracer extends ISentrySpan {
     }
     name = transactionContext.name;
     _trimEnd = trimEnd;
+    _onFinish = onFinish;
   }
 
   @override
@@ -92,6 +99,7 @@ class SentryTracer extends ISentrySpan {
       }
 
       await _rootSpan.finish(endTimestamp: _rootEndTimestamp);
+      await _onFinish?.call(this);
 
       // remove from scope
       _hub.configureScope((scope) {
@@ -101,6 +109,7 @@ class SentryTracer extends ISentrySpan {
       });
 
       final transaction = SentryTransaction(this);
+      transaction.measurements.addAll(_measurements);
       await _hub.captureTransaction(transaction);
     }
   }
@@ -240,6 +249,10 @@ class SentryTracer extends ISentrySpan {
   @override
   SentryTraceHeader toSentryTrace() => _rootSpan.toSentryTrace();
 
+  void addMeasurements(List<SentryMeasurement> measurements) {
+    _measurements.addAll(measurements);
+  }
+
   bool _haveAllChildrenFinished() {
     for (final child in children) {
       if (!child.finished) {

dart/test/default_integrations_test.dart

@@ -239,6 +239,7 @@ class PrintRecursionMockHub extends MockHub {
     bool? waitForChildren,
     Duration? autoFinishAfter,
     bool? trimEnd,
+    OnTransactionFinish? onFinish,
   }) {
     return NoOpSentrySpan();
   }

flutter/android/build.gradle

@@ -54,6 +54,6 @@ android {
 }
 
 dependencies {
-    api 'io.sentry:sentry-android:5.6.1'
+    api 'io.sentry:sentry-android:5.6.3'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
 }