sqlalchemy: add capture_parameters option for db.query.parameter.<key>#4807
Draft
ocelotl wants to merge 2 commits into
Draft
sqlalchemy: add capture_parameters option for db.query.parameter.<key>#4807ocelotl wants to merge 2 commits into
ocelotl wants to merge 2 commits into
Conversation
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.
Add a capture_parameters option to the SQLAlchemy instrumentation that records prepared statement parameters as db.query.parameter.<key> span attributes under the new database semantic conventions. Named parameters are keyed by name and positional parameters by 0-based index. Capture is disabled by default and skipped for executemany calls. Values may be sensitive, so it must be opted into explicitly.
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
1 participant
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
Adds a
capture_parametersoption to the SQLAlchemy instrumentor and records parameters asdb.query.parameter.<key>under the new database semconv, not onexecutemanybatches.Part of #4787. Fixes #4797.
Type of change
How Has This Been Tested?
Does This PR Require a Core Repo Change?
Checklist: