Add PyMySQL instrumentor support for sqlcommenting#2942
Merged
xrmx merged 31 commits intoopen-telemetry:mainfrom Nov 21, 2024
Merged
Add PyMySQL instrumentor support for sqlcommenting#2942xrmx merged 31 commits intoopen-telemetry:mainfrom
xrmx merged 31 commits intoopen-telemetry:mainfrom
Conversation
10 tasks
4 tasks
Contributor
Author
|
Going to close this and put in a fresh PR later. There's more that I want to add. |
Contributor
Author
|
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 PyMySQL driver might generate. The driver implementation seems to not support prepared statements (absence in docs here), so it seems to not be an issue. |
lzchen
approved these changes
Nov 19, 2024
11 tasks
Contributor
Author
|
Working on revisions similar to #2941 at the moment. Will update when done and ready. EDIT: This is done. |
xrmx
approved these changes
Nov 21, 2024
13 tasks
xrmx
added a commit
to xrmx/opentelemetry-python-contrib
that referenced
this pull request
Jan 24, 2025
* 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 * try-except if NoneType module * Add pymysql sqlcomment support * Add unit tests * Update docstring * Changelog * pymysql instrument_connection specifies connect_module * lint * Add tests * Fix doc --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updates PyMySQL 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 (in ##2897) and upstream dependencies with this updated downstream instrumentor on a Flask app that use PyMySQL to query MySQL with general logs enabled to check sqlcomments.
Example general log entry after this update, which now includes sqlcomment:
2024-10-30T19:33:46.830661Z 25 Query SELECT * FROM city WHERE id = '1818' /*db_driver='pymysql%3A1.4.6',dbapi_level='2.0',dbapi_threadsafety=1,driver_paramstyle='pyformat',mysql_client_version='1.4.6',traceparent='00-f8688332bc5467bfa8fe1a9753d7271a-f7add29c81e79082-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.