-
Notifications
You must be signed in to change notification settings - Fork 641
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
Add mysqlclient instrumentor support for sqlcommenting #2941
Add mysqlclient instrumentor support for sqlcommenting #2941
Conversation
Going to close this and put in a fresh PR later. There's more that I want to add. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might have to fix CHANGELOG and move changes to "unreleased"
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Outdated
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Outdated
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Outdated
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Show resolved
Hide resolved
instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.py
Outdated
Show resolved
Hide resolved
...emetry-instrumentation-mysqlclient/src/opentelemetry/instrumentation/mysqlclient/__init__.py
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience with review!
…y#2941) * WIP * Add _DB_DRIVER_ALIASES * Add mysql_client_version to sqlcomment * lint * Fix existing tests * lint test * Add PyMySQL dbapi commenter case * Add test * Add test * Add test * Add tests * Changelog * calculate_commenter_data at init of DatabaseApiIntegration * Add mysqlclient sqlcomment support * Fix typo * try-except if NoneType module * Add unit test * CHangelog * mysqlclient instrument_connection with connect_module * add tests * more tests * more tests 2 * lint * Redesign tests * Rm unnecessary mocks
Description
Updates mysqlclient instrumentor to support sqlcommenting.
Depends on # 2897
Fixes # 2902
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Added unit tests. Used local installations of opentelemetry-instrumentation-dbapi (including updates from #2897) and upstream dependencies with this updated downstream instrumentor on a Flask app that use MySQLdb to query MySQL with general logs enabled to check sqlcomments.
Example general log entry after this update, which now includes sqlcomment:
2024-10-30T18:59:27.490681Z 10 Query SELECT * FROM city WHERE id = '1818' /*db_driver='MySQLdb%3A2.2.4',dbapi_level='2.0',dbapi_threadsafety=1,driver_paramstyle='format',mysql_client_version='3.3.8',traceparent='00-47db46923b76644d56b4ee08562f06d4-840aecaac0ab0b87-01'*/
Example corresponding exported span, whose span ID matches sqlcomment traceparent span ID:
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.