Skip to content
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
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

tammy-baylis-swi
Copy link
Contributor

@tammy-baylis-swi tammy-baylis-swi commented Oct 9, 2024

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 either db_driver='psycopg2<VERSION> or db_driver='psycopg<VERSION> respectively.

Adds an optimization to do most of calculate_commenter_data at init of DatabaseApiIntegration, instead of at every CursorTracer.traced_execution.

Fixes #2902 partially -- other PRs to follow

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?

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?

  • 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

@tammy-baylis-swi tammy-baylis-swi changed the title WIP Add DB-API instrumentor support for MySQL driver sqlcommenting Oct 11, 2024
@tammy-baylis-swi tammy-baylis-swi marked this pull request as ready for review October 15, 2024 16:42
@tammy-baylis-swi tammy-baylis-swi requested a review from a team as a code owner October 15, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add sqlcommenting support to MySQL driver instrumentors
1 participant