Add support for redis asyncio

Author: Zhenay

sentry_sdk/integrations/redis.py

@@ -9,6 +9,7 @@
 
 if MYPY:
     from typing import Any, Sequence
+    from sentry_sdk.tracing import Span
 
 _SINGLE_KEY_COMMANDS = frozenset(
     ["decr", "decrby", "get", "incr", "incrby", "pttl", "set", "setex", "setnx", "ttl"]
@@ -19,6 +20,31 @@
 _MAX_NUM_ARGS = 10
 
 
+def _set_pipeline_data(
+    span, is_cluster, get_command_args_fn, is_transaction, command_stack
+):
+    # type: (Span, bool, Any, bool, Sequence[Any]) -> None
+    span.set_tag("redis.is_cluster", is_cluster)
+    transaction = is_transaction if not is_cluster else False
+    span.set_tag("redis.transaction", transaction)
+
+    commands = []
+    for i, arg in enumerate(command_stack):
+        if i > _MAX_NUM_ARGS:
+            break
+        command_args = []
+        for j, command_arg in enumerate(get_command_args_fn(arg)):
+            if j > 0:
+                command_arg = repr(command_arg)
+            command_args.append(command_arg)
+        commands.append(" ".join(command_args))
+
+    span.set_data(
+        "redis.commands",
+        {"count": len(command_stack), "first_ten": commands},
+    )
+
+
 def patch_redis_pipeline(pipeline_cls, is_cluster, get_command_args_fn):
     # type: (Any, bool, Any) -> None
     old_execute = pipeline_cls.execute
@@ -34,31 +60,47 @@ def sentry_patched_execute(self, *args, **kwargs):
             op=OP.DB_REDIS, description="redis.pipeline.execute"
         ) as span:
             with capture_internal_exceptions():
-                span.set_tag("redis.is_cluster", is_cluster)
-                transaction = self.transaction if not is_cluster else False
-                span.set_tag("redis.transaction", transaction)
-
-                commands = []
-                for i, arg in enumerate(self.command_stack):
-                    if i > _MAX_NUM_ARGS:
-                        break
-                    command_args = []
-                    for j, command_arg in enumerate(get_command_args_fn(arg)):
-                        if j > 0:
-                            command_arg = repr(command_arg)
-                        command_args.append(command_arg)
-                    commands.append(" ".join(command_args))
-
-                span.set_data(
-                    "redis.commands",
-                    {"count": len(self.command_stack), "first_ten": commands},
+                _set_pipeline_data(
+                    span,
+                    is_cluster,
+                    get_command_args_fn,
+                    self.transaction,
+                    self.command_stack,
                 )
 
             return old_execute(self, *args, **kwargs)
 
     pipeline_cls.execute = sentry_patched_execute
 
 
+def patch_redis_async_pipeline(pipeline_cls):
+    # type: (Any) -> None
+    old_execute = pipeline_cls.execute
+
+    async def _sentry_execute(self, *args, **kwargs):
+        # type: (Any, *Any, **Any) -> Any
+        hub = Hub.current
+
+        if hub.get_integration(RedisIntegration) is None:
+            return await old_execute(self, *args, **kwargs)
+
+        with hub.start_span(
+            op=OP.DB_REDIS, description="redis.pipeline.execute"
+        ) as span:
+            with capture_internal_exceptions():
+                _set_pipeline_data(
+                    span,
+                    False,
+                    _get_redis_command_args,
+                    self.is_transaction,
+                    self.command_stack,
+                )
+
+            return await old_execute(self, *args, **kwargs)
+
+    pipeline_cls.execute = _sentry_execute
+
+
 def _get_redis_command_args(command):
     # type: (Any) -> Sequence[Any]
     return command[0]
@@ -69,6 +111,37 @@ def _parse_rediscluster_command(command):
     return command.args
 
 
+def _patch_redis(redis):
+    # type: (Any) -> None
+    patch_redis_client(redis.StrictRedis, is_cluster=False)
+    patch_redis_pipeline(redis.client.Pipeline, False, _get_redis_command_args)
+    try:
+        strict_pipeline = redis.client.StrictPipeline
+    except AttributeError:
+        pass
+    else:
+        patch_redis_pipeline(strict_pipeline, False, _get_redis_command_args)
+    try:
+        import redis.asyncio  # type: ignore
+    except ImportError:
+        pass
+    else:
+        patch_redis_async_client(redis.asyncio.client.StrictRedis)
+        patch_redis_async_pipeline(redis.asyncio.client.Pipeline)
+
+
+def _patch_rb():
+    # type: () -> None
+    try:
+        import rb.clients  # type: ignore
+    except ImportError:
+        pass
+    else:
+        patch_redis_client(rb.clients.FanoutClient, is_cluster=False)
+        patch_redis_client(rb.clients.MappingClient, is_cluster=False)
+        patch_redis_client(rb.clients.RoutingClient, is_cluster=False)
+
+
 def _patch_rediscluster():
     # type: () -> None
     try:
@@ -104,30 +177,46 @@ def setup_once():
         except ImportError:
             raise DidNotEnable("Redis client not installed")
 
-        patch_redis_client(redis.StrictRedis, is_cluster=False)
-        patch_redis_pipeline(redis.client.Pipeline, False, _get_redis_command_args)
-        try:
-            strict_pipeline = redis.client.StrictPipeline  # type: ignore
-        except AttributeError:
-            pass
-        else:
-            patch_redis_pipeline(strict_pipeline, False, _get_redis_command_args)
-
-        try:
-            import rb.clients  # type: ignore
-        except ImportError:
-            pass
-        else:
-            patch_redis_client(rb.clients.FanoutClient, is_cluster=False)
-            patch_redis_client(rb.clients.MappingClient, is_cluster=False)
-            patch_redis_client(rb.clients.RoutingClient, is_cluster=False)
+        _patch_redis(redis)
+        _patch_rb()
 
         try:
             _patch_rediscluster()
         except Exception:
             logger.exception("Error occurred while patching `rediscluster` library")
 
 
+def _get_span_description(name, *args):
+    # type: (str, *Any) -> str
+    description = name
+
+    with capture_internal_exceptions():
+        description_parts = [name]
+        for i, arg in enumerate(args):
+            if i > _MAX_NUM_ARGS:
+                break
+
+            description_parts.append(repr(arg))
+
+        description = " ".join(description_parts)
+
+    return description
+
+
+def _set_client_data(span, is_cluster, name, *args):
+    # type: (Span, bool, str, *Any) -> None
+    span.set_tag("redis.is_cluster", is_cluster)
+    if name:
+        span.set_tag("redis.command", name)
+
+    if name and args:
+        name_low = name.lower()
+        if (name_low in _SINGLE_KEY_COMMANDS) or (
+            name_low in _MULTI_KEY_COMMANDS and len(args) == 1
+        ):
+            span.set_tag("redis.key", args[0])
+
+
 def patch_redis_client(cls, is_cluster):
     # type: (Any, bool) -> None
     """
@@ -143,30 +232,32 @@ def sentry_patched_execute_command(self, name, *args, **kwargs):
         if hub.get_integration(RedisIntegration) is None:
             return old_execute_command(self, name, *args, **kwargs)
 
-        description = name
+        description = _get_span_description(name, *args)
 
-        with capture_internal_exceptions():
-            description_parts = [name]
-            for i, arg in enumerate(args):
-                if i > _MAX_NUM_ARGS:
-                    break
+        with hub.start_span(op=OP.DB_REDIS, description=description) as span:
+            _set_client_data(span, is_cluster, name, *args)
 
-                description_parts.append(repr(arg))
+            return old_execute_command(self, name, *args, **kwargs)
 
-            description = " ".join(description_parts)
+    cls.execute_command = sentry_patched_execute_command
 
-        with hub.start_span(op=OP.DB_REDIS, description=description) as span:
-            span.set_tag("redis.is_cluster", is_cluster)
-            if name:
-                span.set_tag("redis.command", name)
 
-            if name and args:
-                name_low = name.lower()
-                if (name_low in _SINGLE_KEY_COMMANDS) or (
-                    name_low in _MULTI_KEY_COMMANDS and len(args) == 1
-                ):
-                    span.set_tag("redis.key", args[0])
+def patch_redis_async_client(cls):
+    # type: (Any) -> None
+    old_execute_command = cls.execute_command
 
-            return old_execute_command(self, name, *args, **kwargs)
+    async def _sentry_execute_command(self, name, *args, **kwargs):
+        # type: (Any, str, *Any, **Any) -> Any
+        hub = Hub.current
 
-    cls.execute_command = sentry_patched_execute_command
+        if hub.get_integration(RedisIntegration) is None:
+            return await old_execute_command(self, name, *args, **kwargs)
+
+        description = _get_span_description(name, *args)
+
+        with hub.start_span(op=OP.DB_REDIS, description=description) as span:
+            _set_client_data(span, False, name, *args)
+
+            return await old_execute_command(self, name, *args, **kwargs)
+
+    cls.execute_command = _sentry_execute_command

tests/integrations/redis/test_redis.py

@@ -1,8 +1,14 @@
+import pytest
+
 from sentry_sdk import capture_message, start_transaction
 from sentry_sdk.integrations.redis import RedisIntegration
 
 from fakeredis import FakeStrictRedis
-import pytest
+
+try:
+    from fakeredis.aioredis import FakeRedis as AsyncFakeRedis
+except ImportError:
+    AsyncFakeRedis = None
 
 
 def test_basic(sentry_init, capture_events):
@@ -58,3 +64,66 @@ def test_redis_pipeline(sentry_init, capture_events, is_transaction):
         "redis.transaction": is_transaction,
         "redis.is_cluster": False,
     }
+
+
+@pytest.mark.asyncio
+@pytest.mark.skipif(
+    AsyncFakeRedis is None, reason="fakeredis.asyncio is not available."
+)
+async def test_async_basic(sentry_init, capture_events):
+    sentry_init(integrations=[RedisIntegration()])
+    events = capture_events()
+
+    connection = AsyncFakeRedis()
+
+    await connection.get("foobar")
+    capture_message("hi")
+
+    (event,) = events
+    (crumb,) = event["breadcrumbs"]["values"]
+
+    assert crumb == {
+        "category": "redis",
+        "message": "GET 'foobar'",
+        "data": {
+            "redis.key": "foobar",
+            "redis.command": "GET",
+            "redis.is_cluster": False,
+        },
+        "timestamp": crumb["timestamp"],
+        "type": "redis",
+    }
+
+
+@pytest.mark.parametrize("is_transaction", [False, True])
+@pytest.mark.asyncio
+@pytest.mark.skipif(
+    AsyncFakeRedis is None, reason="fakeredis.asyncio is not available."
+)
+async def test_async_redis_pipeline(sentry_init, capture_events, is_transaction):
+    sentry_init(integrations=[RedisIntegration()], traces_sample_rate=1.0)
+    events = capture_events()
+
+    connection = FakeStrictRedis()
+    with start_transaction():
+
+        pipeline = connection.pipeline(transaction=is_transaction)
+        pipeline.get("foo")
+        pipeline.set("bar", 1)
+        pipeline.set("baz", 2)
+        pipeline.execute()
+
+    (event,) = events
+    (span,) = event["spans"]
+    assert span["op"] == "db.redis"
+    assert span["description"] == "redis.pipeline.execute"
+    assert span["data"] == {
+        "redis.commands": {
+            "count": 3,
+            "first_ten": ["GET 'foo'", "SET 'bar' 1", "SET 'baz' 2"],
+        }
+    }
+    assert span["tags"] == {
+        "redis.transaction": is_transaction,
+        "redis.is_cluster": False,
+    }

tox.ini

@@ -333,7 +333,8 @@ deps =
     requests: requests>=2.0
 
     # Redis
-    redis: fakeredis<1.7.4
+    redis: fakeredis>=1.7.5
+    redis: pytest-asyncio
 
     # Redis Cluster
     rediscluster-v1: redis-py-cluster>=1.0.0,<2.0.0