telegraf/plugins/outputs/websocket
Sven Rebhan d9a6d8b774
chore: embed sample configurations into README for outputs (#11182)
2022-05-25 08:48:59 -06:00
..
README.md chore: embed sample configurations into README for outputs (#11182) 2022-05-25 08:48:59 -06:00
sample.conf chore(outputs): migrate sample configs into separate files (#11131) 2022-05-18 11:30:06 -05:00
websocket.go chore: embed sample configurations into README for outputs (#11182) 2022-05-25 08:48:59 -06:00
websocket_test.go Add WebSocket output plugin (#9188) 2021-06-03 22:53:38 -06:00

README.md

Websocket Output Plugin

This plugin can write to a WebSocket endpoint.

It can output data in any of the supported output formats.

Configuration

# A plugin that can transmit metrics over WebSocket.
[[outputs.websocket]]
  ## URL is the address to send metrics to. Make sure ws or wss scheme is used.
  url = "ws://127.0.0.1:3000/telegraf"

  ## Timeouts (make sure read_timeout is larger than server ping interval or set to zero).
  # connect_timeout = "30s"
  # write_timeout = "30s"
  # read_timeout = "30s"

  ## Optionally turn on using text data frames (binary by default).
  # use_text_frames = false

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

  ## Optional SOCKS5 proxy to use
  # socks5_enabled = true
  # socks5_address = "127.0.0.1:1080"
  # socks5_username = "alice"
  # socks5_password = "pass123"

  ## Data format to output.
  ## 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_OUTPUT.md
  # data_format = "influx"

  ## Additional HTTP Upgrade headers
  # [outputs.websocket.headers]
  #   Authorization = "Bearer <TOKEN>"