[DRAFT] feat(span-first): telemetry processor by buenaflor · Pull Request #3400 · getsentry/sentry-dart

buenaflor · 2025-12-15T15:32:20Z

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

I reviewed submitted code
I added tests to verify changes
No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
I updated the docs if needed
All tests passing
No breaking changes

🔮 Next steps

… envelope builders for logs and spans. Update SentryClient and Hub to utilize the new telemetry processor. Refactor span and log classes to support telemetry item structure. Add NoOp implementations for telemetry processing. Enhance existing classes to integrate with the new telemetry system.

This commit introduces the DefaultTelemetryProcessor class for managing telemetry item buffering and processing, along with a NoOpTelemetryProcessor for scenarios where telemetry is disabled. Additionally, it adds NoOpTransportQueue and RoundRobinTransportQueue classes for envelope management, ensuring fair scheduling across different data categories. Updates to envelope builders for logs and spans are also included, enhancing the overall telemetry processing framework.

…ndRobinTransportQueue with new implementations. Update SentryClient to utilize DefaultTelemetryProcessor and NoOpTelemetryProcessor. Remove obsolete transport queue classes to streamline envelope management.

…nstantiation. Update example app to comment out sessionSampleRate and onErrorSampleRate options, and add a new TooltipButton for creating test spans.

github-actions · 2025-12-15T15:32:49Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

### Features

- telemetry processor ([#3400](https://github.com/getsentry/sentry-dart/pull/3400))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description or adding a skip-changelog label.

Generated by 🚫 dangerJS against bcc91cd

…emetryItem across various envelope builders and the in-memory telemetry buffer. This change enhances the encoding handling for telemetry items, ensuring consistency in the processing framework.

Removed comment about parent span usage.

…g and buffer management. Added debug and warning logs for buffer registration and item processing, improving telemetry tracking and error handling.

…r testing and add MockTelemetryBuffer for unit tests. Implement comprehensive tests for buffer registration, item routing, and flushing behavior.

…EnvelopeBuilder, and introducing SingleEnvelopeBuilder for improved envelope management. Update DefaultTelemetryProcessor to utilize the new builder, enhancing the overall telemetry item handling. Add comprehensive tests for the new envelope builders and in-memory telemetry buffer functionality.

Introduce MockTelemetryItem and MockSpan classes to facilitate testing of telemetry processing. Update existing tests to utilize these mocks, enhancing the coverage and reliability of telemetry buffer and envelope builder functionalities. Remove obsolete mock classes to streamline the test suite.

Remove obsolete MockTelemetryItem and MockSpan classes, replacing them with MockTelemetryItem and MockSpanV2 for enhanced testing capabilities. Update relevant tests to utilize the new mock classes, ensuring better coverage and reliability in telemetry processing tests.

…es and updating SentryOptions to utilize a telemetry processor. This change enhances the logging mechanism and streamlines the telemetry handling process. Update tests to reflect the new telemetry processor integration.

buenaflor · 2025-12-16T15:26:41Z

-    test('sets log batcher on options when logs are enabled', () async {
-      expect(fixture.options.logBatcher is NoopLogBatcher, true);
-
-      fixture.options.enableLogs = true;
-      fixture.getSut();
-
-      expect(fixture.options.logBatcher is NoopLogBatcher, false);
-    });


this is tested in telemetry processor test file

buenaflor · 2025-12-16T15:27:14Z

+}
+
+/// In-memory buffer with time and size-based flushing.
+class InMemoryTelemetryBuffer<T extends TelemetryItem>


pretty much copy pasted the sentry log batcher

…mplementedError throws into a single method. Update SentryWidgetsBindingObserver to replace log batching with telemetry processing, and adjust related tests to reflect these changes. This enhances the clarity and maintainability of the codebase.

… related classes for improved type safety. Modify DefaultTelemetryProcessor and its tests to utilize generic types for buffer registration and item addition, enhancing clarity and maintainability in telemetry handling.

…to clean up the codebase.

denrase · 2025-12-17T09:52:57Z

  })  : _spanId = SpanId.newId(),
        _hub = hub ?? HubAdapter(),
-        _name = name;
+        _startTimestamp = DateTime.now().toUtc(),


Don't we have some date wrapper, also used in testing?

denrase · 2025-12-17T09:58:13Z

+class SpanEnvelopeBuilder implements EnvelopeBuilder<Span> {
+  final SentryOptions _options;
+
+  SpanEnvelopeBuilder(this._options);


Could we inject publicKey, release & 'environment' instead of all options, or are they subject to change after init? Could bundle ein Metadata object.

denrase · 2025-12-17T09:58:37Z

+}
+
+class LogEnvelopeBuilder extends SingleEnvelopeBuilder<SentryLog> {
+  LogEnvelopeBuilder(SentryOptions options)


Could we inject sdk instead of all options, or is it subject to change after init?

don't think it changes, I'll update

denrase · 2025-12-17T10:06:04Z

+  }
+
+  @override
+  FutureOr<void> flush() => _performFlush();


There was some naming discussion over at Cocoa, I think the gist was to call this clear instead of flush. Not super important now, just something to consider.

denrase · 2025-12-17T10:07:34Z

@@ -0,0 +1,6 @@
+import 'package:meta/meta.dart';
+
+abstract class TelemetryItem {


This is so generic, we should probably call it something like Encodable

Wasn't sure if we're gonna add more things but yea SentryEncodable would be better I think

denrase · 2025-12-17T10:10:05Z

+}
+
+/// In-memory buffer with time and size-based flushing.
+class InMemoryTelemetryBuffer<T extends TelemetryItem>


Cocoa has additionaly seperated the InMemory Storage from the logic when to dispatch the buffered elements. Not sure this is needed here, here's the PR

dont think we'll need this, we won't implement file-based buffering or any other storage other than in-memory fwiw - we'll rely on the native SDKs and when we replace it with the native file-based ones in the future we will swap the whole impl, not only the storage

so imo doesn't make sense to separate them for Dart (currently)

when we do have a use case later we can just adjust the impl

…stency and cleanliness.

buenaflor · 2025-12-17T14:16:34Z

this PR will be split up

buenaflor added 4 commits December 15, 2025 16:12

Refactor telemetry processing by replacing NoOpTransportQueue and Rou…

c856afb

…ndRobinTransportQueue with new implementations. Update SentryClient to utilize DefaultTelemetryProcessor and NoOpTelemetryProcessor. Remove obsolete transport queue classes to streamline envelope management.

Refactor DefaultTelemetryProcessor to use a private constructor for i…

5f9f4e7

…nstantiation. Update example app to comment out sessionSampleRate and onErrorSampleRate options, and add a new TooltipButton for creating test spans.

Refactor telemetry processing to replace BufferedItem with EncodedTel…

4f42f22

…emetryItem across various envelope builders and the in-memory telemetry buffer. This change enhances the encoding handling for telemetry items, ensuring consistency in the processing framework.

buenaflor force-pushed the feat/span/telemetry-processor branch from e5f7fde to 4f42f22 Compare December 15, 2025 20:44

buenaflor and others added 8 commits December 15, 2025 21:44

Update

de97913

Remove comment on parent span in constructor

5b45139

Removed comment about parent span usage.

Enhance DefaultTelemetryProcessor to utilize SentryOptions for loggin…

d3d7038

…g and buffer management. Added debug and warning logs for buffer registration and item processing, improving telemetry tracking and error handling.

Refactor DefaultTelemetryProcessor to expose registerBuffer method fo…

75172d9

…r testing and add MockTelemetryBuffer for unit tests. Implement comprehensive tests for buffer registration, item routing, and flushing behavior.

buenaflor commented Dec 16, 2025

View reviewed changes

buenaflor added 3 commits December 16, 2025 16:31

Remove unused import of simple_span.dart in telemetry_processor.dart …

2f59496

…to clean up the codebase.

denrase reviewed Dec 17, 2025

View reviewed changes

buenaflor added 2 commits December 17, 2025 15:14

Merge branch 'feat/span-first' into feat/span/telemetry-processor

83c4408

Remove trailing whitespace in MockSpanV2 class to maintain code consi…

bcc91cd

…stency and cleanliness.

buenaflor closed this Dec 17, 2025

		@@ -0,0 +1,6 @@
		import 'package:meta/meta.dart';

		abstract class TelemetryItem {

Uh oh!

Conversation

buenaflor commented Dec 15, 2025

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions Bot commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions and example for changelog

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

buenaflor Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

buenaflor commented Dec 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Dec 15, 2025 •

edited

Loading

buenaflor Dec 17, 2025 •

edited

Loading