exec

README

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 run at the interval of the agent.

[[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 numer of columns available for output:

$host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50)

Documentation

Index

• Constants
• type CommandRunner
  • func (c CommandRunner) Run(command string, timeout time.Duration) ([]byte, []byte, error)
• type Exec
  • func NewExec() *Exec
  • func (e *Exec) Description() string
  • func (e *Exec) Gather(acc telegraf.Accumulator) error
  • func (e *Exec) Init() error
  • func (e *Exec) ProcessCommand(command string, acc telegraf.Accumulator, wg *sync.WaitGroup)
  • func (e *Exec) SampleConfig() string
  • func (e *Exec) SetParser(parser parsers.Parser)
• type Runner

Constants

const MaxStderrBytes = 512

Types

type CommandRunner

type CommandRunner struct{}

func (CommandRunner) Run

func (c CommandRunner) Run(
	command string,
	timeout time.Duration,
) ([]byte, []byte, error)

type Exec

type Exec struct {
	Commands []string
	Command  string
	Timeout  internal.Duration

	Log telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func NewExec

func NewExec() *Exec

func (*Exec) Description

func (e *Exec) Description() string

func (*Exec) Gather

func (e *Exec) Gather(acc telegraf.Accumulator) error

func (*Exec) Init

func (e *Exec) Init() error

func (*Exec) ProcessCommand

func (e *Exec) ProcessCommand(command string, acc telegraf.Accumulator, wg *sync.WaitGroup)

func (*Exec) SampleConfig

func (e *Exec) SampleConfig() string

func (*Exec) SetParser

func (e *Exec) SetParser(parser parsers.Parser)

type Runner

type Runner interface {
	Run(string, time.Duration) ([]byte, []byte, error)
}