feat: add configurable client.id to base settings

CHANGELOG.rst

@@ -14,6 +14,12 @@ Change Log
 Unreleased
 **********
 
+[5.6.0] - 2024-01-24
+********************
+Changed
+=======
+* Added configurable client.id to base settings
+
 [5.5.0] - 2023-09-21
 ********************
 Changed

edx_event_bus_kafka/__init__.py

@@ -9,4 +9,4 @@
 from edx_event_bus_kafka.internal.consumer import KafkaEventConsumer
 from edx_event_bus_kafka.internal.producer import KafkaEventProducer, create_producer
 
-__version__ = '5.5.0'
+__version__ = '5.6.0'

edx_event_bus_kafka/internal/config.py

@@ -110,6 +110,15 @@ def load_common_settings() -> Optional[dict]:
             'sasl.password': secret,
         })
 
+    # .. setting_name: EVENT_BUS_KAFKA_CLIENT_ID
+    # .. setting_default: None
+    # .. setting_description: Identifier for the producing/consuming application. Useful for debugging. If not set
+    # .. Kafka will use 'rdkafka' as the identifier
+    client_id = getattr(settings, 'EVENT_BUS_KAFKA_CLIENT_ID')
+    if client_id:
+        base_settings.update({
+            'client.id': client_id
+        })
     return base_settings
 
 

edx_event_bus_kafka/internal/tests/test_config.py

@@ -50,13 +50,15 @@ def test_full(self):
                 EVENT_BUS_KAFKA_BOOTSTRAP_SERVERS='localhost:54321',
                 EVENT_BUS_KAFKA_API_KEY='some_other_key',
                 EVENT_BUS_KAFKA_API_SECRET='some_other_secret',
+                EVENT_BUS_KAFKA_CLIENT_ID='my_client_id',
         ):
             assert config.load_common_settings() == {
                 'bootstrap.servers': 'localhost:54321',
                 'sasl.mechanism': 'PLAIN',
                 'security.protocol': 'SASL_SSL',
                 'sasl.username': 'some_other_key',
                 'sasl.password': 'some_other_secret',
+                'client.id': 'my_client_id',
             }