Go to file
Greg 817c9a69a9 Document and add support to input plugins for logging alias (#6357) 2019-09-23 15:39:50 -07:00
.circleci Update to Go 1.12.9 and 1.11.13 (#6303) 2019-08-22 10:51:15 -07:00
.github Fixing spelling in bug template (#6374) 2019-09-10 10:55:39 -07:00
agent Query oplog only when connected to a replica set (#6307) 2019-08-27 10:31:42 -07:00
cmd/telegraf Require goplugin build flag to enable go plugin support (#6393) 2019-09-20 16:50:19 -07:00
docs Document and add support to input plugins for logging alias (#6357) 2019-09-23 15:39:50 -07:00
etc Update sample configuration 2019-08-27 12:41:16 -07:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal Document and add support to input plugins for logging alias (#6357) 2019-09-23 15:39:50 -07:00
logger Improve startup error reporting when ran as Windows service (#4291) 2019-08-28 14:34:44 -07:00
metric Add pivot and unpivot processors (#5991) 2019-06-14 15:26:56 -07:00
plugins Document and add support to input plugins for logging alias (#6357) 2019-09-23 15:39:50 -07:00
scripts Set next version for builds 2019-08-27 14:05:48 -07:00
selfstat Implement telegraf collecting stats on itself 2016-12-05 18:56:54 +00:00
testutil Allow graphite parser to create Inf and NaN values (#6420) 2019-09-19 20:03:10 -07:00
.gitattributes update gitattributes for easier fork mngmnt 2016-06-01 16:18:17 +01:00
.gitignore Make review changes to logstash input (#6299) 2019-08-21 18:04:30 -07:00
CHANGELOG.md Update changelog 2019-09-23 10:28:21 -07:00
CONTRIBUTING.md Add security vulnerability reporting into to contributing doc (#6268) 2019-08-16 10:32:29 -07:00
Gopkg.lock Support NX-OS telemetry extensions in cisco_telemetry_mdt (#6177) 2019-09-16 16:57:25 -07:00
Gopkg.toml Remove transitive dependency azure-pipeline-go from Gopkg.toml 2019-09-16 16:46:34 -07:00
LICENSE Update copyright date 2019-05-30 15:21:53 -07:00
Makefile Update to Go 1.12.9 and 1.11.13 (#6303) 2019-08-22 10:51:15 -07:00
README.md Update changelog and link to readme to suricata 2019-09-20 15:38:39 -07:00
accumulator.go Fix aggregator window and shutdown of multiple aggregators (#5644) 2019-03-29 15:40:33 -07:00
aggregator.go Refactor handling of MinMax functionality into RunningAggregator 2016-10-12 14:50:19 +01:00
appveyor.yml Update to Go 1.12.9 and 1.11.13 (#6303) 2019-08-22 10:51:15 -07:00
docker-compose.yml Add support for ES 7.x to elasticsearch output (#6053) 2019-07-01 16:22:17 -07:00
input.go Add ability to label inputs for logging (#6207) 2019-08-21 16:49:07 -07:00
metric.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00
output.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00
plugin.go Add ability to label inputs for logging (#6207) 2019-08-21 16:49:07 -07:00
processor.go Remove outputs blocking inputs when output is slow (#4938) 2018-11-05 13:34:28 -08:00

README.md

Telegraf Circle CI Docker pulls

Telegraf is an agent 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.

Telegraf is plugin-driven and has the concept of 4 distinct plugin types:

  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

New plugins are designed to be easy to contribute, pull requests are welcomed and we work to incorporate as many pull requests as possible.

Try in Browser 🚀

You can try Telegraf right in your browser in the Telegraf playground.

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.10 or newer, the Makefile requires GNU make.

  1. Install Go >=1.10 (1.12 recommended)
  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
    

Changelog

View the changelog for the latest updates and changes by version.

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

Documentation

Latest Release Documentation.

For documentation on the latest development code see the documentation index.

Input Plugins

Parsers

Serializers

Processor Plugins

Aggregator Plugins

Output Plugins