Go to file
Jeff Ashton e1bc191f9f Add control over which stats to gather in basicstats aggregator (#3580) 2017-12-14 16:56:10 -08:00
.github Remove changelog item from pull request template 2017-05-22 12:06:48 -07:00
agent Fix typos in comments (#3415) 2017-10-31 17:00:06 -07:00
cmd/telegraf Update next version number for dev builds 2017-12-01 11:52:46 -08:00
docs Typo and sentence consistency (#3581) 2017-12-13 10:51:15 -08:00
etc Update example config 2017-12-01 11:49:07 -08:00
filter Fix container name filters in docker input (#3331) 2017-10-12 15:50:09 -07:00
internal Fix typos in comments (#3415) 2017-10-31 17:00:06 -07:00
logger Add collectd parser (#2654) 2017-04-12 10:41:26 -07:00
metric Fix typo in error message 2017-11-13 15:07:54 -08:00
plugins Add control over which stats to gather in basicstats aggregator (#3580) 2017-12-14 16:56:10 -08:00
scripts Use deb-systemd-invoke to restart service (#3506) 2017-11-27 17:05:32 -08:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil Add history and summary types to telegraf and prometheus plugins (#3337) 2017-10-24 16:28:52 -07:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore Revert "Undo Revert "Revert changes since 9b0af4478"" 2017-11-04 09:19:37 -04:00
CHANGELOG.md Set release date for 1.5.0 2017-12-14 10:58:33 -08:00
CONTRIBUTING.md Update contributing documentation 2017-11-07 13:59:06 -08:00
Godeps Update sarama-cluster to latest release (#3560) 2017-12-08 17:59:06 -08:00
LICENSE Initial commit 2015-04-01 09:28:44 -07:00
Makefile Add CrateDB output plugin (#3210) 2017-11-09 14:03:16 -08:00
README.md Update changelog 2017-11-29 16:36:00 -08:00
accumulator.go Add history and summary types to telegraf and prometheus plugins (#3337) 2017-10-24 16:28:52 -07:00
aggregator.go Refactor handling of MinMax functionality into RunningAggregator 2016-10-12 14:50:19 +01:00
appveyor.yml Compile with Go 1.9.2 (#3458) 2017-11-10 14:39:00 -08:00
circle.yml Compile with Go 1.9.2 (#3458) 2017-11-10 14:39:00 -08:00
input.go Flush based on buffer size rather than time 2016-02-16 22:25:22 -07:00
metric.go Add history and summary types to telegraf and prometheus plugins (#3337) 2017-10-24 16:28:52 -07:00
output.go Throughout telegraf, use telegraf.Metric rather than client.Point 2016-01-27 23:47:32 -07:00
processor.go Support Processor & Aggregator Plugins 2016-10-12 14:50:19 +01:00

README.md

Telegraf Circle CI Docker pulls

Telegraf is an agent written in Go 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 from local or remote services.

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

  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

For more information on Processor and Aggregator plugins please read this.

New plugins are designed to be easy to contribute, we'll eagerly accept pull requests and will manage the set of plugins that Telegraf supports.

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.8+, the Makefile requires GNU make.

Dependencies are managed with gdm, which is installed by the Makefile if you don't have it already.

  1. Install Go
  2. Setup your GOPATH
  3. Run go get -d github.com/influxdata/telegraf
  4. Run cd $GOPATH/src/github.com/influxdata/telegraf
  5. Run make

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

Configuration

See the configuration guide for a rundown of the more advanced configuration options.

Input Plugins

Telegraf can also collect metrics via the following service plugins:

Telegraf is able to parse the following input data formats into metrics, these formats may be used with input plugins supporting the data_format option:

Processor Plugins

Aggregator Plugins

Output Plugins