diff --git a/libbeat/docs/outputconfig.asciidoc b/libbeat/docs/outputconfig.asciidoc index 545462c2fa1..cb7e420f10a 100644 --- a/libbeat/docs/outputconfig.asciidoc +++ b/libbeat/docs/outputconfig.asciidoc @@ -18,6 +18,7 @@ You can configure multiple outputs for exporting the correlated transactions. Cu * <> * <> * <> +* <> * <> * <> @@ -523,6 +524,80 @@ setting does not affect how events are published. Setting `bulk_max_size` to values less than or equal to 0 disables buffering in libbeat. +[[kafka-output]] +==== Kafka Output + +===== hosts + +List of Kafka broker addressed to connect to. + +===== topic + +The kafka topic used for produced events. If use_type is set to true, topic will not be used. + +===== use_type + +Set kafka topic by event type. If use_type is false, topic must be configured. The deault is false. + +===== client_id + +Configurable ClientID used for logging, debugging and auditing purposes. The default is "beats". + +===== worker + +Number of concurrent load-balanced kafka output workers. + +===== max_retries + +The number of times to retry publishing an event after a publishing failure. +After the specified number of retries, the events are typically dropped. +Some Beats, such as Filebeat, ignore the `max_retries` setting and retry until all +events are published. + +Set `max_retries` to a value less than 0 to retry until all events are published. + +The default is 3. + +===== bulk_max_size + +The maximum number of events to bulk in a single Logstash request. The default is 2048. + +===== timeout + +The number of seconds to wait for responses from the Kafka brokers before timing +out. The default is 30 (seconds). + +===== broker_timeout + +Maximum duration a broker will wait for number of required ACKs. The default is 10s. + +===== keep_alive + +Keep-alive period for an active network connection. If 0s, keep-alives are disabled. The default is 0 seconds. + +===== compression + +Select output compression codec. Must be one of `none`, `snappy` and `gzip`. The default is `snappy`. + +===== max_message_bytes + +Max permitted size of json-encoded messages. Bigger messages will be dropped. The default value is 1000000 (bytes). Should be equal or less to the brokers `message.max.bytes`. + +===== required_acks + +ACK reliability level required from broker. 0=no response, 1=wait for local commit, -1=wait for all replicas to commit. The default is 1. + +Note: If set to 0, no ACKs are returned by kafka. Messages might be lost silently on error. + +===== flush_interval + +The number of seconds to wait for new events between two producer API calls. + +===== tls + +Configuration options for TLS parameters like the root CA for Kibana connections. See +<> for more information. + [[file-output]] ==== File Output