telegraf/plugins/outputs/socket_writer
Sven Rebhan 18cdb1a99e
chore(serializers)!: Remove old-style creation (#15971)
2024-12-05 08:32:10 -06:00
..
README.md docs(outputs): Add plugin metadata and update description (#16061) 2024-10-28 18:00:22 +01:00
sample.conf feat(socket_listener): Add vsock support to socket listener and writer (#14172) 2023-10-25 15:13:37 -06:00
socket_writer.go chore(serializers)!: Remove old-style creation (#15971) 2024-12-05 08:32:10 -06:00
socket_writer_test.go chore(serializers)!: Remove old-style creation (#15971) 2024-12-05 08:32:10 -06:00

README.md

Socket Writer Output Plugin

This plugin writes metrics to a network service e.g. via UDP or TCP in one of the supported data formats.

Telegraf v1.3.0 🏷️ applications, networking 💻 all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# 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"
  # address = "vsock://cid:port"

  ## 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"

  ## Data format to generate.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  # data_format = "influx"