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 #9112

Merged

Conversation

quiqueg
Copy link
Contributor

@quiqueg quiqueg commented Apr 27, 2024

#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

@quiqueg quiqueg force-pushed the fix-tracing-traceback-size-for-exceptions branch from 1906b70 to ba889b5 Compare April 29, 2024 18:06
@quiqueg quiqueg marked this pull request as ready for review April 29, 2024 19:01
@quiqueg quiqueg requested review from a team as code owners April 29, 2024 19:01
@quiqueg quiqueg force-pushed the fix-tracing-traceback-size-for-exceptions branch from ba889b5 to cc10ef4 Compare May 3, 2024 20:51
@codecov-commenter
Copy link

codecov-commenter commented May 3, 2024

Codecov Report

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

Project coverage is 9.96%. Comparing base (f38dbd4) to head (40dc744).
Report is 2 commits behind head on main.

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             @@
##             main    #9112       +/-   ##
===========================================
- Coverage   75.92%    9.96%   -65.96%     
===========================================
  Files        1296     1267       -29     
  Lines      123157   121468     -1689     
===========================================
- Hits        93507    12106    -81401     
- Misses      29650   109362    +79712     

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

DataDog#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.
@quiqueg quiqueg force-pushed the fix-tracing-traceback-size-for-exceptions branch from cc10ef4 to f39a5a4 Compare May 6, 2024 17:02
@quiqueg
Copy link
Contributor Author

quiqueg commented May 7, 2024

@erikayasuda @Kyle-Verhoog Gentle ping—could I please get a review on this when you have a moment? This is impacting our ability to properly track errors in our application via APM.

@quiqueg
Copy link
Contributor Author

quiqueg commented May 9, 2024

@erikayasuda Did you have any comments on the release note? I noticed that you left Release note makes sense to a user of the library unchecked in the reviewer checklist.

@quiqueg
Copy link
Contributor Author

quiqueg commented May 10, 2024

@erikayasuda This PR should be good to go. It looks like just the Library Injection / build-and-publish-test-image / build_push / build_push CI job is failing with a docker push 403 Unauthorized error. I'm not familiar with this project's CI setup, but it might be because my fork (as an outside contributor) doesn't have access to the secrets.GITHUB_TOKEN?

I don't have merge permissions in this repo, so please feel free to take over and merge when you have a chance to do so. Thank you!

@erikayasuda
Copy link
Contributor

Hi @quiqueg , sorry for the slow cycles here. I just updated the branch, and enabled auto-merge, so that should merge today assuming the tests all go well. Thanks for the patience!

@erikayasuda erikayasuda enabled auto-merge (squash) May 15, 2024 15:41
@quiqueg
Copy link
Contributor Author

quiqueg commented May 21, 2024

@erikayasuda Looks like the Library Injection / build-and-publish-test-image / build_push / build_push test is still failing with the same 403 Unauthorized error that I mentioned above. Could you please take a look?

@erikayasuda erikayasuda merged commit 1b954de into DataDog:main May 24, 2024
176 of 180 checks passed
github-actions bot pushed a commit that referenced this pull request May 24, 2024
#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 bot pushed a commit that referenced this pull request May 24, 2024
#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 bot pushed a commit that referenced this pull request May 24, 2024
#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)
@quiqueg quiqueg deleted the fix-tracing-traceback-size-for-exceptions branch May 24, 2024 23:22
erikayasuda pushed a commit that referenced this pull request May 28, 2024
…9389)

Backport 1b954de from #9112 to 2.7.

#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

- [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: Matt Alexander <1710128+quiqueg@users.noreply.github.com>
erikayasuda pushed a commit that referenced this pull request May 28, 2024
…9390)

Backport 1b954de from #9112 to 2.8.

#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

- [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: Matt Alexander <1710128+quiqueg@users.noreply.github.com>
emmettbutler pushed a commit that referenced this pull request May 28, 2024
…9391)

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

- [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: Matt Alexander <1710128+quiqueg@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants