Go to file
Daniel Nelson c325c94a96
Rewrite documentation for snmp input (#6802)
2019-12-30 11:33:32 -08:00
.circleci Build packages with Go 1.13.5 (#6767) 2019-12-06 17:10:59 -08:00
.github Update GitHub bug issue template (#6554) 2019-10-21 14:46:19 -07:00
agent Log no metrics found at debug level in cloudwatch input (#6665) 2019-11-15 18:52:55 -08:00
cmd/telegraf Sort alphabetically the output of the plugin listing commands (#6810) 2019-12-17 12:44:17 -08:00
docs Document --service-display-name flag for Windows service 2019-12-10 13:13:03 -08:00
etc Expose unbound-control config file option (#6770) 2019-12-17 16:50:00 -08:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal Fix missing config fields in prometheus serializer (#6823) 2019-12-26 10:15:25 -08:00
logger Skip logging when logfile is unset (#6648) 2019-11-11 17:03:03 -08:00
metric Add pivot and unpivot processors (#5991) 2019-06-14 15:26:56 -07:00
plugins Rewrite documentation for snmp input (#6802) 2019-12-30 11:33:32 -08:00
scripts Build packages with Go 1.13.5 (#6767) 2019-12-06 17:10:59 -08:00
selfstat Exclude alias tag if unset from plugin internal stats (#6571) 2019-10-23 12:40:31 -07:00
testutil perf(inputs/influxdb_listener): benchmark serving writes (#6673) 2019-12-02 11:49:04 -07:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore Make review changes to logstash input (#6299) 2019-08-21 18:04:30 -07:00
CHANGELOG.md Update changelog 2019-12-27 15:51:09 -08:00
CONTRIBUTING.md Add security vulnerability reporting into to contributing doc (#6268) 2019-08-16 10:32:29 -07:00
Gopkg.lock Override github.com/satori/go.uuid revision for transitive deps (#6768) 2019-12-06 17:22:11 -08:00
Gopkg.toml Override github.com/satori/go.uuid revision for transitive deps (#6768) 2019-12-06 17:22:11 -08:00
LICENSE Update copyright date 2019-05-30 15:21:53 -07:00
Makefile Build packages with Go 1.13.5 (#6767) 2019-12-06 17:10:59 -08:00
README.md Add minimum system requirements to readme 2019-12-04 17:16:00 -08: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 Build packages with Go 1.13.5 (#6767) 2019-12-06 17:10:59 -08:00
docker-compose.yml Add support for ES 7.x to elasticsearch output (#6053) 2019-07-01 16:22:17 -07: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 golang version 1.12 or newer, the Makefile requires GNU make.

  1. Install Go >=1.12 (1.13 recommended)
  2. Install dep ==v0.5.0
  3. Download Telegraf source:
    go get -d github.com/influxdata/telegraf
    
  4. Run make from the source directory
    cd "$HOME/go/src/github.com/influxdata/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 --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