Skip to content

refactor(propagation): Parse OpenTelemetry tracestate member - #12405

Open
MilanGarnier wants to merge 2 commits into
masterfrom
milan.garnier/otel-tracestate-refactor
Open

refactor(propagation): Parse OpenTelemetry tracestate member#12405
MilanGarnier wants to merge 2 commits into
masterfrom
milan.garnier/otel-tracestate-refactor

Conversation

@MilanGarnier

Copy link
Copy Markdown
Contributor

What Does This Do

Refactors W3C tracestate handling so the OpenTelemetry ot member is
represented separately while its value remains opaque.

  • Extracts and re-emits the raw ot member.
  • Preserves its inherited position when rebuilding tracestate.
  • Does not interpret rv or th or connect the member to sampling.

Motivation

Isolate the tracestate parsing foundation from the consistent-sampling
behavior added by the follow-up PR.

Additional Notes

This is the first PR in a two-PR stack. The sampling behavior follows in
#12397.

Validation:

  • :dd-trace-core:compileJava
  • :dd-trace-core:spotlessCheck
  • git diff --check

Contributor Checklist

  • Format the title according to the contribution guidelines.
  • Assign the required type: and comp: labels.
  • Keep sampling behavior and tests in the follow-up PR.

Jira ticket: APMAPI-2171

@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 52.43%
Overall Coverage: 57.45% (-1.62%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 397a1ff | Docs | View more details | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🟢 Java Benchmark SLOs — All performance SLOs passed

Suite Status
Startup 🟢 pass

SLO thresholds are defined here based on automatically generated metrics. A warning is raised when results are within 5% of the threshold.

PR vs. master results
Scenario Candidate master Δ (95% CI of mean)
startup:insecure-bank:iast:Agent 13.96 s 14.02 s [-1.5%; +0.5%] (no difference)
startup:insecure-bank:tracing:Agent 12.92 s 13.04 s [-1.6%; -0.2%] (maybe better)
startup:petclinic:appsec:Agent 16.90 s 16.70 s [+0.2%; +2.2%] (maybe worse)
startup:petclinic:iast:Agent 16.87 s 17.00 s [-1.4%; -0.1%] (maybe better)
startup:petclinic:profiling:Agent 16.73 s 16.80 s [-1.5%; +0.5%] (no difference)
startup:petclinic:sca:Agent 16.96 s 16.75 s [+0.3%; +2.3%] (maybe worse)
startup:petclinic:tracing:Agent 16.01 s 16.22 s [-2.5%; -0.1%] (maybe better)

Commit: 397a1ff6 · CI Pipeline · Benchmarking Platform UI


Load and DaCapo benchmarks can be triggered manually in the GitLab pipeline. Results will appear in the Benchmarking Platform UI after completion.

@MilanGarnier
MilanGarnier marked this pull request as ready for review September 4, 2026 16:07
@MilanGarnier
MilanGarnier requested a review from a team as a code owner September 4, 2026 16:07
@MilanGarnier
MilanGarnier requested review from mcculls and removed request for a team September 4, 2026 16:07

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 397a1ff69a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

public void updateW3CTracestate(String tracestate) {
clearCachedHeader(W3C);
this.tracestate = tracestate;
setOtelTraceState(W3CPTagsCodec.extractOtelTraceState(tracestate));

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Reuse the parsed OTel state during reconciliation

perf: With the default DATADOG,TRACECONTEXT extraction order, matching Datadog and W3C headers cause fromHeaderValue to parse the tracestate before HttpCodec.applyTraceContextToFirstContext passes the same string here. Calling extractOtelTraceState then validates and scans it again—and allocates another substring/state when ot is present—on the inbound request path. Transfer the already-parsed state with the propagation tags instead of reparsing the raw header.

AGENTS.md reference: AGENTS.md:L76-L79

Useful? React with 👍 / 👎.

Comment on lines +259 to +261
OtelTraceState otelTraceState = pTags.getOtelTraceState();
if (otelTraceState != null) {
size += OTEL_MEMBER_KEY.length() + otelTraceState.length() + 1;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Avoid counting the OTel member twice in the buffer estimate

perf: When the original tracestate length is already included above—either for a parsed W3CPTags containing dd or for a Datadog PTags updated during multi-style reconciliation—it already contains the ot= member and its delimiter. Adding its size again here over-allocates the StringBuilder backing storage by up to 260 characters on each fresh W3C encoding, including per-span encodings that use a last-parent override. Subtract the managed member from the original-size contribution or omit this second addition in those cases.

AGENTS.md reference: AGENTS.md:L76-L79

Useful? React with 👍 / 👎.

@datadog-datadog-prod-us1 datadog-datadog-prod-us1 Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Datadog Autotest: PASS

More details

The change keeps the raw ot member and its inherited position when it rebuilds tracestate. The static review finds no reportable regression in the changed parsing and serialization paths.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Datadog Autotest · Commit 397a1ff · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest

@mcculls mcculls left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The double-parsing issue will need to be fixed before this can be merged.

Claude suggests giving PTags a way to accept an already-built OtelTraceState directly (e.g. setOtelTraceState), and have applyTraceContextToFirstContext pass the parsed object from traceContext.getPropagationTags() instead of round-tripping through the string.

The double-counting issue is easily solved by removing the second addition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp: context propagation Trace context propagation tag: ai generated Largely based on code generated by an AI or LLM type: refactoring

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants