The plugin-driven server agent for collecting & reporting metrics.
Go Other
Clone or download
Permalink
Failed to load latest commit information.
.circleci Improve CircleCI dependency caching Jul 2, 2018
.github Remove combined issue template May 7, 2018
agent Fix potential deadlock by not calling AddMetric concurrently (#4404) Jul 12, 2018
cmd/telegraf Treat sigterm as a clean shutdown signal (#4277) Jun 12, 2018
docs Add file input plugin and grok parser (#4332) Jul 14, 2018
etc Add http path configuration for OpenTSDB output (#4347) Jul 2, 2018
filter Fix container name filters in docker input (#3331) Oct 12, 2017
internal Add file input plugin and grok parser (#4332) Jul 14, 2018
logger Add collectd parser (#2654) Apr 12, 2017
metric Fix metric can have duplicate field (#4422) Jul 14, 2018
plugins Exclude cached memory on docker input plugin (#4383) Jul 17, 2018
scripts Update vendoring to dep from gdm (#4314) Jun 19, 2018
selfstat Implement telegraf collecting stats on itself Dec 5, 2016
testutil Add aurora input plugin (#4158) May 21, 2018
.gitattributes update gitattributes for easier fork mngmnt Jun 1, 2016
.gitignore Update vendoring to dep from gdm (#4314) Jun 19, 2018
CHANGELOG.md Set 1.7.2 release date Jul 18, 2018
CONTRIBUTING.md Fix several build issues (#4412) Jul 12, 2018
Gopkg.lock Update vendoring to dep from gdm (#4314) Jun 19, 2018
Gopkg.toml Update vendoring to dep from gdm (#4314) Jun 19, 2018
LICENSE Initial commit Apr 1, 2015
Makefile Fix several build issues (#4412) Jul 12, 2018
README.md Add file input plugin and grok parser (#4332) Jul 14, 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 Update vendoring to dep from gdm (#4314) Jun 19, 2018
docker-compose.yml Add uint/bool support to cratedb output (#4117) May 8, 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 Throughout telegraf, use telegraf.Metric rather than client.Point Jan 28, 2016
processor.go Support Processor & Aggregator Plugins Oct 12, 2016

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.

Dependencies are managed with dep, 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 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