Go to file
Samantha Wang b1bce91345
add tagpass/tagdrop note in docs (#8053)
2020-09-03 13:32:20 -07:00
.circleci update go versions: 1.14.5, 1.13.13 (#7837) 2020-07-14 20:21:02 -04:00
.github Update Support.md 2020-08-13 18:39:25 -04:00
agent fix minor agent race condition around error messages (#7999) 2020-08-18 11:27:58 -04:00
cmd/telegraf Add support for once mode; run processors and aggregators during test (#7474) 2020-06-01 15:26:20 -07:00
config [agent] Cleanup duplicates in loaded plugins list (#7852) 2020-08-19 18:18:52 -04:00
docs add tagpass/tagdrop note in docs (#8053) 2020-09-03 13:32:20 -07:00
etc Update telegraf.conf 2020-07-16 10:00:50 -07:00
filter Add test for include/exclude filter (#5193) 2018-12-26 13:15:13 -08:00
internal prefer testify error funcs over nil checks (#7857) 2020-07-20 10:34:46 -04:00
logger Skip logging when logfile is unset (#6648) 2019-11-11 17:03:03 -08:00
metric Fix assorted spelling mistakes (#7507) 2020-05-15 15:43:32 -07:00
models shim logger improvements (#7865) 2020-07-22 14:29:50 -04:00
plugins Add OPC UA input plugin (#8009) 2020-09-02 16:52:46 -06:00
scripts fix docker build. update dockerfiles to Go 1.14 (#8051) 2020-08-28 16:39:55 -04:00
selfstat Fix assorted spelling mistakes (#7507) 2020-05-15 15:43:32 -07:00
testutil http_listener_v2: make http header tags case insensitive (#7986) 2020-08-14 13:43:31 -04:00
.gitattributes Use merge=union driver for go.sum 2020-03-16 10:02:49 -07:00
.gitignore Dynatrace output plugin (#7881) 2020-08-12 11:51:53 -04:00
CHANGELOG.md Update CHANGELOG.md 2020-08-14 14:53:30 -04:00
CONTRIBUTING.md Create external plugins doc file and update contributing guide (#8001) 2020-08-26 16:43:35 -06:00
EXTERNAL_PLUGINS.md add guidelines run to external plugins with execd (#8054) 2020-09-03 13:31:29 -07:00
LICENSE Build packages in makefile (#7759) 2020-06-30 00:15:28 -07:00
Makefile Fix docker-image make target (#8005) 2020-09-03 09:38:19 -06:00
README.md Dynatrace Plugin - Updated Documentation (#7994) 2020-08-17 18:37:13 -04: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
appveyor.yml Update to Go 1.14.3 with testing using 1.13.11 (#7564) 2020-05-26 15:40:25 -07:00
docker-compose.yml Add set, and histogram reporting to aerospike telegraf plugin (#8025) 2020-08-28 12:05:42 -04:00
go.mod Add OPC UA input plugin (#8009) 2020-09-02 16:52:46 -06:00
go.sum Add OPC UA input plugin (#8009) 2020-09-02 16:52:46 -06:00
input.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
metric.go Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
output.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
plugin.go add support for streaming processors (#7634) 2020-06-05 10:43:43 -04:00
processor.go Add starlark processor (#7660) 2020-06-23 14:15:14 -07: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:

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

  1. Install Go >=1.13 (1.14 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