docs(dbapi): fix pyodbc connect method example#4684
Open
popsiclelmlm wants to merge 1 commit into
Open
Conversation
Assisted-by: ChatGPT 5
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.
Description
Summary
pyodbcto wrap the module-levelconnectcallable instead ofConnection.Reproduction
trace_integration(pyodbc, "Connection", "odbc")from the docs and did not see DBAPI spans."connect"made instrumentation work.Root cause
trace_integration/wrap_connectwrap the DBAPI module function that creates connections. Forpyodbc, that function ispyodbc.connect; usingConnectionin the example can lead users to wrap the wrong target.Changes
pyodbcexamples in the DBAPI instrumentation docs from"Connection"to"connect".Tests
python3 -m compileall -q instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapigit diff --checktox/uvbased test environments, because neithertoxnoruvis available in this local environment.Screenshots/Logs
Fixes #707
Type of change
How Has This Been Tested?
python3 -m compileall -q instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapigit diff --checkDoes This PR Require a Core Repo Change?
Checklist: