The plugin-driven server agent for collecting & reporting metrics.
Clone or download
Pull request Compare This branch is 124 commits ahead, 525 commits behind influxdata:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
agent
cmd/telegraf
docs
etc
filter
internal
logger
metric
plugins
scripts
selfstat
testutil
.gitattributes
.gitignore
CHANGELOG.md
CONTRIBUTING.md
Godeps
LICENSE
Makefile
README.md
accumulator.go
aggregator.go
appveyor.yml
docker-compose.yml
input.go
make_windows.ps1
metric.go
output.go
processor.go

README.md

Telegraf

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 gdm, 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

Configuration and Installation

Please refer to the SignalFx documentation for more information on the installation and configuration of Telegraf.

Advanced Configuration Options

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

Input Plugins

Telegraf can also collect metrics via the following service 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