telegraf/plugins/inputs/kafka_consumer/README.md

37 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2016-02-09 22:03:46 +00:00
# Kafka Consumer Input Plugin
2015-07-08 19:39:23 +00:00
The [Kafka](http://kafka.apache.org/) consumer plugin polls a specified Kafka
topic and adds messages to InfluxDB. The plugin assumes messages follow the
line protocol. [Consumer Group](http://godoc.org/github.com/wvanbergen/kafka/consumergroup)
is used to talk to the Kafka cluster so multiple instances of telegraf can read
from the same topic in parallel.
2016-02-09 22:03:46 +00:00
## Configuration
```toml
# Read metrics from Kafka topic(s)
[[inputs.kafka_consumer]]
## topic(s) to consume
2016-02-09 22:03:46 +00:00
topics = ["telegraf"]
## an array of Zookeeper connection strings
2016-02-09 22:03:46 +00:00
zookeeper_peers = ["localhost:2181"]
## the name of the consumer group
2016-02-09 22:03:46 +00:00
consumer_group = "telegraf_metrics_consumers"
## Maximum number of metrics to buffer between collection intervals
2016-02-09 22:03:46 +00:00
metric_buffer = 100000
## Offset (must be either "oldest" or "newest")
2016-02-09 22:03:46 +00:00
offset = "oldest"
## Data format to consume.
## Each data format has it's own unique set of configuration options, read
## more about them here:
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
2016-02-09 22:03:46 +00:00
data_format = "influx"
```
2015-07-08 19:39:23 +00:00
## Testing
Running integration tests requires running Zookeeper & Kafka. See Makefile
for kafka container command.