fix(celery): ensure error.message tag does not include stacktrace [backport 2.9] #9590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
) ## Motivation User reported that the celery exception traceback was being included in the `error.message` span tag. The error was due to us using the whole exception class, which includes the traceback, to set as the error message, instead of just the exception message. Updated test to ensure just error message is returned. ## 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: Tahir H. Butt <tahir.butt@datadoghq.com> (cherry picked from commit 16f3f95)
Datadog ReportBranch report: ✅ 0 Failed, 226 Passed, 50 Skipped, 19m 18.67s Total duration (1.19s time saved) |
gnufede
approved these changes
Jun 19, 2024
sanchda
approved these changes
Jul 19, 2024
Datadog ReportBranch report: ✅ 0 Failed, 46 Passed, 230 Skipped, 2m 8.55s Total duration (17m 7.98s time saved) |
P403n1x87
approved these changes
Jul 19, 2024
brettlangdon
approved these changes
Jul 19, 2024
erikayasuda
approved these changes
Jul 19, 2024
releasenotes/notes/fix-celery-error-messages-to-not-include-traceback-98259864e85be54f.yaml
Show resolved
Hide resolved
wconti27
approved these changes
Jul 19, 2024
sanchda
force-pushed
the
backport-9585-to-2.9
branch
from
aaa3bf0
to
f0e9e10
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport 16f3f95 from #9585 to 2.9.
Motivation
User reported that the celery exception traceback was being included in the
error.messagespan tag. The error was due to us using the whole exception class, which includes the traceback, to set as the error message, instead of just the exception message. Updated test to ensure just error message is returned.Checklist
changelog/no-changelogis set@DataDog/apm-tees.Reviewer Checklist