telegraf/plugins/outputs/execd/README.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

2020-07-02 23:59:29 +08:00
# Execd Output Plugin
The `execd` plugin runs an external program as a daemon.
Telegraf minimum version: Telegraf 1.15.0
## Configuration
2020-07-02 23:59:29 +08:00
```toml @sample.conf
# Run executable as long-running output plugin
2020-07-02 23:59:29 +08:00
[[outputs.execd]]
## One program to run as daemon.
## NOTE: process and each argument should each be their own string
2020-07-02 23:59:29 +08:00
command = ["my-telegraf-output", "--some-flag", "value"]
## Environment variables
## Array of "key=value" pairs to pass as environment variables
## e.g. "KEY=value", "USERNAME=John Doe",
## "LD_LIBRARY_PATH=/opt/custom/lib64:/usr/local/libs"
# environment = []
2020-07-02 23:59:29 +08:00
## Delay before the process is restarted after an unexpected termination
restart_delay = "10s"
## Flag to determine whether execd should throw error when part of metrics is unserializable
## Setting this to true will skip the unserializable metrics and process the rest of metrics
## Setting this to false will throw error when encountering unserializable metrics and none will be processed
# ignore_serialization_error = false
2020-07-02 23:59:29 +08:00
## Data format to export.
## 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"
```
## Example
2020-07-02 23:59:29 +08:00
see [examples][]
[examples]: examples/