Adding baggage limits for OT Baggage by mhlidd · Pull Request #12303 · DataDog/dd-trace-java

mhlidd · 2026-08-26T13:50:51Z

What Does This Do

This PR adds limits to the size and number of objects allowed to be extracted for the legacy OT Baggage. This PR also fixes an old bug where comma-concatenated Haystack traceID/spanID headers were parsed using the entire header value, causing context extraction to fail. We now parse and preserve only the first traceID/spanID from the headers.

Motivation

Additional Notes

Contributor Checklist

Format the title according to the contribution guidelines
Assign the type: and (comp: or inst:) labels in addition to any other useful labels
Avoid using close, fix, or any linking keywords when referencing an issue
Use solves instead, and assign the PR milestone to the issue
Update the CODEOWNERS file on source file addition, migration, or deletion
Update public documentation with any new configuration flags or behaviors
Once approved, use merge queue to merge the PR

Jira ticket: [PROJ-IDENT]

dd-octo-sts · 2026-08-26T13:51:05Z

Hi! 👋 Thanks for your pull request! 🎉

To help us review it, please make sure to:

Add at least one type, and one component or instrumentation label to the pull request

If you need help, please check our contributing guidelines.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1b4215ce74

ℹ️ 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".

datadog-datadog-prod-us1

More details

The shared limit accounting covers all changed extraction paths and preserves reserved Haystack trace identifiers.

Was this helpful? React 👍 or 👎

_{Open Bits AI session}

_{🤖 Datadog Autotest · Commit 1b4215c · What is Autotest? · @DataDog review to ask questions · Any feedback? Reach out in #autotest}

datadog-datadog-prod-us1 · 2026-08-26T14:09:05Z

🎯 Code Coverage (details)
• Patch Coverage: 88.24%
• Overall Coverage: 58.99% (+0.18%)

_{This comment will be updated automatically if new data arrives.

🔗 Commit SHA: 3424e8d | Docs | View more details | Give us feedback!}

dd-octo-sts · 2026-08-26T14:17:55Z

🟢 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	14.84 s	14.77 s	[-0.4%; +1.3%] (no difference)
startup:insecure-bank:tracing:Agent	13.67 s	13.78 s	[-1.6%; +0.1%] (no difference)
startup:petclinic:appsec:Agent	17.50 s	17.41 s	[-0.3%; +1.3%] (no difference)
startup:petclinic:iast:Agent	16.87 s	17.63 s	[-8.5%; -0.1%] (maybe better)
startup:petclinic:profiling:Agent	17.36 s	17.32 s	[-0.9%; +1.4%] (no difference)
startup:petclinic:sca:Agent	17.32 s	17.44 s	[-1.6%; +0.3%] (no difference)
startup:petclinic:tracing:Agent	16.57 s	16.71 s	[-1.9%; +0.2%] (no difference)

Commit: 3424e8d2 · 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.

Copilot

Pull request overview

This PR adds configurable limits for legacy OpenTracing-style baggage extraction (including ot-baggage-* headers and equivalent baggage segments in other propagators) by centralizing baggage acceptance, byte-budgeting, and “reserved” key protection in ContextInterpreter, then updating codec implementations and tests accordingly.

Changes:

Enforce trace.baggage.max.items and trace.baggage.max.bytes during extraction across Datadog, W3C, X-Ray, and Haystack propagators.
Prevent caller-controlled baggage (including mapped baggage) from overwriting reserved propagation bookkeeping keys (e.g., Haystack lossless IDs).
Add/extend extractor tests to validate item/byte truncation, replacement semantics, and reserved-key behavior.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
dd-trace-core/src/main/java/datadog/trace/core/propagation/ContextInterpreter.java	Centralizes baggage limiting (items/bytes), replacement accounting, and reserved-key protection for extraction.
dd-trace-core/src/main/java/datadog/trace/core/propagation/DatadogHttpCodec.java	Routes OT baggage extraction through the new `ContextInterpreter` baggage limiter.
dd-trace-core/src/main/java/datadog/trace/core/propagation/W3CHttpCodec.java	Routes OT baggage extraction through the new `ContextInterpreter` baggage limiter.
dd-trace-core/src/main/java/datadog/trace/core/propagation/XRayHttpCodec.java	Routes X-Ray “key=value” segment baggage extraction through the new limiter and preserves parsing after truncation.
dd-trace-core/src/main/java/datadog/trace/core/propagation/HaystackHttpCodec.java	Treats Haystack trace/span IDs as reserved baggage (non-evictable by caller baggage) while keeping Parent-ID subject to limits.
dd-trace-core/src/test/java/datadog/trace/core/propagation/DatadogHttpExtractorTest.java	Adds tests for OT baggage item/byte limits, replacement semantics, and UTF-8 byte counting.
dd-trace-core/src/test/java/datadog/trace/core/propagation/W3CHttpExtractorTest.java	Adds tests for OT baggage item/byte truncation under W3C extraction.
dd-trace-core/src/test/java/datadog/trace/core/propagation/XRayHttpExtractorTest.java	Adds tests for X-Ray header baggage truncation and for continued parsing of trace context after truncation.
dd-trace-core/src/test/java/datadog/trace/core/propagation/HaystackHttpExtractorTest.java	Adds tests ensuring reserved Haystack IDs survive baggage limits and mapped baggage cannot overwrite them.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.

PerfectSlayer

💭 thought: ‏I think the PR is confusing in multiple parts.
First the introduction of "reversed" baggage.
Then the tree map for the size. If it's only to keep track of the size, why don't we only compute the size of the evicted element to apply the difference? That would save the tree at the cost of duplicated key (which should only happen on rare occasion and never from the dd-trace-* SDK as defined by spec).
Then the variables are now confusing: baggage should be baggageItems, and baggageItems should be baggageItemCount, etc... But getting rid of the baggageItemBytes would help.

PerfectSlayer · 2026-08-28T11:31:00Z

  }

+  protected final boolean addBaggageItem(String key, String value) {
+    if (key == null || value == null || baggageMaxItems <= 0 || baggageMaxBytes <= 0) {


❔ question: ‏Do we want to allow negative max item/bytes values as possible config value?
Or should we set the min as 0 during parsing? Having negative value as errors.

Setting min to 0 is cleaner. This will affect W3C Baggage as well but positively. :)

PerfectSlayer · 2026-08-28T11:33:40Z

+      return false;
+    }
+    // Charge the raw key and value before URL decoding so percent-encoded input keeps its size.
+    final long itemBytes = Utf8.size(key) + Utf8.size(value);


❔ question: ‏Can you use an approximate size here rather than depending on OkHttp lib?
We will need to remove it at some point (hopefully next quarter)

PerfectSlayer · 2026-08-28T11:35:04Z

+    final String decodedValue = HttpCodec.decode(value);
+    if (baggage.isEmpty()) {
+      baggage = new TreeMap<>();
+      baggageItemBytes = new TreeMap<>();


❔ question: ‏Why do we need ordering here? (TreeMap)

TreeMap was used in the old diff when OT Baggage was introduced, so I kept it here. Unsure of reasons it was used then (commit message says "use TreeMap everywhere for now"), but if unnecessary I can replace it w/ a HashMap.

PerfectSlayer · 2026-08-28T11:42:44Z

+  // that caller-supplied headers cannot evict it. Exempt from the configured limits, but not
+  // unbounded: the value is capped here rather than left to each caller to validate, so the total
+  // retained stays within trace.baggage.max.bytes plus a fixed amount per reserved key.
+  protected final void addReservedBaggageItem(String key, String value) {


💭 thought: ‏I don't get the whole reserved baggage… If it's only for XRay and in case of conflict, I don't see the point having it.

PerfectSlayer · 2026-08-28T11:43:19Z

+  // Stores a value the tracer itself round-trips, outside the caller-controlled baggage budget so
+  // that caller-supplied headers cannot evict it. Exempt from the configured limits, but not
+  // unbounded: the value is capped here rather than left to each caller to validate, so the total
+  // retained stays within trace.baggage.max.bytes plus a fixed amount per reserved key.


💭 thought: ‏Why is there method comment that is not part of the Javadoc?

Good point, I'll update here. Also will open a follow-up PR to add to AGENTS.md to ensure that method comments are Javadoc style.

adding baggage limits for OT Baggage

1b4215c

mhlidd requested a review from a team as a code owner August 26, 2026 13:50

mhlidd requested review from mcculls and removed request for a team August 26, 2026 13:50

mhlidd added type: bug fix Bug fix comp: context propagation Trace context propagation labels Aug 26, 2026

mhlidd requested a review from PerfectSlayer August 26, 2026 13:51

chatgpt-codex-connector Bot reviewed Aug 26, 2026

View reviewed changes

Comment thread dd-trace-core/src/main/java/datadog/trace/core/propagation/ContextInterpreter.java Outdated

Comment thread dd-trace-core/src/main/java/datadog/trace/core/propagation/ContextInterpreter.java

datadog-datadog-prod-us1 Bot reviewed Aug 26, 2026

View reviewed changes

adding accurate utf length checking

e8c5cb5

mhlidd requested a lite review from Copilot August 26, 2026 16:33

Copilot started reviewing on behalf of mhlidd August 26, 2026 16:33 View session

Copilot AI reviewed Aug 26, 2026

View reviewed changes

Comment thread dd-trace-core/src/main/java/datadog/trace/core/propagation/ContextInterpreter.java

Comment thread dd-trace-core/src/test/java/datadog/trace/core/propagation/DatadogHttpExtractorTest.java

updating test fix and early exit when ot-baggage extraction is disabled

740ce66

mhlidd requested a lite review from Copilot August 26, 2026 17:00

Copilot started reviewing on behalf of mhlidd August 26, 2026 17:01 View session

Copilot AI reviewed Aug 26, 2026

View reviewed changes

Comment thread dd-trace-core/src/main/java/datadog/trace/core/propagation/HaystackHttpCodec.java

mhlidd added 2 commits August 26, 2026 13:31

fixing haystack traceid spanid concatenation bug

0048d3b

Merge branch 'master' into mhlidd/ot_baggage_fix

3424e8d

mhlidd requested a lite review from Copilot August 26, 2026 17:35

Copilot started reviewing on behalf of mhlidd August 26, 2026 17:36 View session

Copilot AI reviewed Aug 26, 2026

View reviewed changes

PerfectSlayer added type: bug fix Bug fix and removed type: bug fix Bug fix labels Aug 27, 2026

PerfectSlayer reviewed Aug 28, 2026

View reviewed changes

mhlidd added the tag: ai generated Largely based on code generated by an AI or LLM label Aug 28, 2026

Uh oh!

Conversation

mhlidd commented Aug 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What Does This Do

Motivation

Additional Notes

Contributor Checklist

Uh oh!

dd-octo-sts Bot commented Aug 26, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

datadog-datadog-prod-us1 Bot left a comment

Choose a reason for hiding this comment

Uh oh!

datadog-datadog-prod-us1 Bot commented Aug 26, 2026 • edited by datadog-prod-us1-3 Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dd-octo-sts Bot commented Aug 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟢 Java Benchmark SLOs — All performance SLOs passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

PerfectSlayer left a comment • 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mhlidd commented Aug 26, 2026 •

edited

Loading

datadog-datadog-prod-us1 Bot commented Aug 26, 2026 •

edited by datadog-prod-us1-3 Bot

Loading

dd-octo-sts Bot commented Aug 26, 2026 •

edited

Loading

PerfectSlayer left a comment •

edited

Loading