populate README

This commit is contained in:
ncohensm 2016-06-22 15:30:16 -07:00
parent c4e0452436
commit 6b5a9d34bb
1 changed files with 14 additions and 21 deletions

View File

@ -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 The HTTP listener is a service input plugin that listens for messages sent via HTTP POST.
socket and adds those messages to InfluxDB. The plugin expects messages in the InfluxDB line-protocol ONLY, other Telegraf input data formats are not supported.
The plugin expects messages in the The intent of the plugin is to allow Telegraf to serve as a proxy/router for the /write endpoint of the InfluxDB HTTP API.
[Telegraf Input Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md).
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: ### Configuration:
This is a sample configuration for the plugin. This is a sample configuration for the plugin.
```toml ```toml
# Generic TCP listener # # Influx HTTP write listener
[[inputs.tcp_listener]] [[inputs.http_listener]]
## Address and port to host TCP listener on ## Address and port to host HTTP listener on
service_address = ":8094" service_address = ":8086"
## Number of TCP messages allowed to queue up. Once filled, the ## timeouts in seconds
## TCP listener will start dropping packets. read_timeout = "10"
allowed_pending_messages = 10000 write_timeout = "10"
## 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"
``` ```