Skip to content

feat: Add W3C traceparent support to tracing client and utils #2843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ await SentryFlutter.init(
```
- Make hierarchical exception grouping opt-in ([#2858](https://github.com/getsentry/sentry-dart/pull/2858))

- Outgoing HTTP requests now contain the `traceparent` header to facilitate integration with servers that only support the [W3C Trace Context](https://www.w3.org/TR/trace-context/). ([#2843](https://github.com/getsentry/sentry-dart/pull/2843))

### Fixes

- Trace propagation in HTTP tracing clients not correctly set up if performance is disabled ([#2850](https://github.com/getsentry/sentry-dart/pull/2850))
Expand Down
2 changes: 2 additions & 0 deletions dart/lib/src/utils/add_tracing_headers_to_http_request.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ void addTracingHeadersToHttpHeader(Map<String, dynamic> headers, Hub hub,
{ISentrySpan? span}) {
if (span != null) {
addSentryTraceHeaderFromSpan(span, headers);
addW3CHeaderFromSpan(span, headers);
addBaggageHeaderFromSpan(
span,
headers,
Expand All @@ -18,6 +19,7 @@ void addTracingHeadersToHttpHeader(Map<String, dynamic> headers, Hub hub,

final traceHeader = propagationContext.toSentryTrace();
addSentryTraceHeader(traceHeader, headers);
addW3CHeaderFromSentryTrace(traceHeader, headers);

final baggageHeader = propagationContext.toBaggageHeader();
if (baggageHeader != null) {
Expand Down
16 changes: 16 additions & 0 deletions dart/lib/src/utils/tracing_utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@ void addSentryTraceHeader(
headers[traceHeader.name] = traceHeader.value;
}

void addW3CHeaderFromSpan(ISentrySpan span, Map<String, dynamic> headers) {
final traceHeader = span.toSentryTrace();
addW3CHeaderFromSentryTrace(traceHeader, headers);
}

void addW3CHeaderFromSentryTrace(
SentryTraceHeader traceHeader, Map<String, dynamic> headers) {
headers['traceparent'] = formatAsW3CHeader(traceHeader);
}

String formatAsW3CHeader(SentryTraceHeader traceHeader) {
final sampled = traceHeader.sampled;
final traceFlags = sampled != null && sampled ? '01' : '00';
return '00-${traceHeader.traceId}-${traceHeader.spanId}-$traceFlags';
}

void addBaggageHeaderFromSpan(
ISentrySpan span,
Map<String, dynamic> headers, {
Expand Down
35 changes: 35 additions & 0 deletions dart/test/utils/tracing_utils_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,41 @@ void main() {
expect(headers[baggage.name], newValue);
});

group('$addW3CHeaderFromSentryTrace', () {
final fixture = Fixture();
final headerName = 'traceparent';
final headerValue =
'00-${fixture._context.traceId}-${fixture._context.spanId}-01';

test('formats SentryTraceHeader as W3C header', () {
final sut = fixture.getSut();
final sentryHeader = sut.toSentryTrace();

final w3cHeader = formatAsW3CHeader(sentryHeader);

expect(w3cHeader, headerValue);
});

test('adds W3C traceparent from span', () {
final headers = <String, String>{};
final sut = fixture.getSut();

addW3CHeaderFromSpan(sut, headers);

expect(headers[headerName], headerValue);
});

test('adds W3C traceparent header', () {
final headers = <String, String>{};
final sut = fixture.getSut();
final sentryHeader = sut.toSentryTrace();

addW3CHeaderFromSentryTrace(sentryHeader, headers);

expect(headers[headerName], headerValue);
});
});

test('overwrites duplicate key values', () {
final headers = <String, String>{};
final oldValue =
Expand Down
Loading