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

fix(tracing): fix traceback max size for exceptions [backport 2.9] #9391

Merged
merged 4 commits into from
May 28, 2024

Conversation

github-actions[bot]
Copy link
Contributor

Backport 1b954de from #9112 to 2.9.

#7558 made the traceback size configurable via DD_TRACE_SPAN_TRACEBACK_MAX_SIZE, but tracebacks for exceptions were still hardcoded with a limit of 30.

The fix is modeled after Span#set_traceback's existing logic, and tests were modeled after both test_traceback_with_error and test_custom_traceback_size. Not much new logic, just an edge case.

Checklist

  • Change(s) are motivated and described in the PR description
  • Testing strategy is described if automated tests are not included in the PR
  • Risks are described (performance impact, potential for breakage, maintainability)
  • Change is maintainable (easy to change, telemetry, documentation)
  • Library release note guidelines are followed or label changelog/no-changelog is set
  • Documentation is included (in-code, generated user docs, public corp docs)
  • Backport labels are set (if applicable)
  • If this PR changes the public interface, I've notified @DataDog/apm-tees.

Reviewer Checklist

  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Description motivates each change
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Change is maintainable (easy to change, telemetry, documentation)
  • Release note makes sense to a user of the library
  • 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

#7558 made the traceback size
configurable via `DD_SPAN_TRACEBACK_MAX_SIZE`, but tracebacks for
exceptions were still hardcoded with a limit of 30.

The fix is modeled after `Span#set_traceback`'s existing logic, and
tests were modeled after both `test_traceback_with_error` and
`test_custom_traceback_size`. Not much new logic, just an edge case.

## Checklist

- [x] Change(s) are motivated and described in the PR description
- [x] Testing strategy is described if automated tests are not included
in the PR
- [x] Risks are described (performance impact, potential for breakage,
maintainability)
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed or label `changelog/no-changelog` is set
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/))
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))
- [x] If this PR changes the public interface, I've notified
`@DataDog/apm-tees`.

## Reviewer Checklist

- [x] Title is accurate
- [x] All changes are related to the pull request's stated goal
- [x] Description motivates each change
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- [x] Testing strategy adequately addresses listed risks
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] Release note makes sense to a user of the library
- [x] Author has acknowledged and discussed the performance implications
of this PR as reported in the benchmarks PR comment
- [x] 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: erikayasuda <153395705+erikayasuda@users.noreply.github.com>
(cherry picked from commit 1b954de)
@github-actions github-actions bot requested review from a team as code owners May 24, 2024 22:34
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented May 24, 2024

Datadog Report

Branch report: backport-9112-to-2.9
Commit report: 9e8edc2
Test service: dd-trace-py

✅ 0 Failed, 169808 Passed, 2258 Skipped, 9h 30m 36.51s Total duration (1h 17m 36.31s time saved)

@emmettbutler emmettbutler enabled auto-merge (squash) May 28, 2024 14:13
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 15.00000% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 10.30%. Comparing base (26c2ac5) to head (6b14eeb).
Report is 4 commits behind head on 2.9.

Files Patch % Lines
tests/tracer/test_span.py 0.00% 16 Missing ⚠️
ddtrace/_trace/span.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##              2.9    #9391       +/-   ##
===========================================
- Coverage   27.73%   10.30%   -17.43%     
===========================================
  Files        1259     1256        -3     
  Lines      119987   120081       +94     
===========================================
- Hits        33280    12377    -20903     
- Misses      86707   107704    +20997     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@emmettbutler emmettbutler merged commit 4382c8d into 2.9 May 28, 2024
150 checks passed
@emmettbutler emmettbutler deleted the backport-9112-to-2.9 branch May 28, 2024 17:16
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.

4 participants