Skip to content

mysqlclient: add capture_parameters option#4800

Draft
ocelotl wants to merge 2 commits into
open-telemetry:mainfrom
ocelotl:issue_4790_mysqlclient_capture_parameters
Draft

mysqlclient: add capture_parameters option#4800
ocelotl wants to merge 2 commits into
open-telemetry:mainfrom
ocelotl:issue_4790_mysqlclient_capture_parameters

Conversation

@ocelotl

@ocelotl ocelotl commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Description

Threads a capture_parameters option through the mysqlclient instrumentor to the shared DB-API layer, so parameters are recorded as db.query.parameter.<key>.

Part of #4787. Fixes #4790.

Stacked on #4788 (the shared dbapi base + _set_db_query_parameters helper). Until #4788 merges, this PR's diff is cumulative and includes those base changes; it will be rebased onto main afterwards.

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

  • Could not run in this environment (native MySQLdb driver requires system libs and is not buildable here). The change is the same passthrough as the other MySQL-family PRs; ruff is clean and the module compiles.

Does This PR Require a Core Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

ocelotl added 2 commits July 11, 2026 11:53
Add a shared _set_db_query_parameters helper that emits one
db.query.parameter.<key> attribute per prepared-statement parameter,
keyed by name for named parameters and by 0-based index for positional
parameters, with values stringified.

Wire it into the dbapi CursorTracer so that, when capture_parameters is
enabled, the legacy db.statement.parameters attribute is reported only in
the old semconv while db.query.parameter.<key> is reported in the new
(stable) database semconv. Parameters are not captured on batch
operations (executemany), per the semantic conventions.
Thread a capture_parameters flag through MySQLClientInstrumentor so users
can enable prepared-statement parameter capture. The flag is read in
_instrument and passed to dbapi.wrap_connect, and exposed as a parameter on
instrument_connection which forwards it to dbapi.instrument_connection.
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.

opentelemetry-instrumentation-mysqlclient: expose capture_parameters

1 participant