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 instrumentation of SQLAlchemy when using sqlalchemy.engine_from_config #2816

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

moredip
Copy link

@moredip moredip commented Aug 23, 2024

Description

Fixes a bug where SQLAlchemy engines created via sqlalchemy.engine_from_config(...) are not instrumented by SQLAlchemyInstrumentor.

sqlalchemy.engine_from_config(...) directly calls create_engine(...) imported from sqlalchemy.engine.create. If we don't wrap that copy of the create_engine method then engines created via engine_from_config are not
instrumented.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Added a unit test
  • ran it and checked that it failed
  • made the fix
  • verified that the test now passes

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

sqlalchemy.engine_from_config directly calls create_engine imported from that path; if we don't
wrap that copy of the `create_engine` call then engines created via engine_from_config are not
instrumented.
Copy link

linux-foundation-easycla bot commented Aug 23, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@moredip moredip requested a review from a team as a code owner August 23, 2024 00:51
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Emídio Neto <[email protected]>
Copy link
Member

@emdneto emdneto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh wait, there's a pypy test failing 😓

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.

5 participants