Skip to content

Commit

Permalink
Merge pull request #56 from EmilS/plugins/kafka-consumer-readme
Browse files Browse the repository at this point in the history
Adds README for Kafka consumer plugin
  • Loading branch information
toddboom committed Jul 9, 2015
2 parents ed16a84 + b3c13b7 commit efe2771
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions plugins/kafka_consumer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Kafka Consumer

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.

## Testing

Running integration tests requires running Zookeeper & Kafka. The following
commands assume you're on OS X & using [boot2docker](http://boot2docker.io/).

To start Kafka & Zookeeper:

```
docker run -d -p 2181:2181 -p 9092:9092 --env ADVERTISED_HOST=`boot2docker ip` --env ADVERTISED_PORT=9092 spotify/kafka
```

To run tests:

```
ZOOKEEPER_PEERS=$(boot2docker ip):2181 KAFKA_PEERS=$(boot2docker ip):9092 go test
```

0 comments on commit efe2771

Please sign in to comment.