Go to file
Steven Soroka 64fecfa19e
fix inputs.postgresql panic in posgres 12 (#7151)
2020-03-10 17:06:29 -04:00
.circleci Check license of dependencies file for changes (#7108) 2020-03-09 14:47:28 -07:00
.github Update GitHub bug issue template (#6554) 2019-10-21 14:46:19 -07:00
agent Fix inconsistency with input error counting (#7077) 2020-02-25 10:40:29 -08:00
cmd/telegraf Sort alphabetically the output of the plugin listing commands (#6810) 2019-12-17 12:44:17 -08:00
docs fix deps 2020-03-10 10:21:23 -04:00
etc Document port specification in postgres input plugins (#7132) 2020-03-10 12:02:50 -07:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal Fix log rotation to use actual file size instead of bytes written (#7133) 2020-03-10 12:07:42 -07:00
logger Skip logging when logfile is unset (#6648) 2019-11-11 17:03:03 -08:00
metric Refactor InfluxDB listener (#6974) 2020-03-04 11:13:44 -07:00
plugins fix inputs.postgresql panic in posgres 12 (#7151) 2020-03-10 17:06:29 -04:00
scripts Check license of dependencies file for changes (#7108) 2020-03-09 14:47:28 -07:00
selfstat Exclude alias tag if unset from plugin internal stats (#6571) 2019-10-23 12:40:31 -07:00
testutil Fix atomic usage in tests (#6964) 2020-01-31 14:14:44 -08:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore Update readme and changelog 2020-03-04 14:42:50 -08:00
CHANGELOG.md Update changelog 2020-03-10 13:44:09 -07:00
CONTRIBUTING.md Add security vulnerability reporting into to contributing doc (#6268) 2019-08-16 10:32:29 -07:00
LICENSE Update copyright date 2019-05-30 15:21:53 -07:00
Makefile Check license of dependencies file for changes (#7108) 2020-03-09 14:47:28 -07:00
README.md plugins/inputs: New input for Wireguard server (#6367) 2020-03-09 18:34:43 -04:00
accumulator.go Fix aggregator window and shutdown of multiple aggregators (#5644) 2019-03-29 15:40:33 -07:00
aggregator.go Refactor handling of MinMax functionality into RunningAggregator 2016-10-12 14:50:19 +01:00
appveyor.yml Use Go 1.13.8 to build official packages (#7079) 2020-02-25 12:05:44 -08:00
docker-compose.yml Fix issues with failing tests on darwin (#7042) 2020-02-18 16:13:53 -08:00
go.mod plugins/inputs: New input for Wireguard server (#6367) 2020-03-09 18:34:43 -04:00
go.sum plugins/inputs: New input for Wireguard server (#6367) 2020-03-09 18:34:43 -04:00
input.go Add ability to label inputs for logging (#6207) 2019-08-21 16:49:07 -07:00
metric.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00
output.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00
plugin.go Add ability to label inputs for logging (#6207) 2019-08-21 16:49:07 -07:00
processor.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00

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