From 6b5a9d34bb32f0f8cd2e695564a6c42ed1fc2f80 Mon Sep 17 00:00:00 2001 From: ncohensm Date: Wed, 22 Jun 2016 15:30:16 -0700 Subject: [PATCH] populate README --- plugins/inputs/http_listener/README.md | 35 +++++++++++--------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/plugins/inputs/http_listener/README.md b/plugins/inputs/http_listener/README.md index 0066ea801..9bc458c16 100644 --- a/plugins/inputs/http_listener/README.md +++ b/plugins/inputs/http_listener/README.md @@ -1,30 +1,23 @@ -# TCP listener service input plugin +# HTTP listener service input plugin -The TCP listener is a service input plugin that listens for messages on a TCP -socket and adds those messages to InfluxDB. -The plugin expects messages in the -[Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md). +The HTTP listener is a service input plugin that listens for messages sent via HTTP POST. +The plugin expects messages in the InfluxDB line-protocol ONLY, other Telegraf input data formats are not supported. +The intent of the plugin is to allow Telegraf to serve as a proxy/router for the /write endpoint of the InfluxDB HTTP API. + +See: [Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md#influx). +Example: curl -i -XPOST 'http://localhost:8086/write' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000' ### Configuration: This is a sample configuration for the plugin. ```toml -# Generic TCP listener -[[inputs.tcp_listener]] - ## Address and port to host TCP listener on - service_address = ":8094" +# # Influx HTTP write listener +[[inputs.http_listener]] + ## Address and port to host HTTP listener on + service_address = ":8086" - ## Number of TCP messages allowed to queue up. Once filled, the - ## TCP listener will start dropping packets. - allowed_pending_messages = 10000 - - ## Maximum number of concurrent TCP connections to allow - max_tcp_connections = 250 - - ## 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 - data_format = "influx" + ## timeouts in seconds + read_timeout = "10" + write_timeout = "10" ```