2019-08-21 08:07:24 +08:00
|
|
|
# Exec Output Plugin
|
|
|
|
|
|
|
|
|
|
This plugin sends telegraf metrics to an external application over stdin.
|
|
|
|
|
|
|
|
|
|
The command should be defined similar to docker's `exec` form:
|
|
|
|
|
|
2021-11-25 02:47:33 +08:00
|
|
|
```text
|
|
|
|
|
["executable", "param1", "param2"]
|
|
|
|
|
```
|
2019-08-21 08:07:24 +08:00
|
|
|
|
|
|
|
|
On non-zero exit stderr will be logged at error level.
|
|
|
|
|
|
2021-03-19 05:21:30 +08:00
|
|
|
For better performance, consider execd, which runs continuously.
|
|
|
|
|
|
2022-10-27 03:58:36 +08:00
|
|
|
## 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.
|
|
|
|
|
|
2023-01-12 23:55:21 +08:00
|
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
2022-10-27 03:58:36 +08:00
|
|
|
|
2021-11-25 02:47:33 +08:00
|
|
|
## Configuration
|
2019-08-21 08:07:24 +08:00
|
|
|
|
2022-05-25 22:48:59 +08:00
|
|
|
```toml @sample.conf
|
2022-04-08 05:55:03 +08:00
|
|
|
# Send metrics to command as input over stdin
|
2019-08-21 08:07:24 +08:00
|
|
|
[[outputs.exec]]
|
2020-02-27 01:33:24 +08:00
|
|
|
## Command to ingest metrics via stdin.
|
2019-08-21 08:07:24 +08:00
|
|
|
command = ["tee", "-a", "/dev/null"]
|
|
|
|
|
|
2022-05-11 05:34:05 +08:00
|
|
|
## 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 = []
|
|
|
|
|
|
2019-08-21 08:07:24 +08:00
|
|
|
## Timeout for command to complete.
|
|
|
|
|
# timeout = "5s"
|
|
|
|
|
|
2023-10-13 04:32:09 +08:00
|
|
|
## Whether the command gets executed once per metric, or once per metric batch
|
|
|
|
|
## The serializer will also run in batch mode when this is true.
|
|
|
|
|
# use_batch_format = true
|
|
|
|
|
|
2019-08-21 08:07:24 +08:00
|
|
|
## Data format to output.
|
|
|
|
|
## 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"
|
|
|
|
|
```
|