The Wayback Machine - https://web.archive.org/web/20190625081032/https://github.com/influxdata/telegraf
Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more

/telegraf

The plugin-driven server agent for collecting & reporting metrics.
telegraf monitoring time-series
  1. Go 98.9%
  2. Other 1.1%
Branch: master
Find File
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@danielnelson
danielnelson Update changelog
Latest commit e1cfc9f Jun 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Drop support for Go 1.9 (#6026) Jun 20, 2019
.github Update issue templates to include code block and comments (#5721) Apr 12, 2019
agent Add call to optional Init function for all plugins (#5899) Jun 14, 2019
cmd/telegraf Run ServiceInputs during test mode; add --test-wait option (#5911) Jun 14, 2019
docs Add call to optional Init function for all plugins (#5899) Jun 14, 2019
etc Add TLS mutual auth supoort to jti_openconfig_telemetry plugin (#6027) Jun 21, 2019
filter Add test for include/exclude filter (#5193) Dec 26, 2018
internal Follow up work on docker_log input (#6008) Jun 20, 2019
logger Add in process log rotation (#5778) May 3, 2019
metric Add pivot and unpivot processors (#5991) Jun 14, 2019
plugins Ignore error when utmp is missing (#5742) Jun 25, 2019
scripts Update next version for builds Jun 5, 2019
selfstat Implement telegraf collecting stats on itself Dec 5, 2016
testutil Follow up work on docker_log input (#6008) Jun 20, 2019
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore Update vendoring to dep from gdm (#4314) Jun 19, 2018
CHANGELOG.md Update changelog Jun 25, 2019
CONTRIBUTING.md Fix command for running integration test containers (#5660) Apr 2, 2019
Gopkg.lock Follow up work on docker_log input (#6008) Jun 20, 2019
Gopkg.toml Add Cisco model-driven telemetry & GNMI inputs (#5852) Jun 4, 2019
LICENSE Update copyright date May 30, 2019
Makefile Fix duplicate makefile target May 30, 2019
README.md Drop support for Go 1.9 (#6026) Jun 20, 2019
accumulator.go Fix aggregator window and shutdown of multiple aggregators (#5644) Mar 29, 2019
aggregator.go Refactor handling of MinMax functionality into RunningAggregator Oct 12, 2016
appveyor.yml Test and build official packages with Go 1.12 (#5923) May 30, 2019
docker-compose.yml Fix CrateDB port in docker compose file (#5667) Apr 2, 2019
input.go Add call to optional Init function for all plugins (#5899) Jun 14, 2019
metric.go Remove outputs blocking inputs when output is slow (#4938) Nov 5, 2018
output.go Remove outputs blocking inputs when output is slow (#4938) Nov 5, 2018
processor.go Remove outputs blocking inputs when output is slow (#4938) Nov 5, 2018

README.md

Telegraf Circle CI Docker pulls

Telegraf is an agent 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.

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

  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

New plugins are designed to be easy to contribute, pull requests are welcomed and we work to incorporate as many pull requests as possible.

Try in Browser 🚀

You can try Telegraf right in your browser in the Telegraf playground.

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.10 or newer, the Makefile requires GNU make.

  1. Install Go >=1.10 (1.12 recommended)
  2. Install dep ==v0.5.0
  3. Download Telegraf source: 
    go get -d github.com/influxdata/telegraf
  4. Run make from the source directory 
    cd "$HOME/go/src/github.com/influxdata/telegraf"
make

Changelog

View the changelog for the latest updates and changes by version.

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

Documentation

Latest Release Documentation.

For documentation on the latest development code see the documentation index.

Input Plugins

Parsers

Serializers

Processor Plugins

Aggregator Plugins

Output Plugins

You can’t perform that action at this time.