Go to file
Alexander Krantz e0ac5078bb
Fix Couchbase regression (#9448)
2021-07-01 14:50:35 -06:00
.circleci New JSON Parser (#9246) 2021-06-10 13:22:18 -06:00
.github Migrate soniah/gosnmp import to gosnmp/gosnmp (#9203) 2021-05-13 15:00:57 -05:00
agent Remove error return type from metric.New method (#9116) 2021-04-13 14:40:03 -04:00
assets Mac Packaging / Notarization (#8878) 2021-03-05 10:14:01 -05:00
cmd/telegraf Feature: merge multiple "--config" and "--config-directory" flags (#9007) 2021-05-18 16:20:13 -05:00
config XPath parser extension to allow parsing of JSON, MessagePack and Protocol-buffers (#9277) 2021-07-01 16:48:16 -04:00
docs XPath parser extension to allow parsing of JSON, MessagePack and Protocol-buffers (#9277) 2021-07-01 16:48:16 -04:00
etc Update changelog 2021-06-17 10:29:08 -06:00
filter Generic SQL input (#8735) 2021-06-15 13:10:52 -06:00
internal Generic SQL input (#8735) 2021-06-15 13:10:52 -06:00
logger Config Option to Enable Logging with Local Time (#9123) 2021-04-16 14:39:19 -04:00
metric Remove error return type from metric.New method (#9116) 2021-04-13 14:40:03 -04:00
models Remove error return type from metric.New method (#9116) 2021-04-13 14:40:03 -04:00
plugins Fix Couchbase regression (#9448) 2021-07-01 14:50:35 -06:00
scripts Fix Mac script to install go (#9345) 2021-06-10 11:12:14 -05:00
selfstat Remove error return type from metric.New method (#9116) 2021-04-13 14:40:03 -04:00
telegraflinter Private linter for Telegraf (#9168) 2021-04-26 16:12:58 -05:00
testutil Bugfix outputs influxdb endless retires (#9296) 2021-06-10 16:05:43 -05:00
.gitattributes Fix tests for Windows - part 1 (#8414) 2020-11-23 10:40:32 -05:00
.gitignore Add Elasticsearch query input plugin (#3536) 2021-06-21 16:35:26 -05:00
.golangci.yml Linter fixes for plugins/inputs/[de]* (#9379) 2021-06-21 10:07:52 -05:00
.lgtm.yml Clearing LGTM alerts and warnings (#8923) 2021-03-03 14:56:31 -05:00
CHANGELOG.md Update changelog 2021-06-17 10:29:08 -06:00
CONTRIBUTING.md Move wiki information to docs (#9126) 2021-04-22 16:51:21 -07:00
EXTERNAL_PLUGINS.md Add s7comm external input plugin (#9360) 2021-06-15 16:11:23 -06:00
LICENSE Build packages in makefile (#7759) 2020-06-30 00:15:28 -07:00
Makefile Update Go to 1.16.5 (#9331) 2021-06-07 19:19:22 -05:00
README.md add OpenTelemetry entry (#9464) 2021-07-01 09:59:44 -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.20.0 2021-06-17 15:24:34 -06:00
docker-compose.yml Update pgx to v4 (#9182) 2021-06-02 21:28:16 -06:00
go.mod XPath parser extension to allow parsing of JSON, MessagePack and Protocol-buffers (#9277) 2021-07-01 16:48:16 -04:00
go.sum XPath parser extension to allow parsing of JSON, MessagePack and Protocol-buffers (#9277) 2021-07-01 16:48:16 -04:00
info.plist Mac Packaging / Notarization (#8878) 2021-03-05 10:14:01 -05:00
input.go add plugin documentation 2020-10-14 12:27:16 -04:00
metric.go Cleanup metric type docs (#9244) 2021-05-20 16:34:07 -04:00
output.go add plugin documentation 2020-10-14 12:27:16 -04:00
plugin.go exec plugins should not truncate messages in debug mode (#8333) 2021-03-18 17:21:30 -04:00
processor.go add plugin documentation 2020-10-14 12:27:16 -04:00

README.md

Telegraf Circle CI Docker pulls Total alerts

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:

FreeBSD - .tar.gz

Linux - .rpm

Linux - .deb

Linux - .tar.gz

OSX - .tar.gz

Windows - .zip

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