Expose capture_parameters in mysqlclient instrumentation - #4911
Open
saisharan0103 wants to merge 1 commit into
Open
Conversation
…qlclient`: expose `capture_parameters` Closes open-telemetry#4790
|
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
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.
The mysqlclient instrumentor delegates span creation and SQL parameter capture to the shared dbapi instrumentation, but it did not expose or forward dbapi's
capture_parametersoption. CallingMySQLClientInstrumentor().instrument(capture_parameters=True)silently dropped the option beforedbapi.wrap_connect, andinstrument_connection(..., capture_parameters=True)was not accepted or forwarded todbapi.instrument_connection, so the dbapi layer always behaved as if parameter capture was disabled.This change mirrors the existing dbapi and psycopg2 option threading by reading
capture_parameters = kwargs.get("capture_parameters", False)in_instrumentand passing it todbapi.wrap_connect. It also adds acapture_parameters=Falseargument toinstrument_connectionand forwards it todbapi.instrument_connection.The module docstring now documents the option near the existing configuration sections. The mysqlclient mocked dbapi forwarding tests were extended to assert the default and explicit forwarded values, and a focused span assertion was added under stable database semantic conventions for
db.query.parameter.<key>emission from the dbapi base.Fixes #4790
ruff check instrumentation/opentelemetry-instrumentation-mysqlclient/src/opentelemetry/instrumentation/mysqlclient/__init__.py instrumentation/opentelemetry-instrumentation-mysqlclient/tests/test_mysqlclient_integration.pyreports no new findings on the changed files.Ran
pytest -xlocally with no new failures.