Go to file
Daniel Nelson 4c534433aa
Skip kafka_consumer_integration_test due to issue on CircleCI
2017-06-07 18:31:52 -07:00
.github Remove changelog item from pull request template 2017-05-22 12:06:48 -07:00
agent Fix prometheus_client reload behavior 2017-02-16 21:57:13 +00:00
cmd/telegraf Feature #1820: add testing without outputs (#2446) 2017-04-13 12:59:28 -07:00
docs Add Kafka 0.9+ consumer support (#2487) 2017-06-07 18:22:28 -07:00
etc Add Kafka 0.9+ consumer support (#2487) 2017-06-07 18:22:28 -07:00
filter Refactor and code cleanup of filtering 2016-09-05 16:30:18 +01:00
internal Add Kafka 0.9+ consumer support (#2487) 2017-06-07 18:22:28 -07:00
logger Add collectd parser (#2654) 2017-04-12 10:41:26 -07:00
metric Fix metric splitting edge cases (#2896) 2017-06-07 13:37:54 -07:00
plugins Skip kafka_consumer_integration_test due to issue on CircleCI 2017-06-07 18:31:52 -07:00
scripts Generate sha256 hashes when packaging 2017-05-31 12:29:39 -07:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil Fixed inconsistency between HasIntField and IntField (#2813) 2017-05-16 15:25:30 -07:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore add build directory to git ignore (#1415) 2016-06-25 11:17:51 +01:00
CHANGELOG.md Add release note to changelog regarding kafka_consumer 2017-06-07 18:27:12 -07:00
CONTRIBUTING.md Fix grammar 2017-04-27 14:59:18 -07:00
Godeps Add Kafka 0.9+ consumer support (#2487) 2017-06-07 18:22:28 -07:00
Godeps_windows Importing pdh from github.com/lxn/win 2016-12-20 12:06:40 +00:00
LICENSE Initial commit 2015-04-01 09:28:44 -07:00
Makefile Add Kafka 0.9+ consumer support (#2487) 2017-06-07 18:22:28 -07:00
README.md Add documentation for fetching metrics on Caddy HTTP and Prometheus (#2853) 2017-05-25 13:07:49 -07:00
accumulator.go Support Processor & Aggregator Plugins 2016-10-12 14:50:19 +01:00
aggregator.go Refactor handling of MinMax functionality into RunningAggregator 2016-10-12 14:50:19 +01:00
circle.yml Use go 1.8.1 for CI and Release builds (#2732) 2017-04-27 16:18:11 -07:00
input.go Flush based on buffer size rather than time 2016-02-16 22:25:22 -07:00
metric.go Remove metric.Point from metric interface 2017-02-03 16:53:07 +00:00
output.go Throughout telegraf, use telegraf.Metric rather than client.Point 2016-01-27 23:47:32 -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 from well known services (like Hadoop, Postgres, or Redis) and third party APIs (like Mailchimp, AWS CloudWatch, or Google Analytics).

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 either download the binaries directly from the downloads page.

A few alternate installs are available here as well:

FreeBSD tarball:

Latest:

Ansible Role:

Ansible role: https://github.com/rossmcdonald/telegraf

From Source:

Telegraf manages dependencies via gdm, which gets installed via the Makefile if you don't have it already. You also must build with golang version 1.8+.

  1. Install Go
  2. Setup your GOPATH
  3. Run go get github.com/influxdata/telegraf
  4. Run cd $GOPATH/src/github.com/influxdata/telegraf
  5. Run make

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