rcbops/ops-fabric-telegraf

Name: ops-fabric-telegraf

Owner: rcbops

Description: The plugin-driven server agent for collecting & reporting metrics.

Created: 2018-05-23 14:04:40.0

Updated: 2018-05-23 14:05:20.0

Pushed: 2018-05-24 20:45:38.0

Homepage:

Size: 18504

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

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 . For an example configuration referencet from local or remote services.

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 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.8+, the Makefile requires GNU make.

Dependencies are managed with gdm, which is installed by the Makefile if you don't have it already.

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

These builds are generated from the master branch:

How to use it:

See usage with:

legraf --help
Generate a telegraf config file: 
legraf config > telegraf.conf
Generate config with only cpu input & influxdb output plugins defined: 
legraf --input-filter cpu --output-filter influxdb config
Run a single telegraf collection, outputing metrics to stdout: 
legraf --config telegraf.conf --test
Run telegraf with all plugins defined in config file: 
legraf --config telegraf.conf
Run telegraf, enabling the cpu & memory input, and influxdb output plugins: 
legraf --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
This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.