Fix instrumentation of SQLAlchemy when using sqlalchemy.engine_from_config by moredip · Pull Request #2816 · open-telemetry/opentelemetry-python-contrib

moredip · 2024-08-23T00:49:58Z

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.

linux-foundation-easycla · 2024-08-23T00:50:05Z

The committers listed above are authorized under a signed CLA.

✅ login: lzchen / name: Leighton Chen (c446d2e)
✅ login: moredip / name: Pete Hodgson (1a16277, cbb0447, e050086, 9f40f5d, 339f396, 67db7b9, ab6c5e4)
✅ login: emdneto / name: Emídio Neto (eeb464a, 0b7e6bd, f1369db, 2eef6f1)
✅ login: tammy-baylis-swi / name: Tammy Baylis (7e1a976, b0d9907)
✅ login: shalevr / name: Shalev Roda (8e0ba23)
✅ login: xrmx / name: Riccardo Magliocchetti (6781a66)

Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>

emdneto

oh wait, there's a pypy test failing 😓

…hing

tammy-baylis-swi · 2024-10-15T17:54:08Z

Thanks for putting this in! Currently 5 of the unit tests are failing with ModuleNotFoundError: No module named 'sqlalchemy.engine.create' which comes from sqlalchemy.engine.create being introduced in SQLAlchemy 2 but the tests are run in 1.1 and 1.4 (also tox.ini comment). The instrumentor doesn't seem to have bounds for supported SQLAlchemy version though, so I think it would be ok to bump the test-requirements versions. Please could you give that a try.

moredip · 2024-11-08T16:24:27Z

Thanks for putting this in! Currently 5 of the unit tests are failing with ModuleNotFoundError: No module named 'sqlalchemy.engine.create' which comes from sqlalchemy.engine.create being introduced in SQLAlchemy 2 but the tests are run in 1.1 and 1.4 (also tox.ini comment). The instrumentor doesn't seem to have bounds for supported SQLAlchemy version though, so I think it would be ok to bump the test-requirements versions. Please could you give that a try.

Sorry for dropping the ball on this for a while, @tammy-baylis-swi. I've not contributed to otel before, and not used tox before either; would you be able to elaborate on what I need to do with the test-requirements versions?

tammy-baylis-swi · 2024-11-08T18:05:15Z

Sorry for dropping the ball on this for a while, @tammy-baylis-swi. I've not contributed to otel before, and not used tox before either; would you be able to elaborate on what I need to do with the test-requirements versions?

No worries @moredip ! Coincidentally, yesterday we merged 2 PRs to address some of what I mentioned:

I'm going to merge main into this branch and reassess.

…hing

…/test_sqlalchemy.py Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com>

…hing

tammy-baylis-swi · 2024-11-21T21:25:33Z

Getting closer! Please could you run a tox -e ruff on your local and push the formatting change to get this to pass:

https://github.com/open-telemetry/opentelemetry-python-contrib/actions/runs/11960954700/job/33346209372?pr=2816

…hing

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

tammy-baylis-swi

Looks good to me. Thank you 😺

moredip · 2024-11-22T20:03:17Z

Looks good to me. Thank you 😺

Thanks so much for patiently shepherding me through! Very much appreciated 🙇

…hing

moredip · 2024-12-04T08:08:26Z

@tammy-baylis-swi @emdneto @xrmx is this OK to merge, or do I also need to wait on a 👍 from @shalevr

…onfig (open-telemetry#2816) * wrap sqlalchemy.engine.create.create_engine 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. * add changelog entry * Update CHANGELOG.md Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com> * Update instrumentation/opentelemetry-instrumentation-sqlalchemy/tests/test_sqlalchemy.py Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com> * make some monkey-patching conditional on the version of SQLAlchemy * lint * fix changelog Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> * Update CHANGELOG.md --------- Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Leighton Chen <lechen@microsoft.com> Co-authored-by: Shalev Roda <65566801+shalevr@users.noreply.github.com> Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com> Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

wrap sqlalchemy.engine.create.create_engine

9f40f5d

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.

github-actions Bot assigned shalevr Aug 23, 2024

github-actions Bot requested a review from shalevr August 23, 2024 00:50

add changelog entry

1a16277

moredip requested a review from a team August 23, 2024 00:51

emdneto reviewed Aug 23, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

xrmx approved these changes Aug 23, 2024

View reviewed changes

Update CHANGELOG.md

e050086

Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>

emdneto approved these changes Aug 23, 2024

View reviewed changes

emdneto requested changes Aug 23, 2024

View reviewed changes

lzchen and others added 2 commits August 23, 2024 12:24

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

c446d2e

…hing

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

8e0ba23

…hing

shalevr requested a review from a team as a code owner September 28, 2024 13:06

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

eeb464a

…hing

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

b0d9907

…hing

tammy-baylis-swi reviewed Nov 8, 2024

View reviewed changes

Comment thread instrumentation/opentelemetry-instrumentation-sqlalchemy/tests/test_sqlalchemy.py Outdated

Update instrumentation/opentelemetry-instrumentation-sqlalchemy/tests…

cbb0447

…/test_sqlalchemy.py Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com>

moredip requested a review from emdneto November 9, 2024 18:37

tammy-baylis-swi reviewed Nov 12, 2024

View reviewed changes

Comment thread ...elemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/__init__.py Outdated

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

7e1a976

…hing

emdneto reviewed Nov 12, 2024

View reviewed changes

Comment thread ...elemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/__init__.py Outdated

make some monkey-patching conditional on the version of SQLAlchemy

ab6c5e4

moredip and others added 2 commits November 21, 2024 17:02

lint

67db7b9

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

6781a66

…hing

emdneto reviewed Nov 22, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

fix changelog

0b7e6bd

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

emdneto reviewed Nov 22, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

Update CHANGELOG.md

2eef6f1

emdneto approved these changes Nov 22, 2024

View reviewed changes

tammy-baylis-swi approved these changes Nov 22, 2024

View reviewed changes

moredip and others added 2 commits December 3, 2024 09:51

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

339f396

…hing

Merge branch 'main' into fix-sqlalchemy-engine-from-config-monkeypatc…

f1369db

…hing

shalevr approved these changes Dec 4, 2024

View reviewed changes

shalevr merged commit 7617031 into open-telemetry:main Dec 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix instrumentation of SQLAlchemy when using sqlalchemy.engine_from_config#2816

Fix instrumentation of SQLAlchemy when using sqlalchemy.engine_from_config#2816
shalevr merged 16 commits into
open-telemetry:mainfrom
moredip:fix-sqlalchemy-engine-from-config-monkeypatching

moredip commented Aug 23, 2024 •

edited

Loading

Uh oh!

linux-foundation-easycla Bot commented Aug 23, 2024 •

edited

Loading

Uh oh!

Uh oh!

emdneto left a comment

Uh oh!

tammy-baylis-swi commented Oct 15, 2024

Uh oh!

moredip commented Nov 8, 2024

Uh oh!

tammy-baylis-swi commented Nov 8, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi commented Nov 21, 2024

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi left a comment

Uh oh!

moredip commented Nov 22, 2024

Uh oh!

moredip commented Dec 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

moredip commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

linux-foundation-easycla Bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

emdneto left a comment

Choose a reason for hiding this comment

Uh oh!

tammy-baylis-swi commented Oct 15, 2024

Uh oh!

moredip commented Nov 8, 2024

Uh oh!

tammy-baylis-swi commented Nov 8, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi commented Nov 21, 2024

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi left a comment

Choose a reason for hiding this comment

Uh oh!

moredip commented Nov 22, 2024

Uh oh!

moredip commented Dec 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

moredip commented Aug 23, 2024 •

edited

Loading

linux-foundation-easycla Bot commented Aug 23, 2024 •

edited

Loading