Go to file
Cameron Sparr 22243a8354
Skip service input plugins in test mode
2017-02-13 10:40:38 +00:00
.github update PR template with changelog note 2016-08-17 18:24:06 +01:00
agent Skip service input plugins in test mode 2017-02-13 10:40:38 +00:00
cmd/telegraf Remove pidfile if pidfile was created (#2358) 2017-02-03 10:02:19 +00:00
docs Switch to github.com/kballard/go-shellquote (#1950) 2016-11-16 11:24:11 -05:00
etc Rewriting Riemann output plugin (#1900) 2017-01-27 14:54:59 -08:00
filter Refactor and code cleanup of filtering 2016-09-05 16:30:18 +01:00
internal don't use influxdata/config, just use influxdata/toml 2017-02-10 17:27:18 +00:00
logger Use rfc3339 timestamps in telegraf log output 2016-11-03 18:39:02 +00:00
metric Remove metric.Point from metric interface 2017-02-03 16:53:07 +00:00
plugins deprecate udp_listener & tcp_listener 2017-02-06 10:41:44 +00:00
scripts Debian package: check for group before useradd (#2107) 2017-01-24 14:54:19 -08:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil add socket listener & writer (#2094) 2017-02-02 16:24:03 +00:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore add build directory to git ignore (#1415) 2016-06-25 11:17:51 +01:00
CHANGELOG.md deprecate udp_listener & tcp_listener 2017-02-06 10:41:44 +00:00
CONTRIBUTING.md Processor & Aggregator Contrib doc 2016-10-12 14:50:19 +01:00
Godeps don't use influxdata/config, just use influxdata/toml 2017-02-10 17:27:18 +00:00
Godeps_windows Importing pdh from github.com/lxn/win 2016-12-20 12:06:40 +00:00
LICENSE Initial commit 2015-04-01 09:28:44 -07:00
Makefile Rewriting Riemann output plugin (#1900) 2017-01-27 14:54:59 -08:00
README.md deprecate udp_listener & tcp_listener 2017-02-06 10:41:44 +00:00
accumulator.go Support Processor & Aggregator Plugins 2016-10-12 14:50:19 +01:00
aggregator.go Refactor handling of MinMax functionality into RunningAggregator 2016-10-12 14:50:19 +01:00
circle.yml Go version 1.7.4 -> 1.7.5 (#2348) 2017-02-01 10:07:02 +00:00
input.go Flush based on buffer size rather than time 2016-02-16 22:25:22 -07:00
metric.go Remove metric.Point from metric interface 2017-02-03 16:53:07 +00:00
output.go Throughout telegraf, use telegraf.Metric rather than client.Point 2016-01-27 23:47:32 -07:00
processor.go Support Processor & Aggregator Plugins 2016-10-12 14:50:19 +01:00

README.md

Telegraf Circle CI Docker pulls

Telegraf is an agent written in Go for collecting, processing, aggregating, and writing metrics.

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).

Telegraf is plugin-driven and has the concept of 4 distinct plugins:

  1. Input Plugins collect metrics from the system, services, or 3rd party APIs
  2. Processor Plugins transform, decorate, and/or filter metrics
  3. Aggregator Plugins create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
  4. Output Plugins write metrics to various destinations

For more information on Processor and Aggregator plugins please read this.

New plugins are designed to be easy to contribute, we'll eagerly accept pull requests and will manage the set of plugins that Telegraf supports. See the contributing guide for instructions on writing new plugins.

Installation:

You can either download the binaries directly from the downloads page.

A few alternate installs are available here as well:

FreeBSD tarball:

Latest:

Ansible Role:

Ansible role: https://github.com/rossmcdonald/telegraf

From Source:

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

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

How to use it:

See usage with:

telegraf --help

Generate a telegraf config file:

telegraf config > telegraf.conf

Generate config with only cpu input & influxdb output plugins defined

telegraf --input-filter cpu --output-filter influxdb config

Run a single telegraf collection, outputing metrics to stdout

telegraf --config telegraf.conf -test

Run telegraf with all plugins defined in config file

telegraf --config telegraf.conf

Run telegraf, enabling the cpu & memory input, and influxdb output plugins

telegraf --config telegraf.conf -input-filter cpu:mem -output-filter influxdb

Configuration

See the configuration guide for a rundown of the more advanced configuration options.

Input Plugins

Telegraf can also collect metrics via the following service plugins:

Processor Plugins

Aggregator Plugins

Output Plugins

Contributing

Please see the contributing guide for details on contributing a plugin to Telegraf.