#include <userver/kafka/producer_component.hpp>
Apache Kafka Producer client component.
A Kafka alias in secdist is described as a JSON object kafka_settings, containing credentials of Kafka brokers.
| Name | Description | Default value |
|---|---|---|
| client_id | Client identifier. May be an arbitrary string. Optional, but you should set this property on each instance because it enables you to more easily correlate requests on the broker with the client instance which made it, which can be helpful in debugging and troubleshooting scenarios. | userver |
| delivery_timeout | Time a produced message waits for successful delivery. | – |
| queue_buffering_max | Delay to wait for messages to be transmitted to broker. | – |
| enable_idempotence | Whether to make producer idempotent. | false |
| queue_buffering_max_messages | Maximum number of messages allowed on the producer queue. In other words, maximum number of simultaneously send requests waiting for delivery. | 100000 |
| queue_buffering_max_kbytes | Maximum total message size sum allowed on the producer queue. Has higher priority than queue_buffering_max_messages, i.e. if this limit is exceeded no more send requests are accepted regardless to the number of messages. | 1048576 |
| message_max_bytes | One message maximum size. | 1000000 |
| message_send_max_retries | Maximum number of send request retries until delivery_timeout reached. | 2147483647 |
| retry_backoff | The backoff time before retrying a producer send request. It will be backed off exponentially until number of retries is exhausted and bounded by retry_backoff_max. The backoff must fit in [1ms; 300000ms]. | 100ms |
| retry_backoff_max | Backoff upper bound. The backoff must fit in [1ms; 300000ms]. | 1000ms |
| security_protocol | Protocol used to communicate with brokers. Possible values: PLAINTEXT, SASL_SSL, SASL_PLAINTEXT, SSL. | – |
| sasl_mechanisms | SASL mechanism to use for authentication. Must be set if security_protocol equals SASL_SSL. Possible values: PLAIN, SCRAM-SHA-512. | none |
| ssl_ca_location | File or directory path to CA certificate(s) for verifying the broker's key. Must be set if security_protocol equals SASL_SSL or SSL. If set to probe, CA certificates are probed from the default certificates paths. | none |
| rd_kafka_custom_options.* | A map of arbitrary librdkafka library configuration options. Full list of options is available by link: https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md. Note: This options is not guaranteed to be supported in userver-kafka, use it at your own risk. Each of the elements: librdkafka option value. | {} |
| debug_info_log_level | Log level for everything debug information. | debug |
| operation_log_level | Log level for infos about ordinary actions. | debug |
Options inherited from components::ComponentBase :
| Name | Description | Default value |
|---|---|---|
| load-enabled | Set to false to disable loading of the component. | true |
Definition at line 34 of file producer_component.hpp.
Inheritance diagram for kafka::ProducerComponent:Public Member Functions | |
| ProducerComponent (const components::ComponentConfig &config, const components::ComponentContext &context) | |
| const Producer & | GetProducer () |
| Returns a producer instance reference. | |
| ComponentHealth | GetComponentHealth () const override |
| void | OnLoadingCancelled () override |
| void | OnAllComponentsLoaded () override |
| void | OnAllComponentsAreStopping () override |
Static Public Member Functions | |
| static yaml_config::Schema | GetStaticConfigSchema () |
Static Public Attributes | |
| static constexpr std::string_view | kName {"kafka-producer"} |
| The default name of kafka::ProducerComponent component. | |
Protected Types | |
| using | LoggableComponentBase = ComponentBase |
|
protectedinherited |
Definition at line 67 of file component_base.hpp.
|
inlineoverridevirtualinherited |
Override this function to inform the world of the state of your component.
Reimplemented from components::RawComponentBase.
Reimplemented in server::handlers::Restart.
Definition at line 35 of file component_base.hpp.
| const Producer & kafka::ProducerComponent::GetProducer | ( | ) |
Returns a producer instance reference.
|
inlineoverridevirtualinherited |
Component may use this function to stop doing work before the stop of the components that depend on it.
Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.
Reimplemented from components::RawComponentBase.
Reimplemented in components::Server, and urabbitmq::ConsumerComponentBase.
Definition at line 58 of file component_base.hpp.
|
inlineoverridevirtualinherited |
Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).
Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.
Reimplemented from components::RawComponentBase.
Reimplemented in components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.
Definition at line 51 of file component_base.hpp.
|
inlineoverridevirtualinherited |
Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.
Reimplemented from components::RawComponentBase.
Definition at line 42 of file component_base.hpp.
