MQTT Consumer Input plugin

plugins/inputs/kafka_consumer/README.md

@@ -1,4 +1,4 @@
-# Kafka Consumer
+# Kafka Consumer Input Plugin
 
 The [Kafka](http://kafka.apache.org/) consumer plugin polls a specified Kafka
 topic and adds messages to InfluxDB. The plugin assumes messages follow the
@@ -6,6 +6,29 @@ line protocol. [Consumer Group](http://godoc.org/github.com/wvanbergen/kafka/con
 is used to talk to the Kafka cluster so multiple instances of telegraf can read
 from the same topic in parallel.
 
+## Configuration
+
+```toml
+# Read metrics from Kafka topic(s)
+[[inputs.kafka_consumer]]
+  ### topic(s) to consume
+  topics = ["telegraf"]
+  ### an array of Zookeeper connection strings
+  zookeeper_peers = ["localhost:2181"]
+  ### the name of the consumer group
+  consumer_group = "telegraf_metrics_consumers"
+  ### Maximum number of metrics to buffer between collection intervals
+  metric_buffer = 100000
+  ### Offset (must be either "oldest" or "newest")
+  offset = "oldest"
+
+  ### Data format to consume. This can be "json", "influx" or "graphite"
+  ### Each data format has it's own unique set of configuration options, read
+  ### more about them here:
+  ### https://github.com/influxdata/telegraf/blob/master/DATA_FORMATS_INPUT.md
+  data_format = "influx"
+```
+
 ## Testing
 
 Running integration tests requires running Zookeeper & Kafka. The following
@@ -16,9 +39,3 @@ To start Kafka & Zookeeper:
 ```
 docker run -d -p 2181:2181 -p 9092:9092 --env ADVERTISED_HOST=`boot2docker ip || docker-machine ip <your_machine_name>` --env ADVERTISED_PORT=9092 spotify/kafka
 ```
-
-To run tests:
-
-```
-go test
-```