-
Notifications
You must be signed in to change notification settings - Fork 592
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 DB-API instrumentor support for MySQL driver sqlcommenting #2897
Open
tammy-baylis-swi
wants to merge
16
commits into
open-telemetry:main
Choose a base branch
from
tammy-baylis-swi:sqlcommenting-mysql-driver
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add DB-API instrumentor support for MySQL driver sqlcommenting #2897
tammy-baylis-swi
wants to merge
16
commits into
open-telemetry:main
from
tammy-baylis-swi:sqlcommenting-mysql-driver
Conversation
This file contains 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
tammy-baylis-swi
changed the title
WIP
Add DB-API instrumentor support for MySQL driver sqlcommenting
Oct 11, 2024
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 the shared DB-API instrumentor for continued support of psycopg2/psycopg instrumentor sqlcommenting, and adds prerequisite logic for support of MySQL driver instrumentor sqlcommenting. Motivation is to implement sqlcommenting later for mysql-connector, mysqlclient, pymysql instrumentors. Getting the names and versions of these modules is not consistent, therefore several "if/elif" added.
Fixes a small bug ("breaking change"?) where sqlcomment for both psycopg2/psycopg query always includes the KV
db_driver='psycopg2<VERSION>
. Now it will include eitherdb_driver='psycopg2<VERSION>
ordb_driver='psycopg<VERSION>
respectively.Adds an optimization to do most of
calculate_commenter_data
at init ofDatabaseApiIntegration
, instead of at everyCursorTracer.traced_execution
.Fixes #2902 partially -- other PRs to follow
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Updated and added unit tests. Used local installations of
opentelemetry-instrumentation-dbapi
and upstream dependencies with downstream instrumentors of mysql-connector, mysqlclient, pymysql, psycopg2, psycopg, sqlalchemy on apps that use respective db client drivers/ORM to query MySQL/PostgreSQL with general logs enabled to check sqlcomments.Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.