dom

telegraf

History

Jonas Hahnfeld 8e515688eb Add output of stderr in case of error to exec log message (#3862 ) If the command failed with a non-zero exit status there might be an error message on stderr. Append the first line to the error message to ease the search for its cause.		2018-03-14 12:09:01 -07:00
..
README.md	Update exec plugin documentation	2017-12-11 17:58:06 -08:00
exec.go	Add output of stderr in case of error to exec log message (#3862 )	2018-03-14 12:09:01 -07:00
exec_test.go	use AddError everywhere (#2372 )	2017-04-24 11:13:26 -07:00

README.md

Exec Input Plugin

The exec plugin executes the commands on every interval and parses metrics from their output in any one of the accepted Input Data Formats.

This plugin can be used to poll for custom metrics from any source.

Configuration:

[[inputs.exec]]
  ## Commands array
  commands = [
    "/tmp/test.sh",
    "/usr/bin/mycollector --foo=bar",
    "/tmp/collect_*.sh"
  ]

  ## Timeout for each command to complete.
  timeout = "5s"

  ## measurement name suffix (for separating different commands)
  name_suffix = "_mycollector"

  ## Data format to consume.
  ## 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 = "influx"

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.

#!/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 ran at the interval of the agent.

[[inputs.exec]]
  commands = ["sh /tmp/test.sh"]
  timeout = "5s"
  data_format = "influx"

Common Issues:

Q: 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.