Fix instrumentation of SQLAlchemy when using sqlalchemy.engine_from_config

[moredip]

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

[linux-foundation-easycla]

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)

[emdneto]

oh wait, there's a pypy test failing 😓

[tammy-baylis-swi]

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]

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]

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:

• fix: teach instrument version constraint for sqlalchemy #2971
• Update tests to work with SQLAlchemy 2 #2976

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

[tammy-baylis-swi]

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

[tammy-baylis-swi]

Looks good to me. Thank you 😺

[moredip]

Looks good to me. Thank you 😺

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

[moredip]

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