fixed compatibility issues with redis-py 3.0

backport of #336 to the 3.x branch

Author: beniwohli

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v3.0.4
+[Check the diff](https://github.com/elastic/apm-agent-python/compare/v3.0.3...v3.0.4)
+
+ * fixed an issue with instrumenting redis-py 3.0+
+
 ## v3.0.3
 [Check the diff](https://github.com/elastic/apm-agent-python/compare/v3.0.2...v3.0.3)
  * fixed an issue when logging messages that are not strings (#295, #312)

elasticapm/instrumentation/packages/redis.py

@@ -1,10 +1,29 @@
+from __future__ import absolute_import
+
 from elasticapm.instrumentation.packages.base import AbstractInstrumentedModule
 from elasticapm.traces import capture_span
 
 
-class RedisInstrumentation(AbstractInstrumentedModule):
+class Redis3CheckMixin(object):
+    instrument_list_3 = []
+    instrument_list = []
+
+    def get_instrument_list(self):
+        try:
+            from redis import VERSION
+
+            if VERSION[0] >= 3:
+                return self.instrument_list_3
+            return self.instrument_list
+        except ImportError:
+            return self.instrument_list
+
+
+class RedisInstrumentation(Redis3CheckMixin, AbstractInstrumentedModule):
     name = "redis"
 
+    # no need to instrument StrictRedis in redis-py >= 3.0
+    instrument_list_3 = [("redis.client", "Redis.execute_command")]
     instrument_list = [("redis.client", "Redis.execute_command"), ("redis.client", "StrictRedis.execute_command")]
 
     def call(self, module, method, wrapped, instance, args, kwargs):
@@ -17,9 +36,11 @@ def call(self, module, method, wrapped, instance, args, kwargs):
             return wrapped(*args, **kwargs)
 
 
-class RedisPipelineInstrumentation(AbstractInstrumentedModule):
+class RedisPipelineInstrumentation(Redis3CheckMixin, AbstractInstrumentedModule):
     name = "redis"
 
+    # BasePipeline has been renamed to Pipeline in redis-py 3
+    instrument_list_3 = [("redis.client", "Pipeline.execute")]
     instrument_list = [("redis.client", "BasePipeline.execute")]
 
     def call(self, module, method, wrapped, instance, args, kwargs):

tests/instrumentation/redis_tests.py

@@ -33,11 +33,7 @@ def test_pipeline(instrument, elasticapm_client, redis_conn):
     transactions = elasticapm_client.transaction_store.get_all()
     spans = transactions[0]["spans"]
 
-    expected_signatures = {"test_pipeline", "StrictPipeline.execute"}
-
-    assert {t["name"] for t in spans} == expected_signatures
-
-    assert spans[0]["name"] == "StrictPipeline.execute"
+    assert spans[0]["name"] in ("StrictPipeline.execute", "Pipeline.execute")
     assert spans[0]["type"] == "cache.redis"
 
     assert spans[1]["name"] == "test_pipeline"
@@ -63,11 +59,7 @@ def test_rq_patches_redis(instrument, elasticapm_client, redis_conn):
     transactions = elasticapm_client.transaction_store.get_all()
     spans = transactions[0]["spans"]
 
-    expected_signatures = {"test_pipeline", "StrictPipeline.execute"}
-
-    assert {t["name"] for t in spans} == expected_signatures
-
-    assert spans[0]["name"] == "StrictPipeline.execute"
+    assert spans[0]["name"] in ("StrictPipeline.execute", "Pipeline.execute")
     assert spans[0]["type"] == "cache.redis"
 
     assert spans[1]["name"] == "test_pipeline"