The plugin-driven server agent for collecting & reporting metrics.
Go Python Other
Latest commit 11c6a7f Jan 4, 2018 @danielnelson danielnelson Update changelog
Permalink
Failed to load latest commit information.
.github Remove changelog item from pull request template May 22, 2017
agent Fix typos in comments (#3415) Nov 1, 2017
cmd/telegraf Update next version number for dev builds Dec 1, 2017
docs Typo and sentence consistency (#3581) Dec 13, 2017
etc Fix name error in jolokia2_agent sample config (#3624) Dec 29, 2017
filter Fix container name filters in docker input (#3331) Oct 12, 2017
internal Fix typos in comments (#3415) Nov 1, 2017
logger Add collectd parser (#2654) Apr 12, 2017
metric Fix typo in error message Nov 13, 2017
plugins Add support for additional metrics on Linux in zfs input (#3565) Jan 4, 2018
scripts Use deb-systemd-invoke to restart service (#3506) Nov 28, 2017
selfstat Implement telegraf collecting stats on itself Dec 5, 2016
testutil Add history and summary types to telegraf and prometheus plugins (#3337) Oct 24, 2017
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore Revert "Undo Revert "Revert changes since 9b0af44"" Nov 4, 2017
CHANGELOG.md Update changelog Jan 4, 2018
CONTRIBUTING.md Update contributing documentation Nov 7, 2017
Godeps Update sarama-cluster to latest release (#3560) Dec 9, 2017
LICENSE Initial commit Apr 1, 2015
Makefile Add CrateDB output plugin (#3210) Nov 9, 2017
README.md Update changelog Nov 30, 2017
accumulator.go Add history and summary types to telegraf and prometheus plugins (#3337) Oct 24, 2017
aggregator.go Refactor handling of MinMax functionality into RunningAggregator Oct 12, 2016
appveyor.yml Compile with Go 1.9.2 (#3458) Nov 10, 2017
circle.yml Compile with Go 1.9.2 (#3458) Nov 10, 2017
input.go Flush based on buffer size rather than time Feb 17, 2016
metric.go Add history and summary types to telegraf and prometheus plugins (#3337) Oct 24, 2017
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 local or remote services.

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.

Contributing

There are many ways to contribute:

Installation:

You can download the binaries directly from the downloads page or from the releases section.

Ansible Role:

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

From Source:

Telegraf requires golang version 1.8+, the Makefile requires GNU make.

Dependencies are managed with gdm, which is installed by the Makefile if you don't have it already.

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

Nightly Builds

These builds are generated from the master branch:

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:

Telegraf is able to parse the following input data formats into metrics, these formats may be used with input plugins supporting the data_format option:

Processor Plugins

Aggregator Plugins

Output Plugins