telegraf/plugins/outputs/socket_writer/README.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

2017-02-16 23:13:14 +00:00
# socket_writer Plugin
The socket_writer plugin can write to a UDP, TCP, or unix socket.
It can output data in any of the [supported output formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md).
```toml
# Generic socket writer capable of handling multiple socket types.
[[outputs.socket_writer]]
## URL to connect to
# address = "tcp://127.0.0.1:8094"
# address = "tcp://example.com:http"
# address = "tcp4://127.0.0.1:8094"
# address = "tcp6://127.0.0.1:8094"
# address = "tcp6://[2001:db8::1]:8094"
# address = "udp://127.0.0.1:8094"
# address = "udp4://127.0.0.1:8094"
# address = "udp6://127.0.0.1:8094"
# address = "unix:///tmp/telegraf.sock"
# address = "unixgram:///tmp/telegraf.sock"
2018-05-04 23:33:23 +00:00
## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
# tls_cert = "/etc/telegraf/cert.pem"
# tls_key = "/etc/telegraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = false
## Period between keep alive probes.
## Only applies to TCP sockets.
## 0 disables keep alive probes.
## Defaults to the OS configuration.
# keep_alive_period = "5m"
## Content encoding for message payloads, can be set to "gzip" or to
## "identity" to apply no encoding.
##
# content_encoding = "identity"
2017-02-16 23:13:14 +00:00
## Data format to generate.
2017-04-27 21:59:18 +00:00
## Each data format has its own unique set of configuration options, read
2017-02-16 23:13:14 +00:00
## more about them here:
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
# data_format = "influx"
```