-
Notifications
You must be signed in to change notification settings - Fork 671
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add redis client only instrumentation #3143
base: main
Are you sure you want to change the base?
Add redis client only instrumentation #3143
Conversation
add a helper function assert_span_count to simplify tests add unit tests for pipeline hooks
@OlegZv we can only accept contributions covered by the CLA, please sign it. |
Of course! I have already received a pre-approval for this contribution. Pending is the CLA review. Hopefully, I'll get a response soon. Can we still proceed to review these changes so I can work on any comments/change requests in the meantime? |
@xrmx, the CLA is finally good to go! |
Yay! Thank you! How does one get an approval for the PR? Is there something this PR is missing? |
...tion/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
Outdated
Show resolved
Hide resolved
...tion/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
Show resolved
Hide resolved
...tion/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
Show resolved
Hide resolved
I think I'll wait for the approval before doing "Update branch". |
Hello @xrmx! Thanks again for the review. Are my responses satisfactory or do you want me to address anything else? |
Hello all! Is this PR missing anything needed for approval? |
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)instrument
and the newly addedinstrument_client
methods (still allows**kwargs
). It 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.12
andpython3.11
andredis 5.0.1
. Added more tests to ensure that only the client we instrumented produces spans. I ran tox tests, ruff, linting, formatting, etc. (everything in the contributing guide).Tested documentation changes with

tox -e docs
to ensure everything builds correctly and looks good.Also, I ran tests with coverage: original coverage was 77%. Now it's 80%:
Note: I plan to add another PR for the FT-related commands later. (there's currently a bug in some span param parsing functions)
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.