pass a client name when connecting to redis

sanderegg · sanderegg · commit 2f289eb48a1d · 2024-11-12T15:52:25.000+01:00
diff --git a/packages/service-library/src/servicelib/redis.py b/packages/service-library/src/servicelib/redis.py
@@ -60,6 +60,7 @@ async def _cancel_or_warn(task: Task) -> None:
 @dataclass
 class RedisClientSDK:
     redis_dsn: str
+    client_name: str
     decode_responses: bool = _DEFAULT_DECODE_RESPONSES
     health_check_interval: datetime.timedelta = _DEFAULT_HEALTH_CHECK_INTERVAL
 
@@ -86,7 +87,7 @@ def __post_init__(self):
             socket_connect_timeout=_DEFAULT_SOCKET_TIMEOUT.total_seconds(),
             encoding="utf-8",
             decode_responses=self.decode_responses,
-            auto_close_connection_pool=True,
+            client_name=self.client_name,
         )
 
     @retry(**RedisRetryPolicyUponInitialization(_logger).kwargs)
@@ -238,6 +239,7 @@ class RedisClientsManager:
 
     databases_configs: set[RedisManagerDBConfig]
     settings: RedisSettings
+    client_name: str
 
     _client_sdks: dict[RedisDatabase, RedisClientSDK] = field(default_factory=dict)
 
@@ -247,6 +249,7 @@ async def setup(self) -> None:
                 redis_dsn=self.settings.build_redis_dsn(config.database),
                 decode_responses=config.decode_responses,
                 health_check_interval=config.health_check_interval,
+                client_name=f"{self.client_name}",
             )
 
         for client in self._client_sdks.values():
diff --git a/packages/service-library/tests/conftest.py b/packages/service-library/tests/conftest.py
@@ -80,7 +80,9 @@ async def _(
         database: RedisDatabase, decode_response: bool = True  # noqa: FBT002
     ) -> AsyncIterator[RedisClientSDK]:
         redis_resources_dns = redis_service.build_redis_dsn(database)
-        client = RedisClientSDK(redis_resources_dns, decode_responses=decode_response)
+        client = RedisClientSDK(
+            redis_resources_dns, decode_responses=decode_response, client_name="pytest"
+        )
         assert client
         assert client.redis_dsn == redis_resources_dns
         await client.setup()
@@ -94,7 +96,9 @@ async def _cleanup_redis_data(clients_manager: RedisClientsManager) -> None:
             await clients_manager.client(db).redis.flushall()
 
     async with RedisClientsManager(
-        {RedisManagerDBConfig(db) for db in RedisDatabase}, redis_service
+        {RedisManagerDBConfig(db) for db in RedisDatabase},
+        redis_service,
+        client_name="pytest",
     ) as clients_manager:
         await _cleanup_redis_data(clients_manager)
         yield _
diff --git a/packages/service-library/tests/deferred_tasks/example_app.py b/packages/service-library/tests/deferred_tasks/example_app.py
@@ -60,6 +60,7 @@ def __init__(self, redis_settings: RedisSettings, port: int) -> None:
         self.redis: Redis = RedisClientSDK(
             redis_settings.build_redis_dsn(RedisDatabase.DEFERRED_TASKS),
             decode_responses=True,
+            client_name="example_app",
         ).redis
         self.port = port
 
@@ -84,6 +85,7 @@ def __init__(
         self._redis_client = RedisClientSDK(
             redis_settings.build_redis_dsn(RedisDatabase.DEFERRED_TASKS),
             decode_responses=False,
+            client_name="example_app",
         )
         self._manager = DeferredManager(
             rabbit_settings,
diff --git a/packages/service-library/tests/deferred_tasks/test__base_deferred_handler.py b/packages/service-library/tests/deferred_tasks/test__base_deferred_handler.py
@@ -55,6 +55,7 @@ async def redis_client_sdk(
     sdk = RedisClientSDK(
         redis_service.build_redis_dsn(RedisDatabase.DEFERRED_TASKS),
         decode_responses=False,
+        client_name="pytest",
     )
     await sdk.setup()
     yield sdk
diff --git a/packages/service-library/tests/test_redis.py b/packages/service-library/tests/test_redis.py
@@ -277,7 +277,9 @@ async def test_redis_client_sdks_manager(
         RedisManagerDBConfig(db) for db in RedisDatabase
     }
     manager = RedisClientsManager(
-        databases_configs=all_redis_configs, settings=redis_service
+        databases_configs=all_redis_configs,
+        settings=redis_service,
+        client_name="pytest",
     )
 
     async with manager:
@@ -290,7 +292,7 @@ async def test_redis_client_sdk_setup_shutdown(
 ):
     # setup
     redis_resources_dns = redis_service.build_redis_dsn(RedisDatabase.RESOURCES)
-    client = RedisClientSDK(redis_resources_dns)
+    client = RedisClientSDK(redis_resources_dns, client_name="pytest")
     assert client
     assert client.redis_dsn == redis_resources_dns
 
diff --git a/packages/service-library/tests/test_redis__recoonection.py b/packages/service-library/tests/test_redis__recoonection.py
@@ -21,7 +21,7 @@ async def test_redis_client_sdk_lost_connection(
     docker_client: docker.client.DockerClient,
 ):
     redis_client_sdk = RedisClientSDK(
-        redis_service.build_redis_dsn(RedisDatabase.RESOURCES)
+        redis_service.build_redis_dsn(RedisDatabase.RESOURCES), client_name="pytest"
     )
 
     await redis_client_sdk.setup()
diff --git a/services/autoscaling/src/simcore_service_autoscaling/modules/redis.py b/services/autoscaling/src/simcore_service_autoscaling/modules/redis.py
@@ -13,7 +13,9 @@ async def on_startup() -> None:
         app.state.redis_client_sdk = None
         settings: RedisSettings = app.state.settings.AUTOSCALING_REDIS
         redis_locks_dsn = settings.build_redis_dsn(RedisDatabase.LOCKS)
-        app.state.redis_client_sdk = client = RedisClientSDK(redis_locks_dsn)
+        app.state.redis_client_sdk = client = RedisClientSDK(
+            redis_locks_dsn, client_name=app.title
+        )
         await client.setup()
 
     async def on_shutdown() -> None:
diff --git a/services/clusters-keeper/src/simcore_service_clusters_keeper/modules/redis.py b/services/clusters-keeper/src/simcore_service_clusters_keeper/modules/redis.py
@@ -15,7 +15,9 @@ async def on_startup() -> None:
         app.state.redis_client_sdk = None
         settings: RedisSettings = get_application_settings(app).CLUSTERS_KEEPER_REDIS
         redis_locks_dsn = settings.build_redis_dsn(RedisDatabase.LOCKS)
-        app.state.redis_client_sdk = client = RedisClientSDK(redis_locks_dsn)
+        app.state.redis_client_sdk = client = RedisClientSDK(
+            redis_locks_dsn, client_name=app.title
+        )
         await client.setup()
 
     async def on_shutdown() -> None:
diff --git a/services/director-v2/src/simcore_service_director_v2/modules/redis.py b/services/director-v2/src/simcore_service_director_v2/modules/redis.py
@@ -18,6 +18,7 @@ async def on_startup() -> None:
                 )
             },
             settings=settings.REDIS,
+            client_name=app.title,
         )
         await redis_clients_manager.setup()
 
diff --git a/services/director-v2/tests/unit/test_utils_distributed_identifier.py b/services/director-v2/tests/unit/test_utils_distributed_identifier.py
@@ -171,7 +171,7 @@ async def redis_client_sdk(
         RedisDatabase.DISTRIBUTED_IDENTIFIERS
     )
 
-    client = RedisClientSDK(redis_resources_dns)
+    client = RedisClientSDK(redis_resources_dns, client_name="pytest")
     assert client
     assert client.redis_dsn == redis_resources_dns
     await client.setup()
diff --git a/services/director/requirements/_tools.txt b/services/director/requirements/_tools.txt
@@ -1,68 +0,0 @@
-#
-# This file is autogenerated by pip-compile with python 3.6
-# To update, run:
-#
-#    pip-compile --output-file=requirements/_tools.txt --strip-extras requirements/_tools.in
-#
-appdirs==1.4.4
-    # via black
-black==20.8b1
-    # via -r requirements/_tools.in
-bump2version==1.0.1
-    # via -r requirements/_tools.in
-click==8.0.3
-    # via
-    #   black
-    #   pip-tools
-dataclasses==0.7
-    # via
-    #   -c requirements/_base.txt
-    #   -c requirements/_test.txt
-    #   black
-importlib-metadata==2.0.0
-    # via
-    #   -c requirements/_test.txt
-    #   click
-    #   pep517
-mypy-extensions==0.4.3
-    # via black
-pathspec==0.9.0
-    # via black
-pep517==0.12.0
-    # via pip-tools
-pip==24.3.1
-    # via pip-tools
-pip-tools==6.4.0
-    # via -r requirements/_tools.in
-pyyaml==5.4
-    # via
-    #   -c requirements/_base.txt
-    #   -c requirements/_test.txt
-    #   watchdog
-regex==2022.1.18
-    # via black
-toml==0.10.2
-    # via
-    #   -c requirements/_test.txt
-    #   black
-tomli==1.2.3
-    # via pep517
-typed-ast==1.4.1
-    # via
-    #   -c requirements/_test.txt
-    #   black
-typing-extensions==4.0.1
-    # via black
-watchdog==2.1.6
-    # via -r requirements/_tools.in
-wheel==0.37.1
-    # via pip-tools
-zipp==3.4.0
-    # via
-    #   -c requirements/_test.txt
-    #   importlib-metadata
-    #   pep517
-
-# The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools
diff --git a/services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/services/redis.py b/services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/services/redis.py
@@ -24,6 +24,7 @@ async def on_startup() -> None:
             {RedisManagerDBConfig(x, decode_responses=False) for x in _BINARY_DBS}
             | {RedisManagerDBConfig(x, decode_responses=True) for x in _DECODE_DBS},
             settings,
+            client_name=app.title,
         )
         await manager.setup()
 
diff --git a/services/dynamic-scheduler/tests/conftest.py b/services/dynamic-scheduler/tests/conftest.py
@@ -135,7 +135,9 @@ async def app(
 @pytest.fixture
 async def remove_redis_data(redis_service: RedisSettings) -> None:
     async with RedisClientsManager(
-        {RedisManagerDBConfig(x) for x in RedisDatabase}, redis_service
+        {RedisManagerDBConfig(x) for x in RedisDatabase},
+        redis_service,
+        client_name="pytest",
     ) as manager:
         await logged_gather(
             *[manager.client(d).redis.flushall() for d in RedisDatabase]
diff --git a/services/efs-guardian/src/simcore_service_efs_guardian/services/modules/redis.py b/services/efs-guardian/src/simcore_service_efs_guardian/services/modules/redis.py
@@ -13,7 +13,9 @@ async def on_startup() -> None:
         app.state.redis_lock_client_sdk = None
         settings: RedisSettings = app.state.settings.EFS_GUARDIAN_REDIS
         redis_locks_dsn = settings.build_redis_dsn(RedisDatabase.LOCKS)
-        app.state.redis_lock_client_sdk = lock_client = RedisClientSDK(redis_locks_dsn)
+        app.state.redis_lock_client_sdk = lock_client = RedisClientSDK(
+            redis_locks_dsn, client_name=app.title
+        )
         await lock_client.setup()
 
     async def on_shutdown() -> None:
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/redis.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/redis.py
@@ -13,7 +13,9 @@ async def on_startup() -> None:
         app.state.redis_client_sdk = None
         settings: RedisSettings = app.state.settings.RESOURCE_USAGE_TRACKER_REDIS
         redis_locks_dsn = settings.build_redis_dsn(RedisDatabase.LOCKS)
-        app.state.redis_client_sdk = client = RedisClientSDK(redis_locks_dsn)
+        app.state.redis_client_sdk = client = RedisClientSDK(
+            redis_locks_dsn, client_name=app.title
+        )
         await client.setup()
 
     async def on_shutdown() -> None:
diff --git a/services/storage/src/simcore_service_storage/redis.py b/services/storage/src/simcore_service_storage/redis.py
@@ -5,6 +5,7 @@
 from servicelib.redis import RedisClientSDK
 from settings_library.redis import RedisDatabase, RedisSettings
 
+from ._meta import APP_NAME
 from .constants import APP_CONFIG_KEY
 from .settings import Settings
 
@@ -20,7 +21,9 @@ async def _setup(app: web.Application):
         assert settings.STORAGE_REDIS  # nosec
         redis_settings: RedisSettings = settings.STORAGE_REDIS
         redis_locks_dsn = redis_settings.build_redis_dsn(RedisDatabase.LOCKS)
-        app[_APP_REDIS_KEY] = client = RedisClientSDK(redis_locks_dsn)
+        app[_APP_REDIS_KEY] = client = RedisClientSDK(
+            redis_locks_dsn, client_name=APP_NAME
+        )
         await client.setup()
 
         yield
diff --git a/services/web/server/src/simcore_service_webserver/redis.py b/services/web/server/src/simcore_service_webserver/redis.py
@@ -7,6 +7,7 @@
 from settings_library.redis import RedisDatabase, RedisSettings
 
 from ._constants import APP_SETTINGS_KEY
+from ._meta import APP_NAME
 
 _logger = logging.getLogger(__name__)
 
@@ -44,6 +45,7 @@ async def setup_redis_client(app: web.Application):
             )
         },
         settings=redis_settings,
+        client_name=APP_NAME,
     )
 
     await manager.setup()

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ async def redis_client_sdk(`
`55`	`55`	`sdk = RedisClientSDK(`
`56`	`56`	`redis_service.build_redis_dsn(RedisDatabase.DEFERRED_TASKS),`
`57`	`57`	`decode_responses=False,`
	`58`	`+ client_name="pytest",`
`58`	`59`	`)`
`59`	`60`	`await sdk.setup()`
`60`	`61`	`yield sdk`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ async def test_redis_client_sdk_lost_connection(`
`21`	`21`	`docker_client: docker.client.DockerClient,`
`22`	`22`	`):`
`23`	`23`	`redis_client_sdk = RedisClientSDK(`
`24`		`- redis_service.build_redis_dsn(RedisDatabase.RESOURCES)`
	`24`	`+ redis_service.build_redis_dsn(RedisDatabase.RESOURCES), client_name="pytest"`
`25`	`25`	`)`
`26`	`26`
`27`	`27`	`await redis_client_sdk.setup()`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ async def on_startup() -> None:`
`18`	`18`	`)`
`19`	`19`	`},`
`20`	`20`	`settings=settings.REDIS,`
	`21`	`+ client_name=app.title,`
`21`	`22`	`)`
`22`	`23`	`await redis_clients_manager.setup()`
`23`	`24`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ async def redis_client_sdk(`
`171`	`171`	`RedisDatabase.DISTRIBUTED_IDENTIFIERS`
`172`	`172`	`)`
`173`	`173`
`174`		`- client = RedisClientSDK(redis_resources_dns)`
	`174`	`+ client = RedisClientSDK(redis_resources_dns, client_name="pytest")`
`175`	`175`	`assert client`
`176`	`176`	`assert client.redis_dsn == redis_resources_dns`
`177`	`177`	`await client.setup()`