Expose capture_parameters in PyMySQL instrumentation - #4910
Open
saisharan0103 wants to merge 1 commit into
Open
Conversation
…ysql`: expose `capture_parameters` Closes open-telemetry#4791
|
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.
Issue #4791 notes that
opentelemetry-instrumentation-pymysqldelegates span creation to the shared dbapi instrumentation, but did not accept or forward the dbapi layer'scapture_parametersoption. That left PyMySQL users unable to enable parameter capture through eitherPyMySQLInstrumentor().instrument(capture_parameters=True)orPyMySQLInstrumentor().instrument_connection(conn, capture_parameters=True), even though dbapi supports the option and keeps it disabled by default.This change mirrors the existing psycopg2/dbapi option plumbing for PyMySQL:
capture_parametersfrom_instrumentkwargs with aFalsedefaultcapture_parameterstoinstrument_connectiondbapi.wrap_connectanddbapi.instrument_connectioncapture_parametersin the module docstringModified files:
instrumentation/opentelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.pyinstrumentation/opentelemetry-instrumentation-pymysql/tests/test_pymysql_integration.pyruff check instrumentation/opentelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.py instrumentation/opentelemetry-instrumentation-pymysql/tests/test_pymysql_integration.pyreports no new findings on the changed files.Ran
pytest -xlocally with no new failures.