Skip to content
The plugin-driven server agent for collecting & reporting metrics.
Go Other
  1. Go 98.9%
  2. Other 1.1%
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Check license of dependencies file for changes (#7108) Mar 9, 2020
.github Update GitHub bug issue template (#6554) Oct 21, 2019
agent Fix inconsistency with input error counting (#7077) Feb 25, 2020
cmd/telegraf Sort alphabetically the output of the plugin listing commands (#6810) Dec 17, 2019
docs Update changelog, readme, licenses Mar 10, 2020
etc Document port specification in postgres input plugins (#7132) Mar 10, 2020
filter Add test for include/exclude filter (#5193) Dec 26, 2018
internal Fix internal metrics for output split into multiple lines (#7119) Mar 10, 2020
logger Skip logging when logfile is unset (#6648) Nov 12, 2019
metric Refactor InfluxDB listener (#6974) Mar 4, 2020
plugins Move s2_geo processor to directory with same name Mar 10, 2020
scripts Check license of dependencies file for changes (#7108) Mar 9, 2020
selfstat Exclude alias tag if unset from plugin internal stats (#6571) Oct 23, 2019
testutil Fix atomic usage in tests (#6964) Jan 31, 2020
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore Update readme and changelog Mar 4, 2020
CHANGELOG.md Update changelog, readme, licenses Mar 10, 2020
CONTRIBUTING.md Add security vulnerability reporting into to contributing doc (#6268) Aug 16, 2019
LICENSE Update copyright date May 30, 2019
Makefile Check license of dependencies file for changes (#7108) Mar 9, 2020
README.md Update changelog, readme, licenses Mar 10, 2020
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 Use Go 1.13.8 to build official packages (#7079) Feb 25, 2020
docker-compose.yml Fix issues with failing tests on darwin (#7042) Feb 19, 2020
go.mod Add s2_geo processor plugin (#7087) Mar 10, 2020
go.sum Add s2_geo processor plugin (#7087) Mar 10, 2020
input.go Add ability to label inputs for logging (#6207) Aug 21, 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
plugin.go Add ability to label inputs for logging (#6207) Aug 21, 2019
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:

Minimum Requirements

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

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

  1. Install Go >=1.12 (1.13 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
    

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 --section-filter agent:inputs:outputs --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.