Go to file
Greg Linton 96f3d7def4 Update telegraf.conf 2018-09-12 16:08:19 -06:00
.circleci Require dep to be installed before building (#4461) 2018-07-24 15:57:24 -06:00
.github Remove combined issue template 2018-05-07 11:43:23 -07:00
agent Fix potential deadlock by not calling AddMetric concurrently (#4404) 2018-07-11 17:33:27 -07:00
cmd/telegraf Document all supported cli arguments (#4655) 2018-09-10 11:53:04 -07:00
docs Add link to line protocol in data fromat docs 2018-09-11 13:52:13 -07:00
etc Update telegraf.conf 2018-09-12 16:08:19 -06:00
filter Fix container name filters in docker input (#3331) 2017-10-12 15:50:09 -07:00
internal Use separate mutexes for write and aggregation in running_output 2018-09-12 00:23:50 -07:00
logger Add collectd parser (#2654) 2017-04-12 10:41:26 -07:00
metric Add parser processor (#4551) 2018-08-22 16:28:50 -07:00
plugins Add influx v2 output plugin (#4645) 2018-09-12 14:48:59 -07:00
scripts Update telegraf.conf 2018-09-12 16:08:19 -06:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil Add Azure Monitor output plugin (#4089) 2018-09-05 14:50:32 -07:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore Update vendoring to dep from gdm (#4314) 2018-06-19 11:55:38 -07:00
CHANGELOG.md Update changelog 2018-09-12 14:50:53 -07:00
CONTRIBUTING.md Link to SampleConfig documentation in contributing guide. 2018-07-26 15:52:17 -07:00
Gopkg.lock Use sarama version 1.18.0 to support Kafka 2.0 (#4676) 2018-09-12 11:39:21 -07:00
Gopkg.toml Use sarama version 1.18.0 to support Kafka 2.0 (#4676) 2018-09-12 11:39:21 -07:00
LICENSE Initial commit 2015-04-01 09:28:44 -07:00
Makefile Require dep to be installed before building (#4461) 2018-07-24 15:57:24 -06:00
README.md Update changelog 2018-09-12 14:50:53 -07: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 Use dep v0.5.0 (#4542) 2018-08-14 15:55:38 -06:00
docker-compose.yml Add pgbouncer input plugin (#3918) 2018-08-01 16:44:10 -06:00
input.go Flush based on buffer size rather than time 2016-02-16 22:25:22 -07:00
metric.go Fix dropwizard parsing error for metrics that need escaped (#4142) 2018-05-14 11:00:03 -07:00
output.go Use separate mutexes for write and aggregation in running_output 2018-09-12 00:23:50 -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 . For an example configuration referencet 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.9 or newer, the Makefile requires GNU make.

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

Configuration

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

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