Go to file
Daniel Nelson c7e2945a46
Fix exchange_durability sample config in amqp output
2018-09-04 13:21:58 -07: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 Set version to unknown if not set (#4521) 2018-08-12 16:52:35 -07:00
docs Add csv parser (#4439) 2018-08-24 16:40:41 -07:00
etc Update changelog 2018-08-14 14:41:24 -06:00
filter
internal Add csv parser (#4439) 2018-08-24 16:40:41 -07:00
logger
metric Add parser processor (#4551) 2018-08-22 16:28:50 -07:00
plugins Fix exchange_durability sample config in amqp output 2018-09-04 13:21:58 -07:00
scripts Use the correct GOARM value in the armel package (#4608) 2018-08-29 12:28:00 -07:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil Provide function to test metric equality (#4464) 2018-07-24 19:29:00 -07:00
.gitattributes
.gitignore Update vendoring to dep from gdm (#4314) 2018-06-19 11:55:38 -07:00
CHANGELOG.md Update changelog 2018-09-01 19:01:02 -07:00
CONTRIBUTING.md Link to SampleConfig documentation in contributing guide. 2018-07-26 15:52:17 -07:00
Gopkg.lock Use dep v0.5.0 (#4542) 2018-08-14 15:55:38 -06:00
Gopkg.toml Add gopsutil meminfo fields to mem plugin (#4546) 2018-08-13 17:41:23 -06:00
LICENSE
Makefile Require dep to be installed before building (#4461) 2018-07-24 15:57:24 -06:00
README.md Add Icinga2 input plugin (#4559) 2018-08-22 19:10:40 -07:00
accumulator.go
aggregator.go
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
metric.go Fix dropwizard parsing error for metrics that need escaped (#4142) 2018-05-14 11:00:03 -07:00
output.go
processor.go

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