The plugin-driven server agent for collecting & reporting metrics.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci Require dep to be installed before building (#4461) Jul 24, 2018
.github Remove combined issue template May 7, 2018
agent Fix potential deadlock by not calling AddMetric concurrently (#4404) Jul 12, 2018
cmd/telegraf Document all supported cli arguments (#4655) Sep 10, 2018
docs Split parser/serializer docs (#4690) Sep 17, 2018
etc Update sample telegraf.conf Sep 19, 2018
filter Fix container name filters in docker input (#3331) Oct 12, 2017
internal Document that proc/agg/outputs are not run as part of --test Sep 20, 2018
logger Add collectd parser (#2654) Apr 12, 2017
metric Add parser processor (#4551) Aug 22, 2018
plugins Fix grammar in exec input readme (#4740) Sep 24, 2018
scripts Update telegraf.conf Sep 12, 2018
selfstat Implement telegraf collecting stats on itself Dec 5, 2016
testutil Add Azure Monitor output plugin (#4089) Sep 5, 2018
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore Update vendoring to dep from gdm (#4314) Jun 19, 2018
CHANGELOG.md Update changelog Sep 21, 2018
CONTRIBUTING.md Link to SampleConfig documentation in contributing guide. Jul 26, 2018
Gopkg.lock Fix dep check errors in Gopkg.lock Sep 24, 2018
Gopkg.toml Use sarama version 1.18.0 to support Kafka 2.0 (#4676) Sep 12, 2018
LICENSE Initial commit Apr 1, 2015
Makefile Require dep to be installed before building (#4461) Jul 24, 2018
README.md Fix changelog and add Kibana input plugin to README (#4718) Sep 20, 2018
accumulator.go Add history and summary types to telegraf and prometheus plugins (#3337) Oct 24, 2017
aggregator.go Refactor handling of MinMax functionality into RunningAggregator Oct 12, 2016
appveyor.yml Use dep v0.5.0 (#4542) Aug 14, 2018
docker-compose.yml Add pgbouncer input plugin (#3918) Aug 1, 2018
input.go Flush based on buffer size rather than time Feb 17, 2016
metric.go Fix dropwizard parsing error for metrics that need escaped (#4142) May 14, 2018
output.go Use separate mutexes for write and aggregation in running_output Sep 12, 2018
processor.go Support Processor & Aggregator Plugins Oct 12, 2016

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

  1. Install Go >=1.9 (1.10 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
    

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

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