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(celery): ensure error.message tag does not include stacktrace [backport 2.10] #9591

Merged
merged 2 commits into from
Jun 20, 2024

Conversation

github-actions[bot]
Copy link

@github-actions github-actions bot commented Jun 18, 2024

Backport 16f3f95 from #9585 to 2.10.

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

  • 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

)

## 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-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: backport-9585-to-2.10
Commit report: 70bbbb0
Test service: dd-trace-py

✅ 0 Failed, 194 Passed, 82 Skipped, 22m 2.2s Total duration (51.24s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jun 18, 2024

Benchmarks

Benchmark execution time: 2024-06-19 08:27:41

Comparing candidate commit d8d0c2a in PR branch backport-9585-to-2.10 with baseline commit 70b27a2 in branch 2.10.

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

@gnufede gnufede closed this Jun 19, 2024
@gnufede gnufede reopened this Jun 19, 2024
@gnufede gnufede enabled auto-merge (squash) June 19, 2024 07:41
@gnufede gnufede merged commit da7ecdc into 2.10 Jun 20, 2024
109 of 116 checks passed
@gnufede gnufede deleted the backport-9585-to-2.10 branch June 20, 2024 13:25
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.

None yet

3 participants