[redisdb] Set client name to 'datadog-agent' on Redis connections (#23734)

* [redisdb] Allow setting client_name on Redis connections

Allow users to set client_name in their instance configuration,
making it easy to identify agent connections in CLIENT LIST output
on the Redis server without requiring CLIENT SETNAME permissions
in restricted ACL environments.

* [redisdb] Document client_name in configuration spec

---------

Co-authored-by: Sarah Witt <sarah.witt@datadoghq.com>

Author: sveniu-kahoot

redisdb/assets/configuration/spec.yaml

@@ -128,6 +128,13 @@ files:
         type: boolean
         example: true
       fleet_configurable: true
+    - name: client_name
+      display_priority: 0
+      description: |
+        Set the connection name that appears in CLIENT LIST on the Redis server.
+        Useful for identifying agent connections. Requires the CLIENT SETNAME permission.
+      value:
+        type: string
     - name: keys
       display_priority: 0
       description: |

redisdb/changelog.d/23734.added

@@ -0,0 +1 @@
+Allow setting ``client_name`` on Redis connections for easier identification in CLIENT LIST output.

redisdb/datadog_checks/redisdb/config_models/instance.py

@@ -37,6 +37,7 @@ class InstanceConfig(BaseModel):
         arbitrary_types_allowed=True,
         frozen=True,
     )
+    client_name: Optional[str] = None
     collect_client_metrics: Optional[bool] = None
     command_stats: Optional[bool] = None
     db: Optional[int] = None

redisdb/datadog_checks/redisdb/data/conf.yaml.example

@@ -94,6 +94,12 @@ instances:
     #
     # ssl_check_hostname: true
 
+    ## @param client_name - string - optional
+    ## Set the connection name that appears in CLIENT LIST on the Redis server.
+    ## Useful for identifying agent connections. Requires the CLIENT SETNAME permission.
+    #
+    # client_name: <CLIENT_NAME>
+
     ## @param keys - list of strings - optional
     ## Enter the list of keys to collect the lengths from.
     ## The length is 1 for strings.

redisdb/datadog_checks/redisdb/redisdb.py

@@ -89,6 +89,7 @@ def _get_conn(self, instance_config):
                     'ssl_ca_certs',
                     'ssl_cert_reqs',
                     'ssl_check_hostname',
+                    'client_name',
                 ]
 
                 # Set a default timeout (in seconds) if no timeout is specified in the instance config

redisdb/tests/test_unit.py

@@ -127,6 +127,7 @@ def test_check_all_available_config_options(check, aggregator, redis_instance, d
         'ssl_ca_certs': '/path',
         'ssl_cert_reqs': 0,
         'ssl_check_hostname': True,
+        'client_name': 'datadog-agent',
     }
     redis_instance.update(connection_args)