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

Design goal:

• 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. If none of the internal plugins fit your needs, you could have a look at the list of external plugins.

Telegraf shares the same minimum requirements as Go:

• Linux kernel version 2.6.23 or later
• Windows 7 or later
• FreeBSD 11.2 or later
• MacOS 10.11 El Capitan or later

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

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

Telegraf requires Go version 1.14 or newer, the Makefile requires GNU make.

1. Install Go >=1.14 (1.15 recommended)
2. Clone the Telegraf repository:

   cd ~/src
   git clone https://github.com/influxdata/telegraf.git
   

3. Run make from the source directory

   cd ~/src/telegraf
   make
   

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

Nightly builds are available, generated from the master branch.

Builds for other platforms or package formats are provided by members of the Telegraf community. These packages are not built, tested or supported by the Telegraf project or InfluxData, we make no guarantees that they will work. Please get in touch with the package author if you need support.

• Windows
  • Chocolatey by ripclawffb
  • Scoop
• Linux
  • Snap by Laurent Sesquès (sajoupa)

See usage with:

telegraf --help

telegraf config > telegraf.conf

telegraf --section-filter agent:inputs:outputs --input-filter cpu --output-filter influxdb config

telegraf --config telegraf.conf --test

telegraf --config telegraf.conf

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

Latest Release Documentation.

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

• Input Plugins
• Output Plugins
• Processor Plugins
• Aggregator Plugins

There are many ways to contribute:

• Fix and report bugs
• Improve documentation
• Review code and feature proposals
• Answer questions and discuss here on github and on the Community Site
• Contribute plugins
• Contribute external plugins