feat(integrations): add support for cluster clients from redis sdk

sentry_sdk/integrations/redis/__init__.py

@@ -13,10 +13,10 @@
 )
 
 if TYPE_CHECKING:
     from collections.abc import Callable
     from typing import Any, Dict, Sequence
     from redis import Redis, RedisCluster
     from redis.asyncio.cluster import (
         RedisCluster as AsyncRedisCluster,
         ClusterPipeline as AsyncClusterPipeline,
     )
@@ -141,12 +141,15 @@
 
 
 def _set_db_data(span, redis_instance):
-    # type: (Span, Redis) -> None
-    _set_db_data_on_span(span, redis_instance.connection_pool.connection_kwargs)
+    # type: (Span, Redis[Any]) -> None
+    try:
+        _set_db_data_on_span(span, redis_instance.connection_pool.connection_kwargs)
+    except AttributeError:
+        pass  # connections_kwargs may be missing in some cases
 
 
 def _set_cluster_db_data(span, redis_cluster_instance):
-    # type: (Span, RedisCluster) -> None
+    # type: (Span, RedisCluster[Any]) -> None
     default_node = redis_cluster_instance.get_default_node()
     if default_node is not None:
         _set_db_data_on_span(
@@ -155,15 +158,20 @@
 
 
 def _set_async_cluster_db_data(span, async_redis_cluster_instance):
-    # type: (Span, AsyncRedisCluster) -> None
+    # type: (Span, AsyncRedisCluster[Any]) -> None
     default_node = async_redis_cluster_instance.get_default_node()
     if default_node is not None and default_node.connection_kwargs is not None:
         _set_db_data_on_span(span, default_node.connection_kwargs)
 
 
 def _set_async_cluster_pipeline_db_data(span, async_redis_cluster_pipeline_instance):
-    # type: (Span, AsyncClusterPipeline) -> None
-    _set_async_cluster_db_data(span, async_redis_cluster_pipeline_instance._client)
+    # type: (Span, AsyncClusterPipeline[Any]) -> None
+    _set_async_cluster_db_data(
+        span,
+        # the AsyncClusterPipeline has always had a `_client` attr but it is private so potentially problematic and mypy
+        # does not recognize it - see https://github.com/redis/redis-py/blame/v5.0.0/redis/asyncio/cluster.py#L1386
+        async_redis_cluster_pipeline_instance._client,  # type: ignore[attr-defined]
+    )
 
 
 def patch_redis_pipeline(pipeline_cls, is_cluster, get_command_args_fn, set_db_data_fn):
@@ -237,7 +245,7 @@
     except AttributeError:
         pass
     else:
         patch_redis_pipeline(
             strict_pipeline, False, _get_redis_command_args, _set_db_data
         )
 
@@ -310,13 +318,13 @@
     except ImportError:
         pass
     else:
         patch_redis_client(
             rb.clients.FanoutClient, is_cluster=False, set_db_data_fn=_set_db_data
         )
         patch_redis_client(
             rb.clients.MappingClient, is_cluster=False, set_db_data_fn=_set_db_data
         )
         patch_redis_client(
             rb.clients.RoutingClient, is_cluster=False, set_db_data_fn=_set_db_data
         )
 
@@ -328,7 +336,7 @@
     except ImportError:
         return
 
     patch_redis_client(
         rediscluster.RedisCluster, is_cluster=True, set_db_data_fn=_set_db_data
     )
 
@@ -340,7 +348,7 @@
     # https://github.com/Grokzen/redis-py-cluster/blob/master/docs/release-notes.rst
     if (0, 2, 0) < version < (2, 0, 0):
         pipeline_cls = rediscluster.pipeline.StrictClusterPipeline
         patch_redis_client(
             rediscluster.StrictRedisCluster,
             is_cluster=True,
             set_db_data_fn=_set_db_data,
@@ -348,7 +356,7 @@
     else:
         pipeline_cls = rediscluster.pipeline.ClusterPipeline
 
     patch_redis_pipeline(
         pipeline_cls, True, _parse_rediscluster_command, set_db_data_fn=_set_db_data
     )
 

sentry_sdk/integrations/redis/asyncio.py

@@ -13,14 +13,16 @@
 from sentry_sdk.utils import capture_internal_exceptions
 
 if TYPE_CHECKING:
     from collections.abc import Callable
-    from typing import Any
+    from typing import Any, Union
+    from redis.asyncio.client import Pipeline, StrictRedis
+    from redis.asyncio.cluster import ClusterPipeline, RedisCluster
 
 
 def patch_redis_async_pipeline(
     pipeline_cls, is_cluster, get_command_args_fn, set_db_data_fn
 ):
-    # type: (type, bool, Any, Callable[[Span, Any], None]) -> None
+    # type: (Union[type[Pipeline[Any]], type[ClusterPipeline[Any]]], bool, Any, Callable[[Span, Any], None]) -> None
     old_execute = pipeline_cls.execute
 
     async def _sentry_execute(self, *args, **kwargs):
@@ -45,11 +47,11 @@
 
             return await old_execute(self, *args, **kwargs)
 
-    pipeline_cls.execute = _sentry_execute
+    pipeline_cls.execute = _sentry_execute  # type: ignore[method-assign]
 
 
 def patch_redis_async_client(cls, is_cluster, set_db_data_fn):
-    # type: (type, bool, Callable[[Span, Any], None]) -> None
+    # type: (Union[type[StrictRedis[Any]], type[RedisCluster[Any]]], bool, Callable[[Span, Any], None]) -> None
     old_execute_command = cls.execute_command
 
     async def _sentry_execute_command(self, name, *args, **kwargs):
@@ -67,4 +69,4 @@
 
             return await old_execute_command(self, name, *args, **kwargs)
 
-    cls.execute_command = _sentry_execute_command
+    cls.execute_command = _sentry_execute_command  # type: ignore[method-assign]

tests/integrations/redis/cluster/test_redis_cluster.py

@@ -17,7 +17,7 @@ def monkeypatch_rediscluster_class(reset_integrations):
         "localhost", 6379
     )
     pipeline_cls.execute = lambda *_, **__: None
-    redis.RedisCluster.execute_command = lambda *_, **__: None
+    redis.RedisCluster.execute_command = lambda *_, **__: []
 
 
 def test_rediscluster_breadcrumb(sentry_init, capture_events):
@@ -29,7 +29,15 @@ def test_rediscluster_breadcrumb(sentry_init, capture_events):
     capture_message("hi")
 
     (event,) = events
-    (crumb,) = event["breadcrumbs"]["values"]
+    crumbs = event["breadcrumbs"]["values"]
+
+    # on initializing a RedisCluster, a COMMAND call is made - this is not important for the test
+    # but must be accounted for
+    assert len(crumbs) <= 2
+    if len(crumbs) == 2:
+        assert event["breadcrumbs"]["values"][0]["message"] == "COMMAND"
+
+    crumb = event["breadcrumbs"]["values"][-1]
 
     assert crumb == {
         "category": "redis",
@@ -65,7 +73,15 @@ def test_rediscluster_basic(sentry_init, capture_events, send_default_pii, descr
         rc.set("bar", 1)
 
     (event,) = events
-    (span,) = event["spans"]
+    spans = event["spans"]
+
+    # on initializing a RedisCluster, a COMMAND call is made - this is not important for the test
+    # but must be accounted for
+    assert len(spans) <= 2
+    if len(spans) == 2:
+        assert event["spans"][0]["description"] == "COMMAND"
+
+    span = event["spans"][-1]
     assert span["op"] == "db.redis"
     assert span["description"] == description
     assert span["data"] == {