Adding upstream version 1.34.4.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
e393c3af3f
commit
4978089aab
4963 changed files with 677545 additions and 0 deletions
75
plugins/outputs/websocket/README.md
Normal file
75
plugins/outputs/websocket/README.md
Normal file
|
@ -0,0 +1,75 @@
|
|||
# Websocket Output Plugin
|
||||
|
||||
This plugin writes metrics to a WebSocket endpoint in one of the supported
|
||||
[data formats][data_formats].
|
||||
|
||||
⭐ Telegraf v1.19.0
|
||||
🏷️ applications, web
|
||||
💻 all
|
||||
|
||||
[data_formats]: /docs/DATA_FORMATS_OUTPUT.md
|
||||
|
||||
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
||||
|
||||
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][CONFIGURATION.md] for more details.
|
||||
|
||||
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
||||
|
||||
## Secret-store support
|
||||
|
||||
This plugin supports secrets from secret-stores for the `headers` option.
|
||||
See the [secret-store documentation][SECRETSTORE] for more details on how
|
||||
to use them.
|
||||
|
||||
[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets
|
||||
|
||||
## Configuration
|
||||
|
||||
```toml @sample.conf
|
||||
# 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"
|
||||
|
||||
## Optional HTTP proxy to use
|
||||
# use_system_proxy = false
|
||||
# http_proxy_url = "http://localhost:8888"
|
||||
|
||||
## 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"
|
||||
|
||||
## NOTE: Due to the way TOML is parsed, tables must be at the END of the
|
||||
## plugin definition, otherwise additional config options are read as part of
|
||||
## the table
|
||||
|
||||
## Additional HTTP Upgrade headers
|
||||
# [outputs.websocket.headers]
|
||||
# Authorization = "Bearer <TOKEN>"
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue