Skip to content
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

feat(sentry-core): add support for w3c traceparent #687

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
71 changes: 67 additions & 4 deletions sentry-core/src/performance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ pub struct TransactionContext {
}

impl TransactionContext {
/// Creates a new Transaction Context with the given `name` and `op`.
/// Creates a new Transaction Context with the given `name` and `op`. A random
/// `trace_id` is assigned. Use [`TransactionContext::new_with_trace_id`] to
/// specify a custom trace ID.
///
/// See <https://docs.sentry.io/platforms/native/enriching-events/transaction-name/>
/// for an explanation of a Transaction's `name`, and
Expand All @@ -84,13 +86,32 @@ impl TransactionContext {
/// can be used for distributed tracing.
#[must_use = "this must be used with `start_transaction`"]
pub fn new(name: &str, op: &str) -> Self {
Self::continue_from_headers(name, op, std::iter::empty())
Self::new_with_trace_id(name, op, protocol::TraceId::default())
}

/// Creates a new Transaction Context with the given `name`, `op`, and `trace_id`.
///
/// See <https://docs.sentry.io/platforms/native/enriching-events/transaction-name/>
/// for an explanation of a Transaction's `name`, and
/// <https://develop.sentry.dev/sdk/performance/span-operations/> for conventions
/// around an `operation`'s value.
#[must_use = "this must be used with `start_transaction`"]
pub fn new_with_trace_id(name: &str, op: &str, trace_id: protocol::TraceId) -> Self {
Self {
name: name.into(),
op: op.into(),
trace_id,
parent_span_id: None,
sampled: None,
custom: None,
}
}

/// Creates a new Transaction Context based on the distributed tracing `headers`.
///
/// The `headers` in particular need to include the `sentry-trace` header,
/// which is used to associate the transaction with a distributed trace.
/// The `headers` in particular need to include either the `sentry-trace` or W3C
/// `traceparent` header, which is used to associate the transaction with a distributed
/// trace. If both are present, `sentry-trace` takes precedence.
#[must_use = "this must be used with `start_transaction`"]
pub fn continue_from_headers<'a, I: IntoIterator<Item = (&'a str, &'a str)>>(
name: &str,
Expand All @@ -101,6 +122,11 @@ impl TransactionContext {
for (k, v) in headers.into_iter() {
if k.eq_ignore_ascii_case("sentry-trace") {
trace = parse_sentry_trace(v);
break;
}

if k.eq_ignore_ascii_case("traceparent") {
trace = parse_w3c_traceparent(v);
}
}

Expand Down Expand Up @@ -808,6 +834,23 @@ fn parse_sentry_trace(header: &str) -> Option<SentryTrace> {
Some(SentryTrace(trace_id, parent_span_id, parent_sampled))
}

/// Parses a W3C traceparent header.
/// Reference: <https://w3c.github.io/trace-context/#traceparent-header-field-values>
fn parse_w3c_traceparent(header: &str) -> Option<SentryTrace> {
let header = header.trim();
let mut parts = header.splitn(4, '-');

let _version = parts.next()?;
let trace_id = parts.next()?.parse().ok()?;
let parent_span_id = parts.next()?.parse().ok()?;
let parent_sampled = parts
.next()
.and_then(|sampled| u8::from_str_radix(sampled, 16).ok())
.map(|flag| flag & 1 != 0);

Some(SentryTrace(trace_id, parent_span_id, parent_sampled))
}

impl std::fmt::Display for SentryTrace {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}-{}", self.0, self.1)?;
Expand Down Expand Up @@ -840,6 +883,26 @@ mod tests {
assert_eq!(parsed, Some(trace));
}

#[test]
fn parses_traceparent() {
let trace_id = protocol::TraceId::from_str("4bf92f3577b34da6a3ce929d0e0e4736").unwrap();
let parent_trace_id = protocol::SpanId::from_str("00f067aa0ba902b7").unwrap();

let trace =
parse_w3c_traceparent("00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01");
assert_eq!(
trace,
Some(SentryTrace(trace_id, parent_trace_id, Some(true)))
);

let trace =
parse_w3c_traceparent("00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00");
assert_eq!(
trace,
Some(SentryTrace(trace_id, parent_trace_id, Some(false)))
);
}

#[test]
fn disabled_forwards_trace_id() {
let headers = [(
Expand Down
Loading