-
Notifications
You must be signed in to change notification settings - Fork 607
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
base: main
Are you sure you want to change the base?
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. |
Re-opening this PR for review, when others have a moment please 😺 I researched how this instrumentation's support of sqlcommenting would affect prepared statements that mysqlclient/MySQLdb driver might generate. The driver implementation seems to not support prepared statements (absence in docs here), so it seems to not be an issue. |
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.