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

chore: add support for max items in baggage [backport 2.17] #11963

Merged
merged 2 commits into from
Jan 15, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jan 15, 2025

Backport 8eb0b44 from #11421 to 2.17.

Fixing baggage max items implementation based off the change in the RFC. "If baggage data exceeds one or both of these limits, APM SDKs should drop baggage name/value pairs until both conditions are met. For example, if baggage contains 70 name/value pairs, the SDK should only add 64 of them to the baggage header and drop the other 6. The W3C leaves the process of selecting which pairs to keep or drop up to implementers. The simplest algorithm in this example is to keep the first 64 pairs and drop the last 6."

Also updating the test that checks max baggage items.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

Fixing baggage max items implementation based off the change in the RFC.
"If baggage data exceeds one or both of these limits, APM SDKs should
drop baggage name/value pairs until both conditions are met. For
example, if baggage contains 70 name/value pairs, the SDK should only
add 64 of them to the baggage header and drop the other 6. The W3C
leaves the process of selecting which pairs to keep or drop up to
implementers. The simplest algorithm in this example is to keep the
first 64 pairs and drop the last 6."

Also updating the test that checks max baggage items.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit 8eb0b44)
@github-actions github-actions bot added the changelog/no-changelog A changelog entry is not required for this PR. label Jan 15, 2025
@github-actions github-actions bot requested a review from a team as a code owner January 15, 2025 18:10
@erikayasuda erikayasuda reopened this Jan 15, 2025
Copy link
Contributor Author

CODEOWNERS have been resolved as:

ddtrace/propagation/http.py                                             @DataDog/apm-sdk-api-python
tests/tracer/test_propagation.py                                        @DataDog/apm-sdk-api-python

@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jan 15, 2025

Datadog Report

Branch report: backport-11421-to-2.17
Commit report: dec0172
Test service: dd-trace-py

✅ 0 Failed, 592 Passed, 604 Skipped, 20m 17.33s Total duration (15m 22.01s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jan 15, 2025

Benchmarks

Benchmark execution time: 2025-01-15 19:39:27

Comparing candidate commit dec0172 in PR branch backport-11421-to-2.17 with baseline commit 8f64e05 in branch 2.17.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 388 metrics, 2 unstable metrics.

@erikayasuda erikayasuda merged commit ad9545e into 2.17 Jan 15, 2025
635 of 637 checks passed
@erikayasuda erikayasuda deleted the backport-11421-to-2.17 branch January 15, 2025 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants