Struct vector::sinks::kafka::KafkaSinkConfig

pub struct KafkaSinkConfig {

    pub bootstrap_servers: String,
    pub topic: Template,
    pub healthcheck_topic: Option<String>,
    pub key_field: Option<ConfigTargetPath>,
    pub encoding: EncodingConfig,
    pub batch: BatchConfig<NoDefaultsBatchSettings>,
    pub compression: KafkaCompression,
    pub auth: KafkaAuthConfig,
    pub socket_timeout_ms: Duration,
    pub message_timeout_ms: Duration,
    pub librdkafka_options: HashMap<String, String>,
    pub headers_key: Option<ConfigTargetPath>,
    pub acknowledgements: AcknowledgementsConfig,
}

Configuration for the kafka sink.

Fields

bootstrap_servers: String

A comma-separated list of Kafka bootstrap servers.

These are the servers in a Kafka cluster that a client should use to bootstrap its connection to the cluster, allowing discovery of all the other hosts in the cluster.

Must be in the form of host:port, and comma-separated.

topic: Template

The Kafka topic name to write events to.

healthcheck_topic: Option<String>

The topic name to use for healthcheck. If omitted, topic is used. This option helps prevent healthcheck warnings when topic is templated.

It is ignored when healthcheck is disabled.

key_field: Option<ConfigTargetPath>

The log field name or tag key to use for the topic key.

If the field does not exist in the log or in the tags, a blank value is used. If unspecified, the key is not sent.

Kafka uses a hash of the key to choose the partition or uses round-robin if the record has no key.

encoding: EncodingConfig

batch: BatchConfig<NoDefaultsBatchSettings>

compression: KafkaCompression

auth: KafkaAuthConfig

socket_timeout_ms: Duration

Default timeout, in milliseconds, for network requests.

message_timeout_ms: Duration

Local message timeout, in milliseconds.

librdkafka_options: HashMap<String, String>

A map of advanced options to pass directly to the underlying librdkafka client.

For more information on configuration options, see Configuration properties.

headers_key: Option<ConfigTargetPath>

The log field name to use for the Kafka headers.

If omitted, no headers are written.

acknowledgements: AcknowledgementsConfig

Trait Implementations

impl Clone for KafkaSinkConfig

fn clone(&self) -> KafkaSinkConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for KafkaSinkConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for KafkaSinkConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KafkaSinkConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for KafkaSinkConfig

fn generate_config() -> Value

impl NamedComponent for KafkaSinkConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for KafkaSinkConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for KafkaSinkConfig

fn build<'life0, 'async_trait>( &'life0 self, _cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

impl ToValue for KafkaSinkConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.