Go to file
Caleb Hailey cc61251cc9
Sensu Go Output Plugin for Telegraf (#8398)
2021-03-03 13:56:42 -05:00
.circleci Run revive linter in CI (#8798) 2021-02-18 10:56:10 -06:00
.github Create dependabot.yml (#8614) 2021-01-19 11:17:36 -05:00
agent Revive fixes - part 2 (#8835) 2021-02-16 18:19:50 -05:00
cmd/telegraf Add Event Log support for Windows (#8616) 2021-01-19 11:03:19 -05:00
config Display error message on badly formatted config string array (eg. namepass) (#8910) 2021-02-26 13:58:13 -05:00
docs Adding a new directory monitor input plugin. (#8751) 2021-03-02 17:30:59 -05:00
etc Update changelog 2021-02-17 17:02:28 -05:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal Fix max_repetitions signedness issues #8823 (#8902) 2021-03-01 15:46:49 -05:00
logger Integration test audit (#8725) 2021-01-26 11:06:12 -07:00
metric Optimize SeriesGrouper & aggregators.merge (#8391) 2021-01-07 11:39:12 -05:00
models Revive fixes - part 2 (#8835) 2021-02-16 18:19:50 -05:00
plugins Sensu Go Output Plugin for Telegraf (#8398) 2021-03-03 13:56:42 -05:00
scripts Update to 1.15.8 (#8868) 2021-02-17 10:21:47 -06:00
selfstat Revive fixes - part 2 (#8835) 2021-02-16 18:19:50 -05:00
testutil changed TestThreadStats acc to wait for 2 and added warning comment (#8592) 2020-12-17 19:32:49 -05:00
.gitattributes Fix tests for Windows - part 1 (#8414) 2020-11-23 10:40:32 -05:00
.gitignore Upgrade circle-ci config to v2.1 (#8621) 2021-01-06 16:23:29 -06:00
.golangci.yml Revive fixes - part 3 (#8872) 2021-03-01 16:04:35 -05:00
CHANGELOG.md Update changelog 2021-02-17 17:02:28 -05:00
CONTRIBUTING.md Integration test audit (#8725) 2021-01-26 11:06:12 -07:00
EXTERNAL_PLUGINS.md add SMCIPMITool input to external plugin list (#8897) 2021-02-22 14:28:22 -05:00
LICENSE Build packages in makefile (#7759) 2020-06-30 00:15:28 -07:00
Makefile Run revive linter in CI (#8798) 2021-02-18 10:56:10 -06:00
README.md Sensu Go Output Plugin for Telegraf (#8398) 2021-03-03 13:56:42 -05:00
accumulator.go Fix aggregator window and shutdown of multiple aggregators (#5644) 2019-03-29 15:40:33 -07:00
aggregator.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
build_version.txt Update build version to 1.18.0 2020-12-18 18:32:33 -05:00
docker-compose.yml Integration test audit (#8725) 2021-01-26 11:06:12 -07:00
go.mod Sensu Go Output Plugin for Telegraf (#8398) 2021-03-03 13:56:42 -05:00
go.sum Sensu Go Output Plugin for Telegraf (#8398) 2021-03-03 13:56:42 -05:00
input.go add plugin documentation 2020-10-14 12:27:16 -04:00
metric.go Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
output.go add plugin documentation 2020-10-14 12:27:16 -04:00
plugin.go add plugin documentation 2020-10-14 12:27:16 -04:00
processor.go add plugin documentation 2020-10-14 12:27:16 -04:00

README.md

Telegraf Circle CI Docker pulls

Slack Status

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:

Minimum Requirements

Telegraf shares the same minimum requirements as Go:

  • Linux kernel version 2.6.23 or later
  • Windows 7 or later
  • FreeBSD 11.2 or later
  • MacOS 10.11 El Capitan or later

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

  1. Install Go >=1.14 (1.15 recommended)
  2. Clone the Telegraf repository:
    cd ~/src
    git clone https://github.com/influxdata/telegraf.git
    
  3. Run make from the source directory
    cd ~/src/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 --section-filter agent:inputs:outputs --input-filter cpu --output-filter influxdb config

Run a single telegraf collection, outputting 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