feat: add span level measurements #1855

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
 ## 8.6.0
 
 ### Improvements
 
+- Add support for span level measurements. ([#1855](https://github.com/getsentry/sentry-dart/issues/1855))
 - Add error type identifier to improve obfuscated Flutter issue titles ([#2170](https://github.com/getsentry/sentry-dart/pull/2170))
  - Example: transforms issue titles from `GA` to `FlutterError` or `minified:nE` to `FlutterError`
  - This is enabled automatically and will change grouping if you already have issues with obfuscated titles

dart/lib/src/noop_sentry_span.dart

@@ -99,4 +99,8 @@ class NoOpSentrySpan extends ISentrySpan {
 
  @override
  LocalMetricsAggregator? get localMetricsAggregator => null;
+
+ @override
+ // TODO: implement measurements
+ Map<String, SentryMeasurement> get measurements => throw UnimplementedError();
 }

dart/lib/src/protocol/sentry_span.dart

@@ -26,6 +26,7 @@ class SentrySpan extends ISentrySpan {
  final SentryTracer _tracer;
 
  final Map<String, dynamic> _data = {};
+ final Map<String, SentryMeasurement> _measurements = {};
  dynamic _throwable;
 
  SpanStatus? _status;
@@ -228,6 +229,8 @@ class SentrySpan extends ISentrySpan {
  Map<String, String> get tags => _tags;
 
  Map<String, dynamic> get data => _data;
+ @override
+ Map<String, SentryMeasurement> get measurements => _measurements;
 
  @override
  SentryTraceHeader toSentryTrace() => SentryTraceHeader(
@@ -242,7 +245,17 @@ class SentrySpan extends ISentrySpan {
  num value, {
  SentryMeasurementUnit? unit,
  }) {
- _tracer.setMeasurement(name, value, unit: unit);
+ if (finished) {
+ _hub.options.logger(SentryLevel.debug,
+ "The span is already finished. Measurement $name cannot be set");
+ return;
+ }
+ _measurements[name] = SentryMeasurement(name, value, unit: unit);
+ // We set the measurement in the transaction, too, but we have to check if this is the root span
+ // of the transaction, to avoid an infinite recursion
+ if (!_isRootSpan) {
+ _tracer.setMeasurementFromChild(name, value, unit: unit);
+ }
  }
 
  @override

dart/lib/src/sentry_span_interface.dart

@@ -71,13 +71,16 @@ abstract class ISentrySpan {
  /// Returns the trace information that could be sent as a sentry-trace header.
  SentryTraceHeader toSentryTrace();
 
- /// Set observed measurement for this transaction.
+ /// Set observed measurement for this span or transaction.
  void setMeasurement(
  String name,
  num value, {
  SentryMeasurementUnit? unit,
  });
 
+ /// Returns the measurements for a span or transaction.
+ Map<String, SentryMeasurement> get measurements;
+
  /// Returns the baggage that can be sent as "baggage" header.
  SentryBaggageHeader? toBaggageHeader();
 

dart/lib/src/sentry_tracer.dart

@@ -17,7 +17,8 @@ class SentryTracer extends ISentrySpan {
  late final SentrySpan _rootSpan;
  final List<SentrySpan> _children = [];
  final Map<String, dynamic> _extra = {};
- final Map<String, SentryMeasurement> _measurements = {};
+ @override
+ Map<String, SentryMeasurement> get measurements => _rootSpan.measurements;
 
  Timer? _autoFinishAfterTimer;
  Duration? _autoFinishAfter;
@@ -149,7 +150,7 @@ class SentryTracer extends ISentrySpan {
  }
 
  final transaction = SentryTransaction(this);
- transaction.measurements.addAll(_measurements);
+ transaction.measurements.addAll(_rootSpan.measurements);
 
  profileInfo = (status == null || status == SpanStatus.ok())
  ? await profiler?.finishFor(transaction)
@@ -320,9 +321,6 @@ class SentryTracer extends ISentrySpan {
  @override
  SentryTraceHeader toSentryTrace() => _rootSpan.toSentryTrace();
 
- @visibleForTesting
- Map<String, SentryMeasurement> get measurements =>
- Map.unmodifiable(_measurements);
 
  bool _haveAllChildrenFinished() {
  for (final child in children) {
@@ -340,11 +338,15 @@ class SentryTracer extends ISentrySpan {
 
  @override
  void setMeasurement(String name, num value, {SentryMeasurementUnit? unit}) {
- if (finished) {
- return;
+ _rootSpan.setMeasurement(name, value, unit: unit);
+ }
+
+ void setMeasurementFromChild(String name, num value,
+ {SentryMeasurementUnit? unit}) {
+ // We don't want to overwrite the root span measurement, if it comes from a child.
+ if (!_rootSpan.measurements.containsKey(name)) {
+ setMeasurement(name, value, unit: unit);
  }
- final measurement = SentryMeasurement(name, value, unit: unit);
- _measurements[name] = measurement;
  }
 
  @override

dart/test/sentry_span_test.dart

@@ -310,6 +310,32 @@ void main() {
  expect(fixture.hub.options.enableSpanLocalMetricAggregation, false);
  expect(sut.localMetricsAggregator, null);
  });
+
+ test('setMeasurement sets a measurement', () async {
+ final sut = fixture.getSut();
+ sut.setMeasurement("test", 1);
+ expect(sut.measurements.containsKey("test"), true);
+ expect(sut.measurements["test"]!.value, 1);
+ });
+
+ test('setMeasurement does not set a measurement if a span is finished',
+ () async {
+ final sut = fixture.getSut();
+ await sut.finish();
+ sut.setMeasurement("test", 1);
+ expect(sut.measurements.isEmpty, true);
+ });
+
+ test('setMeasurement also set a measurement to the transaction root span',
+ () async {
+ final sut = fixture.getSut();
+ final child = sut.tracer.startChild("child");
+ child.setMeasurement("child", 2);
+ expect(child.measurements.containsKey("child"), true);
+ expect(child.measurements["child"]!.value, 2);
+ expect(sut.measurements.containsKey("child"), true);
+ expect(sut.measurements["child"]!.value, 2);
+ });
 }
 
 class Fixture {