Go to file
dom 49701ffb05 add rss feed title 2020-06-06 21:24:46 +02:00
.circleci Update to Go 1.14.3 with testing using 1.13.11 (#7564) 2020-05-26 15:40:25 -07:00
.github Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
agent add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
cmd/telegraf Add support for once mode; run processors and aggregators during test (#7474) 2020-06-01 15:26:20 -07:00
config add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
docs Update AGGREGATORS_AND_PROCESSORS.md (#7599) 2020-05-29 15:32:46 -07:00
etc Add configurable separator graphite serializer and output (#7545) 2020-05-20 17:15:18 -07:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal Add support for once mode; run processors and aggregators during test (#7474) 2020-06-01 15:26:20 -07:00
logger Skip logging when logfile is unset (#6648) 2019-11-11 17:03:03 -08:00
metric Fix assorted spelling mistakes (#7507) 2020-05-15 15:43:32 -07:00
models add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
plugins add rss feed title 2020-06-06 21:24:46 +02:00
scripts Add support for Solus distribution to maintainer scripts (#7585) 2020-06-02 23:20:45 -07:00
selfstat Fix assorted spelling mistakes (#7507) 2020-05-15 15:43:32 -07:00
testutil Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
.gitattributes Use merge=union driver for go.sum 2020-03-16 10:02:49 -07:00
.gitignore Update readme and changelog 2020-03-04 14:42:50 -08:00
CHANGELOG.md Update CHANGELOG.md 2020-06-05 18:46:58 -04:00
CONTRIBUTING.md Update docs for execd plugins (#7465) 2020-05-14 11:19:19 -04:00
Dockerfile add ablility to build new version with docker 2020-06-06 21:16:55 +02:00
EXTERNAL_PLUGINS.md Add github.com/inabagumi/twitter-telegraf-plugin to list of external plugins 2020-05-28 15:45:08 -07:00
LICENSE Update copyright date 2019-05-30 15:21:53 -07:00
Makefile Add processor to look up service name by port (#7540) 2020-05-27 15:42:59 -06:00
README.md Add newrelic output plugin (#7019) 2020-05-27 11:24:49 -07:00
accumulator.go Fix aggregator window and shutdown of multiple aggregators (#5644) 2019-03-29 15:40:33 -07:00
aggregator.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
appveyor.yml Update to Go 1.14.3 with testing using 1.13.11 (#7564) 2020-05-26 15:40:25 -07:00
docker-compose.yml Fix issues with failing tests on darwin (#7042) 2020-02-18 16:13:53 -08:00
go.mod add ablility to build new version with docker 2020-06-06 21:16:55 +02:00
go.sum add ablility to build new version with docker 2020-06-06 21:16:55 +02:00
input.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
metric.go Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
output.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
plugin.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
processor.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04: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.13 or newer, the Makefile requires GNU make.

  1. Install Go >=1.13 (1.14 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, outputting 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