Add redis client-specific instrumentation #3142
Closed
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
This PR allows instrumenting only a specific Redis client instead of the whole class (and all clients).
Changes:
instrument_client(supports any of the existing clients such as async/cluster)instrumentand the newly addedinstrument_clientmethods (still allows**kwargs). Makes the docs easier to read/understand.Please delete options that are not relevant.
How Has This Been Tested?
Ran the already included tests with
python3.12andpython3.11andredis 5.0.1. Added more tests to ensure that only the client that we instrumented produces spans. Ran tox tests, ruff, linting, formatting, etc. (everythin in the contributing guide).Tested docs changes with

tox -e docsto ensure everything builds correctly and looks good.Also, ran tests with coverage: original coverage was 77% now it's 80%:
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.