telegraf

README

Telegraf - A native agent for InfluxDB

Telegraf is an agent written in Go for collecting metrics from the system it's running on or from other services and writing them into InfluxDB.

Design goals are to have a minimal memory footprint with a plugin system so that developers in the community can easily add support for collecting metrics from well known services (like Hadoop, or Postgres, or Redis) and third party APIs (like Mailchimp, AWS CloudWatch, or Google Analytics).

We'll eagerly accept pull requests for new plugins and will manage the set of plugins that Telegraf supports. See the bottom of this doc for instructions on writing new plugins.

Quickstart

• Build from source or download telegraf:

Linux packages for Debian/Ubuntu and RHEL/CentOS:

NOTE: version 0.1.4+ has introduced some breaking changes! A 0.1.4+ telegraf agent is NOT backwards-compatible with a config file from 0.1.3 and below. That being said, the difference is not huge, see below for an example on how to setup the new config file.

As well, due to a breaking change to the InfluxDB integer line-protocol, there are some InfluxDB compatibility requirements:

• InfluxDB 0.9.3+ (including nightly builds) requires Telegraf 0.1.5+
• InfluxDB 0.9.2 and prior requires Telegraf 0.1.4

Latest:

• http://get.influxdb.org/telegraf/telegraf_0.1.6_amd64.deb
• http://get.influxdb.org/telegraf/telegraf-0.1.6-1.x86_64.rpm

0.1.4:

• http://get.influxdb.org/telegraf/telegraf_0.1.4_amd64.deb
• http://get.influxdb.org/telegraf/telegraf-0.1.4-1.x86_64.rpm

OSX via Homebrew:

brew update
brew install telegraf

From Source:

Telegraf manages dependencies via godep, which gets installed via the Makefile if you don't have it already. You also must build with golang version 1.4+

1. Install Go
2. Setup your GOPATH
3. run go get github.com/influxdb/telegraf
4. cd $GOPATH/src/github.com/influxdb/telegraf
5. run make

How to use it:

• Run telegraf -sample-config > telegraf.toml to create an initial configuration
• Edit the configuration to match your needs
• Run telegraf -config telegraf.toml -test to output one full measurement sample to STDOUT
• Run telegraf -config telegraf.toml to gather and send metrics to configured outputs.
• Run telegraf -config telegraf.toml -filter system:swap to enable only the system & swap plugins defined in the config.

Telegraf Options

Telegraf has a few options you can configure under the agent section of the config. If you don't see an agent section run telegraf -sample-config > telegraf.toml to create a valid initial configuration:

• hostname: The hostname is passed as a tag. By default this will be the value retured by hostname on the machine running Telegraf. You can override that value here.
• interval: How ofter to gather metrics. Uses a simple number + unit parser, ie "10s" for 10 seconds or "5m" for 5 minutes.
• debug: Set to true to gather and send metrics to STDOUT as well as InfluxDB.

Plugin Options

There are 5 configuration options that are configurable per plugin:

• pass: An array of strings that is used to filter metrics generated by the current plugin. Each string in the array is tested as a prefix against metric names and if it matches, the metric is emitted.
• drop: The inverse of pass, if a metric name matches, it is not emitted.
• tagpass: tag names and arrays of strings that are used to filter metrics by the current plugin. Each string in the array is tested as an exact match against the tag name, and if it matches the metric is emitted.
• tagdrop: The inverse of tagpass. If a tag matches, the metric is not emitted. This is tested on metrics that have passed the tagpass test.
• interval: How often to gather this metric. Normal plugins use a single global interval, but if one particular plugin should be run less or more often, you can configure that here.

Plugin Configuration Examples

This is a full working config that will output CPU data to an InfluxDB instance at 192.168.59.103:8086, tagging measurements with dc="denver-1". It will output measurements at a 10s interval and will collect totalcpu & percpu data.

[tags]
    dc = "denver-1"

[agent]
    interval = "10s"

# OUTPUTS
[outputs]
[outputs.influxdb]
    url = "http://192.168.59.103:8086" # required.
    database = "telegraf" # required.

# PLUGINS
[cpu]
    percpu = true
    totalcpu = true

Below is how to configure tagpass parameters (added in 0.1.4)

# Don't collect CPU data for cpu6 & cpu7
[cpu.tagdrop]
    cpu = [ "cpu6", "cpu7" ]

[disk]
[disk.tagpass]
    # tagpass conditions are OR, not AND.
    # If the (filesystem is ext4 or xfs) OR (the path is /opt or /home)
    # then the metric passes
    fstype = [ "ext4", "xfs" ]
    path = [ "/opt", "/home" ]

Supported Plugins

You can view usage instructions for each plugin by running telegraf -usage <pluginname>

Telegraf currently has support for collecting metrics from

• disque
• elasticsearch
• exec (generic JSON-emitting executable plugin)
• haproxy
• httpjson (generic JSON-emitting http service plugin)
• kafka_consumer
• leofs
• lustre2
• memcached
• mongodb
• mysql
• nginx
• postgresql
• prometheus
• rabbitmq
• redis
• rethinkdb
• system (mem, CPU, load, etc.)

We'll be adding support for many more over the coming months. Read on if you want to add support for another service or third-party API.

Plugins

This section is for developers that want to create new collection plugins. Telegraf is entirely plugin driven. This interface allows for operators to pick and chose what is gathered as well as makes it easy for developers to create new ways of generating metrics.

Plugin authorship is kept as simple as possible to promote people to develop and submit new plugins.

Guidelines

• A plugin must conform to the plugins.Plugin interface.
• Telegraf promises to run each plugin's Gather function serially. This means developers don't have to worry about thread safety within these functions.
• Each generated metric automatically has the name of the plugin that generated it prepended. This is to keep plugins honest.
• Plugins should call plugins.Add in their init function to register themselves. See below for a quick example.
• To be available within Telegraf itself, plugins must add themselves to the github.com/influxdb/telegraf/plugins/all/all.go file.
• The SampleConfig function should return valid toml that describes how the plugin can be configured. This is include in telegraf -sample-config.
• The Description function should say in one line what this plugin does.

Plugin interface

type Plugin interface {
	SampleConfig() string
	Description() string
	Gather(Accumulator) error
}

type Accumulator interface {
	Add(measurement string, value interface{}, tags map[string]string)
	AddValuesWithTime(measurement string,
		values map[string]interface{},
		tags map[string]string,
		timestamp time.Time)
}

Accumulator

The way that a plugin emits metrics is by interacting with the Accumulator.

The Add function takes 3 arguments:

• measurement: A string description of the metric. For instance bytes_read or faults.
• value: A value for the metric. This accepts 5 different types of value:
  • int: The most common type. All int types are accepted but favor using int64 Useful for counters, etc.
  • float: Favor float64, useful for gauges, percentages, etc.
  • bool: true or false, useful to indicate the presence of a state. light_on, etc.
  • string: Typically used to indicate a message, or some kind of freeform information.
  • time.Time: Useful for indicating when a state last occurred, for instance light_on_since.
• tags: This is a map of strings to strings to describe the where or who about the metric. For instance, the net plugin adds a tag named "interface" set to the name of the network interface, like "eth0".

The AddValuesWithTime allows multiple values for a point to be passed. The values used are the same type profile as value above. The timestamp argument allows a point to be registered as having occurred at an arbitrary time.

Let's say you've written a plugin that emits metrics about processes on the current host.

type Process struct {
	CPUTime float64
	MemoryBytes int64
	PID int
}

func Gather(acc plugins.Accumulator) error {
	for _, process := range system.Processes() {
		tags := map[string]string {
			"pid": fmt.Sprintf("%d", process.Pid),
		}

		acc.Add("cpu", process.CPUTime, tags)
		acc.Add("memory", process.MemoryBytes, tags)
	}
}

Example

package simple

// simple.go

import "github.com/influxdb/telegraf/plugins"

type Simple struct {
	Ok bool
}

func (s *Simple) Description() string {
	return "a demo plugin"
}

func (s *Simple) SampleConfig() string {
	return "ok = true # indicate if everything is fine"
}

func (s *Simple) Gather(acc plugins.Accumulator) error {
	if s.Ok {
		acc.Add("state", "pretty good", nil)
	} else {
		acc.Add("state", "not great", nil)
	}

	return nil
}

func init() {
	plugins.Add("simple", func() plugins.Plugin { return &Simple{} })
}

Testing

Execute short tests:

execute make test-short

Execute long tests:

As Telegraf collects metrics from several third-party services it becomes a difficult task to mock each service as some of them have complicated protocols which would take some time to replicate.

To overcome this situation we've decided to use docker containers to provide a fast and reproducible environment to test those services which require it. For other situations (i.e: https://github.com/influxdb/telegraf/blob/master/plugins/redis/redis_test.go ) a simple mock will suffice.

To execute Telegraf tests follow these simple steps:

• Install docker compose following these instructions
  • mac users should be able to simply do brew install boot2docker and brew install docker-compose
• execute make test

Unit test troubleshooting:

Try cleaning up your test environment by executing make test-cleanup and re-running

Documentation

Index

• func PrintPluginConfig(name string) error
• func PrintSampleConfig()
• type Agent
  • func NewAgent(config *Config) (*Agent, error)
  • func (a *Agent) Close() error
  • func (a *Agent) Connect() error
  • func (a *Agent) LoadOutputs() ([]string, error)
  • func (a *Agent) LoadPlugins(pluginsFilter string) ([]string, error)
  • func (a *Agent) Run(shutdown chan struct{}) error
  • func (a *Agent) Test() error
  • func (a *Agent) TestAllPlugins() error
• type BatchPoints
  • func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]string)
  • func (bp *BatchPoints) AddValuesWithTime(measurement string, values map[string]interface{}, tags map[string]string, ...)
• type Config
  • func LoadConfig(path string) (*Config, error)
  • func (c *Config) ApplyAgent(v interface{}) error
  • func (c *Config) ApplyOutput(name string, v interface{}) error
  • func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, error)
  • func (c *Config) ListTags() string
  • func (c *Config) Outputs() map[string]*ast.Table
  • func (c *Config) OutputsDeclared() []string
  • func (c *Config) Plugins() map[string]*ast.Table
  • func (c *Config) PluginsDeclared() []string
• type ConfiguredPlugin
  • func (cp *ConfiguredPlugin) ShouldPass(measurement string, tags map[string]string) bool
• type Duration
  • func (d *Duration) UnmarshalTOML(b []byte) error
• type TagFilter

Functions

func PrintPluginConfig

func PrintPluginConfig(name string) error

PrintPluginConfig prints the config usage of a single plugin.

func PrintSampleConfig

func PrintSampleConfig()

PrintSampleConfig prints the sample config!

Types

type Agent

type Agent struct {

	// Interval at which to gather information
	Interval Duration

	// Run in debug mode?
	Debug    bool
	Hostname string

	Config *Config
	// contains filtered or unexported fields
}

Agent runs telegraf and collects data based on the given config

func NewAgent

func NewAgent(config *Config) (*Agent, error)

NewAgent returns an Agent struct based off the given Config

func (*Agent) Close

func (a *Agent) Close() error

Close closes the connection to all configured outputs

func (*Agent) Connect

func (a *Agent) Connect() error

Connect connects to all configured outputs

func (*Agent) LoadOutputs

func (a *Agent) LoadOutputs() ([]string, error)

LoadOutputs loads the agent's outputs

func (*Agent) LoadPlugins

func (a *Agent) LoadPlugins(pluginsFilter string) ([]string, error)

LoadPlugins loads the agent's plugins

func (*Agent) Run

func (a *Agent) Run(shutdown chan struct{}) error

Run runs the agent daemon, gathering every Interval

func (*Agent) Test

func (a *Agent) Test() error

Test verifies that we can 'Gather' from all plugins with their configured Config struct

func (*Agent) TestAllPlugins

func (a *Agent) TestAllPlugins() error

TestAllPlugins verifies that we can 'Gather' from all plugins with the default configuration

type BatchPoints

type BatchPoints struct {
	client.BatchPoints

	Debug bool

	Prefix string

	Config *ConfiguredPlugin
	// contains filtered or unexported fields
}

BatchPoints is used to send a batch of data in a single write from telegraf to influx

func (*BatchPoints) Add

func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]string)

Add adds a measurement

func (*BatchPoints) AddValuesWithTime

func (bp *BatchPoints) AddValuesWithTime(
	measurement string,
	values map[string]interface{},
	tags map[string]string,
	timestamp time.Time,
)

AddValuesWithTime adds a measurement with a provided timestamp

type Config

type Config struct {
	Tags map[string]string
	// contains filtered or unexported fields
}

Config specifies the URL/user/password for the database that telegraf will be logging to, as well as all the plugins that the user has specified

func LoadConfig

func LoadConfig(path string) (*Config, error)

LoadConfig loads the given config file and returns a *Config pointer

func (*Config) ApplyAgent

func (c *Config) ApplyAgent(v interface{}) error

ApplyAgent loads the toml config into the given interface

func (*Config) ApplyOutput

func (c *Config) ApplyOutput(name string, v interface{}) error

ApplyOutput loads the toml config into the given interface

func (*Config) ApplyPlugin

func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, error)

ApplyPlugin takes defined plugin names and applies them to the given interface, returning a ConfiguredPlugin object in the end that can be inserted into a runningPlugin by the agent.

func (*Config) ListTags

func (c *Config) ListTags() string

ListTags returns a string of tags specified in the config, line-protocol style

func (*Config) Outputs

func (c *Config) Outputs() map[string]*ast.Table

Outputs returns the configured outputs as a map of name -> output toml

func (*Config) OutputsDeclared

func (c *Config) OutputsDeclared() []string

OutputsDeclared returns the name of all outputs declared in the config.

func (*Config) Plugins

func (c *Config) Plugins() map[string]*ast.Table

Plugins returns the configured plugins as a map of name -> plugin toml

func (*Config) PluginsDeclared

func (c *Config) PluginsDeclared() []string

PluginsDeclared returns the name of all plugins declared in the config.

type ConfiguredPlugin

type ConfiguredPlugin struct {
	Name string

	Drop []string
	Pass []string

	TagDrop []TagFilter
	TagPass []TagFilter

	Interval time.Duration
}

ConfiguredPlugin containing a name, interval, and drop/pass prefix lists Also lists the tags to filter

func (*ConfiguredPlugin) ShouldPass

func (cp *ConfiguredPlugin) ShouldPass(measurement string, tags map[string]string) bool

ShouldPass returns true if the metric should pass, false if should drop

type Duration

type Duration struct {
	time.Duration
}

Duration just wraps time.Duration

func (*Duration) UnmarshalTOML

func (d *Duration) UnmarshalTOML(b []byte) error

UnmarshalTOML parses the duration from the TOML config file

type TagFilter

type TagFilter struct {
	Name   string
	Filter []string
}

TagFilter is the name of a tag, and the values on which to filter