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 mysqlclient instrumentor support for sqlcommenting #2941

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

tammy-baylis-swi
Copy link
Contributor

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

Description

Updates mysqlclient instrumentor to support sqlcommenting.

Depends on # 2897

Fixes # 2902

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?

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:

InstrumentationScope opentelemetry.instrumentation.mysqlclient 0.49b0.dev
Span #0
    Trace ID       : 47db46923b76644d56b4ee08562f06d4
    Parent ID      : e27f1caee467892f
    ID             : 840aecaac0ab0b87
    Name           : SELECT
    Kind           : Client
    Start time     : 2024-10-30 18:59:27.490061885 +0000 UTC
    End time       : 2024-10-30 18:59:27.491399426 +0000 UTC
    Status code    : Unset
    Status message :
Attributes:
     -> db.system: Str(mysql)
     -> db.name: Str()
     -> db.statement: Str(SELECT * FROM city WHERE id = %s)
     -> net.peer.port: Int(3306)

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

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.

1 participant