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, 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 contributing guide for instructions on writing new plugins.
Installation:
Linux deb and rpm packages:
Latest:
- http://get.influxdb.org/telegraf/telegraf_0.2.1_amd64.deb
- http://get.influxdb.org/telegraf/telegraf-0.2.1-1.x86_64.rpm
- Telegraf binary is installed in
/opt/telegraf/telegraf
- Telegraf daemon configuration file is in
/etc/opt/telegraf/telegraf.conf
- On sysv systems, the telegraf daemon can be controlled via
service telegraf [action]
- On systemd systems (such as Ubuntu 15+), the telegraf daemon can be
controlled via
systemctl [action] telegraf
Linux binaries:
Latest:
- http://get.influxdb.org/telegraf/telegraf_linux_amd64_0.2.1.tar.gz
- http://get.influxdb.org/telegraf/telegraf_linux_386_0.2.1.tar.gz
- http://get.influxdb.org/telegraf/telegraf_linux_arm_0.2.1.tar.gz
These are standalone binaries that can be unpacked and executed on any linux
system. They can be unpacked and renamed in a location such as
/usr/local/bin
for convenience. A config file will need to be generated,
see "How to use it" below.
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+.
- Install Go
- Setup your GOPATH
- Run
go get github.com/influxdb/telegraf
- Run
cd $GOPATH/src/github.com/influxdb/telegraf
- Run
make
How to use it:
- Run
telegraf -sample-config > telegraf.conf
to create an initial configuration. - Or run
telegraf -sample-config -filter cpu:mem -outputfilter influxdb > telegraf.conf
. to create a config file with only CPU and memory plugins defined, and InfluxDB output defined. - Edit the configuration to match your needs.
- Run
telegraf -config telegraf.conf -test
to output one full measurement sample to STDOUT. NOTE: you may want to run as the telegraf user if you are using the linux packagessudo -u telegraf telegraf -config telegraf.conf -test
- Run
telegraf -config telegraf.conf
to gather and send metrics to configured outputs. - Run
telegraf -config telegraf.conf -filter system:swap
. to run telegraf with 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.
- hostname: The hostname is passed as a tag. By default this will be
the value returned by
hostname
on the machine running Telegraf. You can override that value here. - interval: How often to gather metrics. Uses a simple number + unit parser, e.g. "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: (added in 0.1.5) 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: (added in 0.1.5) 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.
precision = "s"
# PLUGINS
[cpu]
percpu = true
totalcpu = true
Below is how to configure tagpass
and tagdrop
parameters (added in 0.1.5)
# 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:
- aerospike
- apache
- bcache
- disque
- elasticsearch
- exec (generic JSON-emitting executable plugin)
- haproxy
- httpjson (generic JSON-emitting http service plugin)
- jolokia (remote JMX with JSON over HTTP)
- kafka_consumer
- leofs
- lustre2
- memcached
- mongodb
- mysql
- nginx
- phpfpm
- ping
- postgresql
- procstat
- prometheus
- puppetagent
- rabbitmq
- redis
- rethinkdb
- twemproxy
- zfs
- zookeeper
- system
- cpu
- mem
- io
- net
- netstat
- disk
- swap
Supported Service Plugins
Telegraf can collect metrics via the following services:
- statsd
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.
Output options
Telegraf also supports specifying multiple output sinks to send data to,
configuring each output sink is different, but examples can be
found by running telegraf -sample-config
.
Supported Outputs
- influxdb
- nsq
- kafka
- datadog
- opentsdb
- amqp (rabbitmq)
- mqtt
- librato
- prometheus
- amon
Contributing
Please see the contributing guide for details on contributing a plugin or output to Telegraf.
Documentation ¶
Index ¶
- func PrintOutputConfig(name string) error
- func PrintPluginConfig(name string) error
- func PrintSampleConfig(pluginFilters []string, outputFilters []string)
- type Accumulator
- type Agent
- func (a *Agent) Close() error
- func (a *Agent) Connect() error
- func (a *Agent) LoadOutputs(filters []string, config *Config) ([]string, error)
- func (a *Agent) LoadPlugins(filters []string, config *Config) ([]string, error)
- func (a *Agent) Run(shutdown chan struct{}) error
- func (a *Agent) Test() error
- type Config
- func (c *Config) ApplyAgent(a *Agent) error
- func (c *Config) ApplyOutput(name string, v interface{}) error
- func (c *Config) GetPluginConfig(name string) *ConfiguredPlugin
- func (c *Config) ListTags() string
- func (c *Config) LoadDirectory(path string) error
- func (c *Config) Outputs() map[string]outputs.Output
- func (c *Config) OutputsDeclared() map[string]outputs.Output
- func (c *Config) Plugins() map[string]plugins.Plugin
- func (c *Config) PluginsDeclared() map[string]plugins.Plugin
- type ConfiguredPlugin
- type TagFilter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PrintOutputConfig ¶ added in v0.2.0
PrintOutputConfig prints the config usage of a single output.
func PrintPluginConfig ¶ added in v0.1.7
PrintPluginConfig prints the config usage of a single plugin.
func PrintSampleConfig ¶
PrintSampleConfig prints the sample config
Types ¶
type Accumulator ¶ added in v0.2.0
type Accumulator interface { Add(measurement string, value interface{}, tags map[string]string, t ...time.Time) AddFields(measurement string, fields map[string]interface{}, tags map[string]string, t ...time.Time) SetDefaultTags(tags map[string]string) AddDefaultTag(key, value string) Prefix() string SetPrefix(prefix string) Debug() bool SetDebug(enabled bool) }
func NewAccumulator ¶ added in v0.2.0
func NewAccumulator( plugin *ConfiguredPlugin, points chan *client.Point, ) Accumulator
type Agent ¶
type Agent struct { // Interval at which to gather information Interval internal.Duration // RoundInterval rounds collection interval to 'interval'. // ie, if Interval=10s then always collect on :00, :10, :20, etc. RoundInterval bool // Interval at which to flush data FlushInterval internal.Duration // FlushRetries is the number of times to retry each data flush FlushRetries int // FlushJitter tells FlushJitter internal.Duration // Option for outputting data in UTC UTC bool `toml:"utc"` // Precision to write data at // Valid values for Precision are n, u, ms, s, m, and h Precision string // Option for running in debug mode Debug bool Hostname string Tags map[string]string // contains filtered or unexported fields }
Agent runs telegraf and collects data based on the given config
func (*Agent) LoadOutputs ¶ added in v0.1.4
LoadOutputs loads the agent's outputs
func (*Agent) LoadPlugins ¶
LoadPlugins loads the agent's plugins
type Config ¶
type Config struct { // This lives outside the agent because mergeStruct doesn't need to handle // maps normally. We just copy the elements manually in ApplyAgent. 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 ¶
LoadConfig loads the given config file and returns a *Config pointer
func (*Config) ApplyAgent ¶
ApplyAgent loads the Agent struct built from the config into the given Agent struct. Overrides only values in the given struct that were set in the config.
func (*Config) ApplyOutput ¶ added in v0.1.4
ApplyOutput loads the Output struct built from the config into the given Output struct. Overrides only values in the given struct that were set in the config.
func (*Config) GetPluginConfig ¶ added in v0.2.2
func (c *Config) GetPluginConfig(name string) *ConfiguredPlugin
func (*Config) ListTags ¶
ListTags returns a string of tags specified in the config, line-protocol style
func (*Config) LoadDirectory ¶ added in v0.2.0
func (*Config) Outputs ¶ added in v0.1.4
Outputs returns the configured outputs as a map of name -> outputs.Output
func (*Config) OutputsDeclared ¶ added in v0.1.4
OutputsDeclared returns the name of all outputs 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
Directories ¶
Path | Synopsis |
---|---|
Godeps
|
|
_workspace/src/bitbucket.org/ww/goautoneg
HTTP Content-Type Autonegotiation.
|
HTTP Content-Type Autonegotiation. |
_workspace/src/git.eclipse.org/gitroot/paho/org.eclipse.paho.mqtt.golang.git
Package mqtt provides an MQTT v3.1.1 client library.
|
Package mqtt provides an MQTT v3.1.1 client library. |
_workspace/src/github.com/Shopify/sarama
Package sarama provides client libraries for the Kafka 0.8 protocol.
|
Package sarama provides client libraries for the Kafka 0.8 protocol. |
_workspace/src/github.com/Shopify/sarama/mocks
Package mocks provides mocks that can be used for testing applications that use Sarama.
|
Package mocks provides mocks that can be used for testing applications that use Sarama. |
+build go1.3 | |
_workspace/src/github.com/beorn7/perks/quantile
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds.
|
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds. |
_workspace/src/github.com/boltdb/bolt
Package bolt implements a low-level key/value store in pure Go.
|
Package bolt implements a low-level key/value store in pure Go. |
_workspace/src/github.com/cenkalti/backoff
Package backoff implements backoff algorithms for retrying operations.
|
Package backoff implements backoff algorithms for retrying operations. |
_workspace/src/github.com/eapache/go-resiliency/breaker
Package breaker implements the circuit-breaker resiliency pattern for Go.
|
Package breaker implements the circuit-breaker resiliency pattern for Go. |
_workspace/src/github.com/eapache/queue
Package queue provides a fast, ring-buffer queue based on the version suggested by Dariusz Górecki.
|
Package queue provides a fast, ring-buffer queue based on the version suggested by Dariusz Górecki. |
_workspace/src/github.com/fsouza/go-dockerclient
Package docker provides a client for the Docker remote API.
|
Package docker provides a client for the Docker remote API. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/Sirupsen/logrus
Package logrus is a structured logger for Go, completely API compatible with the standard library logger.
|
Package logrus is a structured logger for Go, completely API compatible with the standard library logger. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/docker/pkg/parsers
Package parsers provides helper functions to parse and validate different type of string.
|
Package parsers provides helper functions to parse and validate different type of string. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/docker/pkg/pools
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/docker/pkg/ulimit
Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version).
|
Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version). |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/docker/docker/pkg/units
Package units provides helper function to parse and print size and time units in human-readable format.
|
Package units provides helper function to parse and print size and time units in human-readable format. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
_workspace/src/github.com/fsouza/go-dockerclient/external/github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
_workspace/src/github.com/fsouza/go-dockerclient/testing
Package testing provides a fake implementation of the Docker API, useful for testing purpose.
|
Package testing provides a fake implementation of the Docker API, useful for testing purpose. |
_workspace/src/github.com/go-sql-driver/mysql
Go MySQL Driver - A MySQL-Driver for Go's database/sql package
|
Go MySQL Driver - A MySQL-Driver for Go's database/sql package |
_workspace/src/github.com/gogo/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
_workspace/src/github.com/gogo/protobuf/proto/proto3_proto
Package proto3_proto is a generated protocol buffer package.
|
Package proto3_proto is a generated protocol buffer package. |
_workspace/src/github.com/golang/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
_workspace/src/github.com/golang/protobuf/proto/proto3_proto
Package proto3_proto is a generated protocol buffer package.
|
Package proto3_proto is a generated protocol buffer package. |
_workspace/src/github.com/golang/snappy
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
_workspace/src/github.com/gonuts/go-shellquote
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules.
|
Shellquote provides utilities for joining/splitting strings using sh's word-splitting rules. |
_workspace/src/github.com/hashicorp/go-msgpack/codec
High Performance, Feature-Rich Idiomatic Go encoding library for msgpack and binc .
|
High Performance, Feature-Rich Idiomatic Go encoding library for msgpack and binc . |
_workspace/src/github.com/influxdb/influxdb/influxql
Package influxql implements a parser for the InfluxDB query language.
|
Package influxql implements a parser for the InfluxDB query language. |
_workspace/src/github.com/influxdb/influxdb/services/hh
Package hh implements a hinted handoff for writes
|
Package hh implements a hinted handoff for writes |
_workspace/src/github.com/influxdb/influxdb/tsdb
Package tsdb implements a durable time series database.
|
Package tsdb implements a durable time series database. |
_workspace/src/github.com/influxdb/influxdb/tsdb/engine/wal
Package WAL implements a write ahead log optimized for write throughput that can be put in front of the database index.
|
Package WAL implements a write ahead log optimized for write throughput that can be put in front of the database index. |
_workspace/src/github.com/lib/pq
Package pq is a pure Go Postgres driver for the database/sql package.
|
Package pq is a pure Go Postgres driver for the database/sql package. |
_workspace/src/github.com/lib/pq/listen_example
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive.
|
Below you will find a self-contained Go program which uses the LISTEN / NOTIFY mechanism to avoid polling the database while waiting for more work to arrive. |
_workspace/src/github.com/lib/pq/oid
Package oid contains OID constants as defined by the Postgres server.
|
Package oid contains OID constants as defined by the Postgres server. |
_workspace/src/github.com/matttproud/golang_protobuf_extensions/pbutil
Package pbutil provides record length-delimited Protocol Buffer streaming.
|
Package pbutil provides record length-delimited Protocol Buffer streaming. |
_workspace/src/github.com/mreiferson/go-snappystream
snappystream wraps snappy-go and supplies a Reader and Writer for the snappy framed stream format:
|
snappystream wraps snappy-go and supplies a Reader and Writer for the snappy framed stream format: |
_workspace/src/github.com/mreiferson/go-snappystream/snappy-go
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
_workspace/src/github.com/nsqio/go-nsq
Package nsq is the official Go package for NSQ (http://nsq.io/)
|
Package nsq is the official Go package for NSQ (http://nsq.io/) |
_workspace/src/github.com/pborman/uuid
The uuid package generates and inspects UUIDs.
|
The uuid package generates and inspects UUIDs. |
_workspace/src/github.com/prometheus/client_golang/extraction
Package extraction decodes Prometheus clients' data streams for consumers.
|
Package extraction decodes Prometheus clients' data streams for consumers. |
_workspace/src/github.com/prometheus/client_golang/model
Package model contains core representation of Prometheus client primitives.
|
Package model contains core representation of Prometheus client primitives. |
_workspace/src/github.com/prometheus/client_golang/prometheus
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface.
|
Package prometheus provides embeddable metric primitives for servers and standardized exposition of telemetry through a web services interface. |
_workspace/src/github.com/prometheus/client_golang/text
Package text contains helper functions to parse and create text-based exchange formats.
|
Package text contains helper functions to parse and create text-based exchange formats. |
_workspace/src/github.com/prometheus/client_model/go
Package io_prometheus_client is a generated protocol buffer package.
|
Package io_prometheus_client is a generated protocol buffer package. |
_workspace/src/github.com/prometheus/common/expfmt
A package for reading and writing Prometheus metrics.
|
A package for reading and writing Prometheus metrics. |
_workspace/src/github.com/prometheus/common/model
Package model contains common data structures that are shared across Prometheus componenets and libraries.
|
Package model contains common data structures that are shared across Prometheus componenets and libraries. |
_workspace/src/github.com/prometheus/procfs
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc.
|
Package procfs provides functions to retrieve system, kernel and process metrics from the pseudo-filesystem proc. |
_workspace/src/github.com/samuel/go-zookeeper/zk
Package zk is a native Go client library for the ZooKeeper orchestration service.
|
Package zk is a native Go client library for the ZooKeeper orchestration service. |
_workspace/src/github.com/shirou/gopsutil/common
gopsutil is a port of psutil(http://pythonhosted.org/psutil/).
|
gopsutil is a port of psutil(http://pythonhosted.org/psutil/). |
_workspace/src/github.com/shirou/gopsutil/disk
Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints.
|
Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints. |
_workspace/src/github.com/shirou/gopsutil/process
Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints.
|
Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints. |
_workspace/src/github.com/streadway/amqp
AMQP 0.9.1 client with RabbitMQ extensions
|
AMQP 0.9.1 client with RabbitMQ extensions |
_workspace/src/github.com/stretchr/objx
objx - Go package for dealing with maps, slices, JSON and other data.
|
objx - Go package for dealing with maps, slices, JSON and other data. |
_workspace/src/github.com/stretchr/testify/assert
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
Package assert provides a set of comprehensive testing tools for use with the normal Go testing system. |
_workspace/src/github.com/stretchr/testify/mock
Provides a system by which it is possible to mock your objects and verify calls are happening as expected.
|
Provides a system by which it is possible to mock your objects and verify calls are happening as expected. |
_workspace/src/github.com/stretchr/testify/require
Alternative testing tools which stop test execution if test failed.
|
Alternative testing tools which stop test execution if test failed. |
_workspace/src/github.com/stretchr/testify/suite
The suite package contains logic for creating testing suite structs and running the methods on those structs as tests.
|
The suite package contains logic for creating testing suite structs and running the methods on those structs as tests. |
_workspace/src/golang.org/x/crypto/bcrypt
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.
|
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm. |
_workspace/src/golang.org/x/crypto/blowfish
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
|
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm. |
_workspace/src/golang.org/x/net/websocket
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
|
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455. |
_workspace/src/gopkg.in/dancannon/gorethink.v1
Package gorethink implements a Go driver for RethinkDB
|
Package gorethink implements a Go driver for RethinkDB |
_workspace/src/gopkg.in/fatih/pool.v2
Package pool implements a pool of net.Conn interfaces to manage and reuse them.
|
Package pool implements a pool of net.Conn interfaces to manage and reuse them. |
_workspace/src/gopkg.in/mgo.v2
Package mgo offers a rich MongoDB driver for Go.
|
Package mgo offers a rich MongoDB driver for Go. |
_workspace/src/gopkg.in/mgo.v2/bson
Package bson is an implementation of the BSON specification for Go:
|
Package bson is an implementation of the BSON specification for Go: |
_workspace/src/gopkg.in/mgo.v2/testserver
WARNING: This package was replaced by mgo.v2/dbtest.
|
WARNING: This package was replaced by mgo.v2/dbtest. |
_workspace/src/gopkg.in/mgo.v2/txn
The txn package implements support for multi-document transactions.
|
The txn package implements support for multi-document transactions. |
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
cmd
|
|
lustre2
Lustre 2.x telegraf plugin
|
Lustre 2.x telegraf plugin |