telegraf/plugins/outputs/warp10/README.md

51 lines
1.4 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Warp10 Output Plugin
The `warp10` output plugin writes metrics to [Warp 10][].
### Configuration
```toml
[[outputs.warp10]]
# Prefix to add to the measurement.
prefix = "telegraf."
# URL of the Warp 10 server
warp_url = "http://localhost:8080"
# Write token to access your app on warp 10
token = "Token"
# Warp 10 query timeout
# timeout = "15s"
## Print Warp 10 error body
# print_error_body = false
## Max string error size
# max_string_error_size = 511
## 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
```
### Output Format
Metrics are converted and sent using the [Geo Time Series][] (GTS) input format.
The class name of the reading is produced by combining the value of the
`prefix` option, the measurement name, and the field key. A dot (`.`)
character is used as the joining character.
The GTS form provides support for the Telegraf integer, float, boolean, and
string types directly. Unsigned integer fields will be capped to the largest
64-bit integer (2^63-1) in case of overflow.
Timestamps are sent in microsecond precision.
[Warp 10]: https://www.warp10.io
[Geo Time Series]: https://www.warp10.io/content/03_Documentation/03_Interacting_with_Warp_10/03_Ingesting_data/02_GTS_input_format