Skip to content

fix(tracing): truncate long span attributes (#13270) [backport 2.21] (DO NOT MERGE) #13811

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

Draft
wants to merge 2 commits into
base: 2.21
Choose a base branch
from

Conversation

wantsui
Copy link
Collaborator

@wantsui wantsui commented Jun 27, 2025

DO NOT MERGE

2.21 backport of: #13270

Truncate span resource name, tag key and tag values.

Previously, a very large resource name would result in a runtime error during encoding.

If any of these have over 25000 chars, this will truncate them to up to 2500 chars (and include the suffix <truncated>)
The agent will truncate based on the limits
here

Resolves:

  • [BUG]: RuntimeError: failed to pack span for large SQL queries #13221

  • Error inserting SQL statement into string table #6587

  • 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 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


(cherry picked from commit 5aa32d1)

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

Truncate span resource name, tag key and tag values.

Previously, a very large resource name would result in a runtime error
during encoding.

If any of these have over 25000 chars, this will truncate them to up to
2500 chars (and include the suffix `<truncated>`)
The agent will truncate based on the limits
[here](https://docs.datadoghq.com/tracing/troubleshooting/?tab=java#data-volume-guidelines)

Resolves:
- #13221
- #6587

- [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 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)

---------

Co-authored-by: Munir Abdinur <[email protected]>
Co-authored-by: wan <[email protected]>
(cherry picked from commit 5aa32d1)
@wantsui wantsui requested a review from quinna-h June 27, 2025 22:05
Copy link
Contributor

CODEOWNERS have been resolved as:

releasenotes/notes/truncate-long-span-attributes-a4900ee9844160b4.yaml  @DataDog/apm-python
tests/snapshots/tests.integration.test_integration_snapshots.test_encode_span_with_large_string_attributes[v0.4].json  @DataDog/apm-python
tests/snapshots/tests.integration.test_integration_snapshots.test_encode_span_with_large_string_attributes[v0.5].json  @DataDog/apm-python
ddtrace/_trace/_limits.py                                               @DataDog/apm-sdk-api-python
ddtrace/internal/_encoding.pyx                                          @DataDog/apm-core-python
tests/integration/test_integration.py                                   @DataDog/apm-core-python
tests/integration/test_integration_snapshots.py                         @DataDog/apm-core-python

@wantsui wantsui changed the title fix(tracing): truncate long span attributes (#13270) [backport 2.21] fix(tracing): truncate long span attributes (#13270) [backport 2.21] (DO NOT MERGE) Jun 27, 2025
@pr-commenter
Copy link

pr-commenter bot commented Jun 27, 2025

Benchmarks

Benchmark execution time: 2025-06-27 22:42:13

Comparing candidate commit 12f9c78 in PR branch backport-13270-to-2.21 with baseline commit 7990c03 in branch 2.21.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants