Apache Kafka Output Plugin
out_kafka Output plugin writes records into Apache Kafka.
|This document doesn't describe all parameters. If you want to know full features, check the Further Reading section.|
Table of Contents
- Example Configuration
- type (required)
- brokers (required/optional)
- Buffered Output Parameters
- buffer_queue_limit, buffer_chunk_limit
- retry_wait, max_retry_wait
- retry_limit, disable_retry_limit
- Further Reading
out_kafka is included in td-agent2 after v2.3.3. Fluentd gem users will need to install the fluent-plugin-kafka gem using the following command.
$ fluent-gem install fluent-plugin-kafka
<match pattern> @type kafka_buffered # list of seed brokers brokers <broker1_host>:<broker1_port>,<broker2_host>:<broker2_port> # buffer settings buffer_type file buffer_path /var/log/td-agent/buffer/td flush_interval 3s # topic settings default_topic messages # data type settings output_data_type json compression_codec gzip # producer settings max_send_retries 1 required_acks -1 </match>
|Please see the Config File article for the basic structure and syntax of the configuration file.|
|Please make sure that you have enough space in the buffer_path directory. Running out of disk space is a problem frequently reported by users.|
The value must be
The list of all seed brokers, with their host and port information.
The name of default topic (default: nil).
The name of default partition key (default: nil).
The name of default message key (default: nil).
The format of each message. The available options are
msgpack is recommended since it’s more compact and faster.
The number of times to retry sending of messages to a leader (default: 1).
The number of acks required per request (default: -1).
How long the producer waits for acks. The unit is seconds (default: nil => Use default of ruby-kafka library)
The codec the producer uses to compress messages (default: nil). The available options are
snappy. When you use
snappy, you need to install
snappy gem by
Buffered Output Parameters
For advanced usage, you can tune Fluentd’s internal buffering mechanism with these parameters.
The buffer type is
memory by default (buf_memory) for the ease of testing, however
file (buf_file) buffer type is always recommended for the production deployments. If you use
file buffer type,
buffer_path parameter is required.
The length of the chunk queue and the size of each chunk, respectively. Please see the Buffer Plugin Overview article for the basic buffer structure. The default values are 64 and 8m, respectively. The suffixes “k” (KB), “m” (MB), and “g” (GB) can be used for buffer_chunk_limit.
The interval between data flushes. The default is 60s. The suffixes “s” (seconds), “m” (minutes), and “h” (hours) can be used.
If set to true, Fluentd waits for the buffer to flush at shutdown. By default, it is set to true for Memory Buffer and false for File Buffer.
The initial and maximum intervals between write retries. The default values are 1.0 seconds and unset (no limit). The interval doubles (with +/-12.5% randomness) every retry until
max_retry_wait is reached. In the default configuration the last retry waits for approximately 131072 sec, roughly 36 hours.
The limit on the number of retries before buffered data is discarded, and an
option to disable that limit (if true, the value of
retry_limit is ignored and
there is no limit). The default values are 17 and false (not disabled). If the limit is reached, buffered data is discarded and the retry interval is reset to its initial value (
The number of threads to flush the buffer. This option can be used to parallelize writes into the output(s) designated by the output plugin. Increasing the number of threads improves the flush throughput to hide write / network latency. The default is 1.
The threshold for checking chunk flush performance. The default value is
20.0 seconds. Note that parameter type is
If chunk flush takes longer time than this threshold, fluentd logs warning message like below:
2016-12-19 12:00:00 +0000 [warn]: buffer flush took longer time than slow_flush_log_threshold: elapsed_time = 15.0031226690043695 slow_flush_log_threshold=10.0 plugin_id="foo"
log_level option allows the user to set different levels of logging for each plugin. The supported log levels are:
Please see the logging article for further details.
This page doesn’t describe all the possible configurations. If you want to know about other configurations, please check the link below.
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is a open source project under Cloud Native Computing Foundation (CNCF), originally invented by Treasure Data, Inc. All components are available under the Apache 2 License.