Go to file
Patrick Hemmer f2fb9cc1e8
Fix postfix input handling of multi-level queues (#4333)
(cherry picked from commit 16454e25ba)
2018-06-21 16:03:19 -07:00
.circleci Drop CI support for Go 1.8 (#4309) 2018-06-17 18:50:37 -07:00
.github Remove combined issue template 2018-05-07 11:43:23 -07:00
agent Don't print name of plugin or interval size during --test 2018-04-04 16:30:22 -07:00
cmd/telegraf Treat sigterm as a clean shutdown signal (#4277) 2018-06-12 16:44:34 -07:00
docs Add go-syslog to dependencies licenses list 2018-06-05 11:40:03 -07:00
etc Update sample config 2018-06-05 11:45:07 -07:00
filter
internal Fix TLS and SSL config option parsing (#4247) 2018-06-06 18:30:29 -07:00
logger
metric Fix dropwizard parsing error for metrics that need escaped (#4142) 2018-05-14 11:00:03 -07:00
plugins Fix postfix input handling of multi-level queues (#4333) 2018-06-21 16:03:19 -07:00
scripts Run apt-get update in release.sh 2018-05-07 15:12:01 -07:00
selfstat
testutil Add aurora input plugin (#4158) 2018-05-21 11:59:39 -07:00
.gitattributes
.gitignore Use automatic extension naming when running go build 2018-04-04 19:00:28 -07:00
CHANGELOG.md Fix postfix input handling of multi-level queues (#4333) 2018-06-21 16:03:19 -07:00
CONTRIBUTING.md
Godeps Use nats-io/go-nats instead of nats-io/nats 2018-06-11 16:26:32 -07:00
LICENSE
Makefile Use -parallel=false in gdm to avoid issues on appveyor 2018-05-17 15:19:17 -07:00
README.md Drop CI support for Go 1.8 (#4309) 2018-06-17 18:50:37 -07:00
accumulator.go
aggregator.go
appveyor.yml Return to using latest image file on appveyor 2018-05-17 14:38:21 -07:00
docker-compose.yml Add uint/bool support to cratedb output (#4117) 2018-05-08 12:10:25 -07: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.

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

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