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.

Sign up for GitHub

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

Jump to bottom

fix(library): catch exceptions raised while enabling ddtrace integrations #11759

Merged
merged 1 commit into from
Dec 19, 2024
Merged

fix(library): catch exceptions raised while enabling ddtrace integrations #11759

merged 1 commit into from
Dec 19, 2024
+15 −11

Conversation

mabdinur
Copy link
Contributor

@mabdinur mabdinur commented Dec 17, 2024 •
edited by emmettbutler
Loading

Description

  • Improves the error message generated when ddtrace failed to patch/enable an integration.
  • Ensure patching modules and sub-modules are wrapped in a try-except. The ddtrace library should not crash an application if an integration can not be patched.

Motivation

Prevent issues like this: #11603

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 17, 2024 •
edited
Loading

CODEOWNERS have been resolved as:

releasenotes/notes/refactor-patch-error-ssi-1a2e9fe206d6d6df.yaml       @DataDog/apm-python
ddtrace/_monkey.py                                                      @DataDog/apm-core-python
tests/telemetry/test_telemetry.py                                       @DataDog/apm-python

@mabdinur mabdinur force-pushed the munir/refactor-patch-all branch from f5d84a5 to 7cfbf4c Compare December 17, 2024 18:16
@mabdinur mabdinur added the changelog/no-changelog A changelog entry is not required for this PR. label Dec 17, 2024
@mabdinur mabdinur marked this pull request as ready for review December 17, 2024 18:47
@mabdinur mabdinur requested review from a team as code owners December 17, 2024 18:47
@mabdinur mabdinur changed the title chore(library): avoids crashing on unsupported/broken integrations chore(library): catch exceptions raised while enabling ddtrace integrations Dec 17, 2024
@pr-commenter
Copy link

pr-commenter bot commented Dec 17, 2024 •
edited
Loading

Benchmarks

Benchmark execution time: 2024-12-18 20:07:22

Comparing candidate commit af74d5d in PR branch munir/refactor-patch-all with baseline commit a4f0e38 in branch main.

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

@mabdinur mabdinur force-pushed the munir/refactor-patch-all branch from 7cfbf4c to af74d5d Compare December 17, 2024 19:02
@mabdinur mabdinur changed the title chore(library): catch exceptions raised while enabling ddtrace integrations fix(library): catch exceptions raised while enabling ddtrace integrations Dec 17, 2024
@mabdinur mabdinur added backport 2.18 and removed changelog/no-changelog A changelog entry is not required for this PR. labels Dec 17, 2024
@mabdinur mabdinur force-pushed the munir/refactor-patch-all branch from 00d22bb to f462c15 Compare December 18, 2024 19:18
@mabdinur mabdinur requested a review from a team as a code owner December 18, 2024 19:18
@mabdinur mabdinur force-pushed the munir/refactor-patch-all branch 2 times, most recently from 135bc28 to af74d5d Compare December 18, 2024 19:23
@mabdinur mabdinur merged commit 79069a3 into main Dec 19, 2024
742 of 751 checks passed
@mabdinur mabdinur deleted the munir/refactor-patch-all branch December 19, 2024 18:31
github-actions bot pushed a commit that referenced this pull request Dec 19, 2024
@mabdinur @github-actions
fix(library): catch exceptions raised while enabling ddtrace integrat…
15a89f5 
…ions (#11759)

## Description

- Improves the error message generated when `ddtrace` failed to
patch/enable an integration.
- Ensure patching modules and sub-modules are wrapped in a try-except.
The ddtrace library should not crash an application if an integration
can not be patched.

## Motivation

Prevent issues like this:
#11603

## Checklist
- [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 Checklist
- [x] 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)

(cherry picked from commit 79069a3)
@github-actions github-actions bot mentioned this pull request Dec 19, 2024
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emmettbutler emmettbutler emmettbutler approved these changes

@taegyunkim taegyunkim Awaiting requested review from taegyunkim taegyunkim is a code owner automatically assigned from DataDog/apm-python

@christophe-papazian christophe-papazian Awaiting requested review from christophe-papazian christophe-papazian is a code owner automatically assigned from DataDog/apm-python

@erikayasuda erikayasuda Awaiting requested review from erikayasuda erikayasuda is a code owner automatically assigned from DataDog/apm-core-python

@rachelyangdog rachelyangdog Awaiting requested review from rachelyangdog rachelyangdog was automatically assigned from DataDog/apm-sdk-api-python

Assignees
No one assigned
Labels
backport 2.18
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mabdinur @emmettbutler