Add support for redis v5. (#895)

* Instrumentat methods added in redis v5 release.

* Update metrics in redis tests.

Author: umaannamalai

newrelic/hooks/datastore_redis.py

@@ -161,6 +161,7 @@
     "cluster_reset",
     "cluster_save_config",
     "cluster_set_config_epoch",
+    "client_setinfo",
     "cluster_setslot",
     "cluster_slaves",
     "cluster_slots",
@@ -219,6 +220,7 @@
     "function_load",
     "function_restore",
     "function_stats",
+    "gears_refresh_cluster",
     "geoadd",
     "geodist",
     "geohash",
@@ -320,6 +322,8 @@
     "pubsub_channels",
     "pubsub_numpat",
     "pubsub_numsub",
+    "pubsub_shardchannels",
+    "pubsub_shardnumsub",
     "punsubscribe",
     "quantile",
     "query",
@@ -374,6 +378,7 @@
     "smismember",
     "smove",
     "spellcheck",
+    "spublish",
     "srem",
     "sscan_iter",
     "sscan",
@@ -393,6 +398,11 @@
     "syndump",
     "synupdate",
     "tagvals",
+    "tfcall",
+    "tfcall_async",
+    "tfunction_delete",
+    "tfunction_list",
+    "tfunction_load",
     "time",
     "toggle",
     "touch",

tests/datastore_redis/test_asyncio.py

@@ -28,20 +28,27 @@
 # Settings
 
 DB_SETTINGS = redis_settings()[0]
-REDIS_VERSION = get_package_version_tuple("redis")
+REDIS_PY_VERSION = get_package_version_tuple("redis")
 
 # Metrics
 
-_enable_scoped_metrics = [("Datastore/operation/Redis/publish", 3)]
+_base_scoped_metrics = [("Datastore/operation/Redis/publish", 3)]
 
-_enable_rollup_metrics = [
-    ("Datastore/all", 3),
-    ("Datastore/allOther", 3),
-    ("Datastore/Redis/all", 3),
-    ("Datastore/Redis/allOther", 3),
+if REDIS_PY_VERSION >= (5, 0):
+    _base_scoped_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
+
+datastore_all_metric_count = 5 if REDIS_PY_VERSION >= (5, 0) else 3
+
+_base_rollup_metrics = [
+    ("Datastore/all", datastore_all_metric_count),
+    ("Datastore/allOther", datastore_all_metric_count),
+    ("Datastore/Redis/all", datastore_all_metric_count),
+    ("Datastore/Redis/allOther", datastore_all_metric_count),
     ("Datastore/operation/Redis/publish", 3),
-    ("Datastore/instance/Redis/%s/%s" % (instance_hostname(DB_SETTINGS["host"]), DB_SETTINGS["port"]), 3),
+    ("Datastore/instance/Redis/%s/%s" % (instance_hostname(DB_SETTINGS["host"]), DB_SETTINGS["port"]), datastore_all_metric_count),
 ]
+if REDIS_PY_VERSION >= (5, 0):
+    _base_rollup_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
 
 # Tests
 
@@ -53,7 +60,7 @@ def client(loop):  # noqa
     return loop.run_until_complete(redis.asyncio.Redis(host=DB_SETTINGS["host"], port=DB_SETTINGS["port"], db=0))
 
 
-@pytest.mark.skipif(REDIS_VERSION < (4, 2), reason="This functionality exists in Redis 4.2+")
+@pytest.mark.skipif(REDIS_PY_VERSION < (4, 2), reason="This functionality exists in Redis 4.2+")
 @validate_transaction_metrics("test_asyncio:test_async_pipeline", background_task=True)
 @background_task()
 def test_async_pipeline(client, loop):  # noqa
@@ -65,11 +72,11 @@ async def _test_pipeline(client):
     loop.run_until_complete(_test_pipeline(client))
 
 
-@pytest.mark.skipif(REDIS_VERSION < (4, 2), reason="This functionality exists in Redis 4.2+")
+@pytest.mark.skipif(REDIS_PY_VERSION < (4, 2), reason="This functionality exists in Redis 4.2+")
 @validate_transaction_metrics(
     "test_asyncio:test_async_pubsub",
-    scoped_metrics=_enable_scoped_metrics,
-    rollup_metrics=_enable_rollup_metrics,
+    scoped_metrics=_base_scoped_metrics,
+    rollup_metrics=_base_rollup_metrics,
     background_task=True,
 )
 @background_task()

tests/datastore_redis/test_custom_conn_pool.py

@@ -21,14 +21,16 @@
 import redis
 
 from newrelic.api.background_task import background_task
+from newrelic.common.package_version_utils import get_package_version_tuple
 
 from testing_support.fixtures import override_application_settings
 from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics
 from testing_support.db_settings import redis_settings
 from testing_support.util import instance_hostname
 
+
 DB_SETTINGS = redis_settings()[0]
-REDIS_PY_VERSION = redis.VERSION
+REDIS_PY_VERSION = get_package_version_tuple("redis")
 
 
 class FakeConnectionPool(object):
@@ -56,39 +58,41 @@ def release(self, connection):
 
 # We don't record instance metrics when using redis blaster,
 # so we just check for base metrics.
+datastore_all_metric_count = 5 if REDIS_PY_VERSION >= (5, 0) else 3
 
-_base_scoped_metrics = (
+_base_scoped_metrics = [
         ('Datastore/operation/Redis/get', 1),
         ('Datastore/operation/Redis/set', 1),
         ('Datastore/operation/Redis/client_list', 1),
-)
-
-_base_rollup_metrics = (
-        ('Datastore/all', 3),
-        ('Datastore/allOther', 3),
-        ('Datastore/Redis/all', 3),
-        ('Datastore/Redis/allOther', 3),
+]
+# client_setinfo was introduced in v5.0.0 and assigns info displayed in client_list output
+if REDIS_PY_VERSION >= (5, 0):
+    _base_scoped_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
+
+_base_rollup_metrics = [
+        ('Datastore/all', datastore_all_metric_count),
+        ('Datastore/allOther', datastore_all_metric_count),
+        ('Datastore/Redis/all', datastore_all_metric_count),
+        ('Datastore/Redis/allOther', datastore_all_metric_count),
         ('Datastore/operation/Redis/get', 1),
         ('Datastore/operation/Redis/set', 1),
         ('Datastore/operation/Redis/client_list', 1),
-)
-
-_disable_scoped_metrics = list(_base_scoped_metrics)
-_disable_rollup_metrics = list(_base_rollup_metrics)
-
-_enable_scoped_metrics = list(_base_scoped_metrics)
-_enable_rollup_metrics = list(_base_rollup_metrics)
+]
+if REDIS_PY_VERSION >= (5, 0):
+    _base_rollup_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
 
 _host = instance_hostname(DB_SETTINGS['host'])
 _port = DB_SETTINGS['port']
 
 _instance_metric_name = 'Datastore/instance/Redis/%s/%s' % (_host, _port)
 
-_enable_rollup_metrics.append(
-        (_instance_metric_name, 3)
+instance_metric_count = 5 if REDIS_PY_VERSION >= (5, 0) else 3
+
+_enable_rollup_metrics = _base_rollup_metrics.append(
+        (_instance_metric_name, instance_metric_count)
 )
 
-_disable_rollup_metrics.append(
+_disable_rollup_metrics = _base_rollup_metrics.append(
         (_instance_metric_name, None)
 )
 
@@ -106,7 +110,7 @@ def exercise_redis(client):
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_custom_conn_pool:test_fake_conn_pool_enable_instance',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -132,7 +136,7 @@ def test_fake_conn_pool_enable_instance():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_custom_conn_pool:test_fake_conn_pool_disable_instance',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()

tests/datastore_redis/test_execute_command.py

@@ -16,14 +16,16 @@
 import redis
 
 from newrelic.api.background_task import background_task
+from newrelic.common.package_version_utils import get_package_version_tuple
 
 from testing_support.fixtures import override_application_settings
 from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics
 from testing_support.db_settings import redis_settings
 from testing_support.util import instance_hostname
 
 DB_SETTINGS = redis_settings()[0]
-REDIS_PY_VERSION = redis.VERSION
+REDIS_PY_VERSION = get_package_version_tuple("redis")
+
 
 # Settings
 
@@ -36,34 +38,34 @@
 
 # Metrics
 
-_base_scoped_metrics = (
+_base_scoped_metrics = [
         ('Datastore/operation/Redis/client_list', 1),
-)
-
-_base_rollup_metrics = (
-        ('Datastore/all', 1),
-        ('Datastore/allOther', 1),
-        ('Datastore/Redis/all', 1),
-        ('Datastore/Redis/allOther', 1),
+]
+if REDIS_PY_VERSION >= (5, 0):
+    _base_scoped_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
+
+_base_rollup_metrics = [
+        ('Datastore/all', 3),
+        ('Datastore/allOther', 3),
+        ('Datastore/Redis/all', 3),
+        ('Datastore/Redis/allOther', 3),
         ('Datastore/operation/Redis/client_list', 1),
-)
-
-_disable_scoped_metrics = list(_base_scoped_metrics)
-_disable_rollup_metrics = list(_base_rollup_metrics)
-
-_enable_scoped_metrics = list(_base_scoped_metrics)
-_enable_rollup_metrics = list(_base_rollup_metrics)
+]
+if REDIS_PY_VERSION >= (5, 0):
+    _base_rollup_metrics.append(('Datastore/operation/Redis/client_setinfo', 2),)
 
 _host = instance_hostname(DB_SETTINGS['host'])
 _port = DB_SETTINGS['port']
 
 _instance_metric_name = 'Datastore/instance/Redis/%s/%s' % (_host, _port)
 
-_enable_rollup_metrics.append(
-        (_instance_metric_name, 1)
+instance_metric_count = 3 if REDIS_PY_VERSION >= (5, 0) else 1
+
+_enable_rollup_metrics = _base_rollup_metrics.append(
+        (_instance_metric_name, instance_metric_count)
 )
 
-_disable_rollup_metrics.append(
+_disable_rollup_metrics = _base_rollup_metrics.append(
         (_instance_metric_name, None)
 )
 
@@ -76,7 +78,7 @@ def exercise_redis_single_arg(client):
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_strict_redis_execute_command_two_args_enable',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -88,7 +90,7 @@ def test_strict_redis_execute_command_two_args_enable():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_strict_redis_execute_command_two_args_disabled',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -100,7 +102,7 @@ def test_strict_redis_execute_command_two_args_disabled():
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_redis_execute_command_two_args_enable',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -112,7 +114,7 @@ def test_redis_execute_command_two_args_enable():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_redis_execute_command_two_args_disabled',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -126,7 +128,7 @@ def test_redis_execute_command_two_args_disabled():
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_strict_redis_execute_command_as_one_arg_enable',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -140,7 +142,7 @@ def test_strict_redis_execute_command_as_one_arg_enable():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_strict_redis_execute_command_as_one_arg_disabled',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -154,7 +156,7 @@ def test_strict_redis_execute_command_as_one_arg_disabled():
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_redis_execute_command_as_one_arg_enable',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -168,7 +170,7 @@ def test_redis_execute_command_as_one_arg_enable():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_execute_command:test_redis_execute_command_as_one_arg_disabled',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()

tests/datastore_redis/test_get_and_set.py

@@ -48,10 +48,7 @@
         ('Datastore/operation/Redis/set', 1),
 )
 
-_disable_scoped_metrics = list(_base_scoped_metrics)
 _disable_rollup_metrics = list(_base_rollup_metrics)
-
-_enable_scoped_metrics = list(_base_scoped_metrics)
 _enable_rollup_metrics = list(_base_rollup_metrics)
 
 _host = instance_hostname(DB_SETTINGS['host'])
@@ -78,7 +75,7 @@ def exercise_redis(client):
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_get_and_set:test_strict_redis_operation_enable_instance',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -90,7 +87,7 @@ def test_strict_redis_operation_enable_instance():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_get_and_set:test_strict_redis_operation_disable_instance',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -102,7 +99,7 @@ def test_strict_redis_operation_disable_instance():
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
         'test_get_and_set:test_redis_operation_enable_instance',
-        scoped_metrics=_enable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_enable_rollup_metrics,
         background_task=True)
 @background_task()
@@ -114,7 +111,7 @@ def test_redis_operation_enable_instance():
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
         'test_get_and_set:test_redis_operation_disable_instance',
-        scoped_metrics=_disable_scoped_metrics,
+        scoped_metrics=_base_scoped_metrics,
         rollup_metrics=_disable_rollup_metrics,
         background_task=True)
 @background_task()