101 lines
3 KiB
Markdown
101 lines
3 KiB
Markdown
|
# Exec Input Plugin
|
||
|
|
|
||
|
|
This plugin executes the given `commands` on every interval and parses metrics
|
||
|
|
from their output in any one of the supported [data formats][data_formats].
|
||
|
|
This plugin can be used to poll for custom metrics from any source.
|
||
|
|
|
||
|
|
⭐ Telegraf v0.1.5
|
||
|
|
🏷️ system
|
||
|
|
💻 all
|
||
|
|
|
||
|
|
[data_formats]: /docs/DATA_FORMATS_INPUT.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
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
```toml @sample.conf
|
||
|
|
# Read metrics from one or more commands that can output to stdout
|
||
|
|
[[inputs.exec]]
|
||
|
|
## Commands array
|
||
|
|
commands = []
|
||
|
|
|
||
|
|
## 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 = []
|
||
|
|
|
||
|
|
## Timeout for each command to complete.
|
||
|
|
# timeout = "5s"
|
||
|
|
|
||
|
|
## Measurement name suffix
|
||
|
|
## Used for separating different commands
|
||
|
|
# name_suffix = ""
|
||
|
|
|
||
|
|
## Ignore Error Code
|
||
|
|
## If set to true, a non-zero error code in not considered an error and the
|
||
|
|
## plugin will continue to parse the output.
|
||
|
|
# ignore_error = false
|
||
|
|
|
||
|
|
## Data format
|
||
|
|
## By default, exec expects JSON. This was done for historical reasons and is
|
||
|
|
## different than other inputs that use the influx line protocol. 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_INPUT.md
|
||
|
|
# data_format = "json"
|
||
|
|
```
|
||
|
|
|
||
|
|
Glob patterns in the `command` option are matched on every run, so adding new
|
||
|
|
scripts that match the pattern will cause them to be picked up immediately.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
This script produces static values, since no timestamp is specified the values
|
||
|
|
are at the current time. Ensure that int values are followed with `i` for proper
|
||
|
|
parsing.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
#!/bin/sh
|
||
|
|
echo 'example,tag1=a,tag2=b i=42i,j=43i,k=44i'
|
||
|
|
```
|
||
|
|
|
||
|
|
It can be paired with the following configuration and will be run at the
|
||
|
|
`interval` of the agent.
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[[inputs.exec]]
|
||
|
|
commands = ["sh /tmp/test.sh"]
|
||
|
|
timeout = "5s"
|
||
|
|
data_format = "influx"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Common Issues
|
||
|
|
|
||
|
|
### My script works when I run it by hand, but not when Telegraf is running as a service
|
||
|
|
|
||
|
|
This may be related to the Telegraf service running as a different user. The
|
||
|
|
official packages run Telegraf as the `telegraf` user and group on Linux
|
||
|
|
systems.
|
||
|
|
|
||
|
|
### With a PowerShell on Windows, the output of the script appears to be truncated
|
||
|
|
|
||
|
|
You may need to set a variable in your script to increase the number of columns
|
||
|
|
available for output:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
$host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Metrics
|
||
|
|
|
||
|
|
## Example Output
|