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! |
|
Could someone please review and approve? |
emdneto
left a comment
There was a problem hiding this comment.
Thanks for the work on this one! I left some comments, but the changes LGTM. I'll give it a try.
…py. Tested and verified docs.
|
@emdneto Thank you for the review. I implemented the changes you mentioned. Tested the resulting library with tox and regenerated the docs locally. The tests passed, and the docs look as before. The only thing left, I think, is the question about the |
emdneto
left a comment
There was a problem hiding this comment.
LEft small nit. Don't want to block. Thanks!!
|
@OlegZv please fix CI |
Fixed! Sorry for the delay. |
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). 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.12andpython3.11andredis 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 docsto 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.