The plugin-driven server agent for collecting & reporting metrics.
Go Python Other
Permalink
Failed to load latest commit information.
.github update PR template with changelog note Aug 17, 2016
agent Implement telegraf collecting stats on itself Dec 5, 2016
cmd/telegraf Update config generation docs Oct 25, 2016
docs Switch to github.com/kballard/go-shellquote (#1950) Nov 16, 2016
etc update etc/telegraf.conf Jan 12, 2017
filter Refactor and code cleanup of filtering Sep 5, 2016
internal readme fixup & test output fixup Jan 9, 2017
logger Use rfc3339 timestamps in telegraf log output Nov 3, 2016
metric Support a telegraf.Metric.Split function Dec 7, 2016
plugins Direct people to downloads page for installation Jan 13, 2017
scripts Fix RPM architecture for armhf (#2003) Dec 5, 2016
selfstat Implement telegraf collecting stats on itself Dec 5, 2016
testutil Implement telegraf collecting stats on itself Dec 5, 2016
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore add build directory to git ignore (#1415) Jun 25, 2016
CHANGELOG.md mysql build fixup and changelog update Jan 13, 2017
CONTRIBUTING.md Processor & Aggregator Contrib doc Oct 12, 2016
Godeps Fixes change in Kafka consumer input plugin (#2222) Jan 11, 2017
Godeps_windows Importing pdh from github.com/lxn/win Dec 20, 2016
LICENSE Initial commit Apr 1, 2015
Makefile Use short commit in Makefile build Nov 3, 2016
README.md Direct people to downloads page for installation Jan 13, 2017
accumulator.go Support Processor & Aggregator Plugins Oct 12, 2016
aggregator.go Refactor handling of MinMax functionality into RunningAggregator Oct 12, 2016
circle.yml Go version 1.7.3 -> 1.7.4 Dec 6, 2016
input.go Flush based on buffer size rather than time Feb 17, 2016
metric.go Support a telegraf.Metric.Split function Dec 7, 2016
output.go Throughout telegraf, use telegraf.Metric rather than client.Point Jan 28, 2016
processor.go Support Processor & Aggregator Plugins Oct 12, 2016

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.