-
Notifications
You must be signed in to change notification settings - Fork 628
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
Open
OlegZv
wants to merge
8
commits into
open-telemetry:main
Choose a base branch
from
OlegZv:add_redis_client_only_instrumentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add redis client only instrumentation #3143
OlegZv
wants to merge
8
commits into
open-telemetry:main
from
OlegZv:add_redis_client_only_instrumentation
Conversation
This file contains 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
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? |
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
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.