Handle redis.exceptions.WatchError as a non-error event in instrumentation #2668
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
…9-dev # Conflicts: # instrumentation/opentelemetry-instrumentation-redis/tests/test_redis.py
Bugfix 2639 dev
fetch update
Bugfix 2639 dev
zhihali
changed the title
zhihali
changed the title
emdneto
reviewed
Jul 7, 2024
emdneto
reviewed
Jul 7, 2024
xrmx
reviewed
Jul 9, 2024
...tion/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
Outdated
Show resolved
Hide resolved
remove fakeredis from tox.ini better code format
emdneto
reviewed
Jul 10, 2024
Yes, and updated. Thanks for the review |
xrmx
reviewed
Jul 10, 2024
...tion/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
Outdated
Show resolved
Hide resolved
xrmx
approved these changes
Jul 12, 2024
emdneto
approved these changes
Jul 15, 2024
6 tasks
|
Hi folks, shouldn't the |
chrisguidry
reviewed
Jul 17, 2024
Comment on lines
+403
to
+412
| try: | ||
| redis_client = FakeRedis() | ||
| async with redis_client.pipeline(transaction=False) as pipe: | ||
| await pipe.watch("a") | ||
| await redis_client.set("a", "bad") | ||
| pipe.multi() | ||
| await pipe.set("a", "1") | ||
| await pipe.execute() | ||
| except WatchError: | ||
| pass |
There was a problem hiding this comment.
I'd recommend this instead, so that we ensure the WatchError is still raised
Suggested change
| try: | |
| redis_client = FakeRedis() | |
| async with redis_client.pipeline(transaction=False) as pipe: | |
| await pipe.watch("a") | |
| await redis_client.set("a", "bad") | |
| pipe.multi() | |
| await pipe.set("a", "1") | |
| await pipe.execute() | |
| except WatchError: | |
| pass | |
| with pytest.raises(WatchError): | |
| redis_client = FakeRedis() | |
| async with redis_client.pipeline(transaction=False) as pipe: | |
| await pipe.watch("a") | |
| await redis_client.set("a", "bad") | |
| pipe.multi() | |
| await pipe.set("a", "1") | |
| await pipe.execute() |
Comment on lines
+362
to
+371
| try: | ||
| redis_client = fakeredis.FakeStrictRedis() | ||
| pipe = redis_client.pipeline(transaction=True) | ||
| pipe.watch("a") | ||
| redis_client.set("a", "bad") # This will cause the WatchError | ||
| pipe.multi() | ||
| pipe.set("a", "1") | ||
| pipe.execute() | ||
| except WatchError: | ||
| pass |
There was a problem hiding this comment.
Suggested change
| try: | |
| redis_client = fakeredis.FakeStrictRedis() | |
| pipe = redis_client.pipeline(transaction=True) | |
| pipe.watch("a") | |
| redis_client.set("a", "bad") # This will cause the WatchError | |
| pipe.multi() | |
| pipe.set("a", "1") | |
| pipe.execute() | |
| except WatchError: | |
| pass | |
| with pytest.raises(WatchError): | |
| redis_client = fakeredis.FakeStrictRedis() | |
| pipe = redis_client.pipeline(transaction=True) | |
| pipe.watch("a") | |
| redis_client.set("a", "bad") # This will cause the WatchError | |
| pipe.multi() | |
| pipe.set("a", "1") | |
| pipe.execute() |
|
@chrisguidry please open a new PR with the fix, you're commenting a PR already merged |
chrisguidry
added a commit
to chrisguidry/opentelemetry-python-contrib
that referenced
this pull request
Jul 17, 2024
In open-telemetry#2668, we started to avoid having the `redis.WatchError` mark the span as having failed, but we were inadvertently suppressing that exception from the calling code. `redis.WatchError` is used for flow-of-control concurrency in many applications, and applications depend on catching the error to handle concurrent changes to keys during redis pipelines. This re-raises the `WatchError` to keep the instrumentation transparent to the application. Fixes open-telemetry#2639
11 tasks
chrisguidry
added a commit
to chrisguidry/opentelemetry-python-contrib
that referenced
this pull request
Jul 18, 2024
In open-telemetry#2668, we started to avoid having the `redis.WatchError` mark the span as having failed, but we were inadvertently suppressing that exception from the calling code. `redis.WatchError` is used for flow-of-control concurrency in many applications, and applications depend on catching the error to handle concurrent changes to keys during redis pipelines. This re-raises the `WatchError` to keep the instrumentation transparent to the application. Fixes open-telemetry#2639
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
Fixes # (issue)
When we face the WatchError when running redis instrumentation, Status Code: The status_code should be "UNSET" instead of "ERROR",
#2639
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
py312-test-instrumentation-redis
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.