Event Bus Configuration

Here are the available configurations for the event bus that are used to setup the event bus in the Open edX platform.

EVENT_BUS_CONSUMER

Default: None

Source: __init__.py (line 154)

String naming a callable (function or class) that can be called to create or retrieve an instance of EventBusConsumer when ``openedx_events.event_bus.make_single_consumer`` is called. The format of the string is a dotted path to an attribute in a module, e.g. ``some.module.path.EventBusImplementation``. See docstring of ``make_single_consumer`` for parameters. If setting is not supplied or the callable raises an exception or does not return an instance of EventBusConsumer, calls to the consumer will be ignored with a warning at startup.

EVENT_BUS_PRODUCER

Default: None

Source: __init__.py (line 106)

String naming a callable (function or class) that can be called to create or retrieve an instance of EventBusProducer when ``openedx_events.event_bus.get_producer`` is called. The format of the string is a dotted path to an attribute in a module, e.g. ``edx_event_bus_kafka.create_producer``. This producer will be managed as a singleton by openedx_events. If setting is not supplied or the callable raises an exception or does not return an instance of EventBusProducer, calls to the producer will be ignored with a warning at startup.

EVENT_BUS_PRODUCER_CONFIG

Default: "{}"

Source: __init__.py (line 192)

Dictionary of event_types to lists of dictionaries for topic related configuration. Each topic configuration dictionary contains a flag called `enabled` denoting whether the event will be published to the topic, topic/stream name called `topic` where the event will be pushed to, `event_key_field` which is a period-delimited string path to event data field to use as event key. The topic names should not include environment prefix as it will be dynamically added based on EVENT_BUS_TOPIC_PREFIX setting. See 0012-producing-to-event-bus-via-settings for more details.

Maintenance chart

Review Date	Reviewer	Release	Test situation
2025-02-05	Maria Grimaldi	Sumac	Pass.