telegraf

package module
v0.0.0-...-535192b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 7, 2019 License: MIT Imports: 1 Imported by: 0

README

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Accumulator 

type Accumulator interface {
	// AddFields adds a metric to the accumulator with the given measurement
	// name, fields, and tags (and timestamp). If a timestamp is not provided,
	// then the accumulator sets it to "now".
	AddFields(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	// AddGauge is the same as AddFields, but will add the metric as a "Gauge" type
	AddGauge(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	// AddCounter is the same as AddFields, but will add the metric as a "Counter" type
	AddCounter(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	// AddSummary is the same as AddFields, but will add the metric as a "Summary" type
	AddSummary(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	// AddHistogram is the same as AddFields, but will add the metric as a "Histogram" type
	AddHistogram(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	// AddMetric adds an metric to the accumulator.
	AddMetric(Metric)

	// SetPrecision sets the timestamp rounding precision.  All metrics addeds
	// added to the accumulator will have their timestamp rounded to the
	// nearest multiple of precision.
	SetPrecision(precision time.Duration)

	// Report an error.
	AddError(err error)

	// Upgrade to a TrackingAccumulator with space for maxTracked
	// metrics/batches.
	WithTracking(maxTracked int) TrackingAccumulator
}

Accumulator allows adding metrics to the processing flow.

type AggregatingOutput 

type AggregatingOutput interface {
	Output

	// Add the metric to the aggregator
	Add(in Metric)
	// Push returns the aggregated metrics and is called every flush interval.
	Push() []Metric
	// Reset signals the the aggregator period is completed.
	Reset()
}

AggregatingOutput adds aggregating functionality to an Output. May be used if the Output only accepts a fixed set of aggregations over a time period. These functions may be called concurrently to the Write function.

type Aggregator 

type Aggregator interface {
	// SampleConfig returns the default configuration of the Input.
	SampleConfig() string

	// Description returns a one-sentence description on the Input.
	Description() string

	// Add the metric to the aggregator.
	Add(in Metric)

	// Push pushes the current aggregates to the accumulator.
	Push(acc Accumulator)

	// Reset resets the aggregators caches and aggregates.
	Reset()
}

Aggregator is an interface for implementing an Aggregator plugin. the RunningAggregator wraps this interface and guarantees that Add, Push, and Reset can not be called concurrently, so locking is not required when implementing an Aggregator plugin.

type DeliveryInfo 

type DeliveryInfo interface {
	// ID is the TrackingID
	ID() TrackingID

	// Delivered returns true if the metric was processed successfully.
	Delivered() bool
}

DeliveryInfo provides the results of a delivered metric group.

type Field 

type Field struct {
	Key   string
	Value interface{}
}

type Initializer 

type Initializer interface {
	// Init performs one time setup of the plugin and returns an error if the
	// configuration is invalid.
	Init() error
}

Initializer is an interface that all plugin types: Inputs, Outputs, Processors, and Aggregators can optionally implement to initialize the plugin.

type Input 

type Input interface {
	// SampleConfig returns the default configuration of the Input
	SampleConfig() string

	// Description returns a one-sentence description on the Input
	Description() string

	// Gather takes in an accumulator and adds the metrics that the Input
	// gathers. This is called every "interval"
	Gather(Accumulator) error
}

type Metric 

type Metric interface {
	// Getting data structure functions
	Name() string
	Tags() map[string]string
	TagList() []*Tag
	Fields() map[string]interface{}
	FieldList() []*Field
	Time() time.Time
	Type() ValueType

	// Name functions
	SetName(name string)
	AddPrefix(prefix string)
	AddSuffix(suffix string)

	// Tag functions
	GetTag(key string) (string, bool)
	HasTag(key string) bool
	AddTag(key, value string)
	RemoveTag(key string)

	// Field functions
	GetField(key string) (interface{}, bool)
	HasField(key string) bool
	AddField(key string, value interface{})
	RemoveField(key string)

	SetTime(t time.Time)

	// HashID returns an unique identifier for the series.
	HashID() uint64

	// Copy returns a deep copy of the Metric.
	Copy() Metric

	// Accept marks the metric as processed successfully and written to an
	// output.
	Accept()

	// Reject marks the metric as processed unsuccessfully.
	Reject()

	// Drop marks the metric as processed successfully without being written
	// to any output.
	Drop()

	// Mark Metric as an aggregate
	SetAggregate(bool)
	IsAggregate() bool
}

type Output 

type Output interface {
	// Connect to the Output
	Connect() error
	// Close any connections to the Output
	Close() error
	// Description returns a one-sentence description on the Output
	Description() string
	// SampleConfig returns the default configuration of the Output
	SampleConfig() string
	// Write takes in group of points to be written to the Output
	Write(metrics []Metric) error
}

type Processor 

type Processor interface {
	// SampleConfig returns the default configuration of the Input
	SampleConfig() string

	// Description returns a one-sentence description on the Input
	Description() string

	// Apply the filter to the given metric.
	Apply(in ...Metric) []Metric
}

type ServiceInput 

type ServiceInput interface {
	Input

	// Start the ServiceInput.  The Accumulator may be retained and used until
	// Stop returns.
	Start(Accumulator) error

	// Stop stops the services and closes any necessary channels and connections
	Stop()
}

type Tag 

type Tag struct {
	Key   string
	Value string
}

type TrackingAccumulator 

type TrackingAccumulator interface {
	Accumulator

	// Add the Metric and arrange for tracking feedback after processing..
	AddTrackingMetric(m Metric) TrackingID

	// Add a group of Metrics and arrange for a signal when the group has been
	// processed.
	AddTrackingMetricGroup(group []Metric) TrackingID

	// Delivered returns a channel that will contain the tracking results.
	Delivered() <-chan DeliveryInfo
}

TrackingAccumulator is an Accumulator that provides a signal when the metric has been fully processed. Sending more metrics than the accumulator has been allocated for without reading status from the Accepted or Rejected channels is an error.

type TrackingID 

type TrackingID uint64

TrackingID uniquely identifies a tracked metric group

type ValueType 

type ValueType int

ValueType is an enumeration of metric types that represent a simple value. 

const (
	Counter ValueType
	Gauge
	Untyped
	Summary
	Histogram
)

Possible values for the ValueType enum.

Source Files

View all Source files

Directories

Path Synopsis
cmd
telegraf
config
config/aws
docker
globpath
limiter
models
rotate
syslog
templating
tls
plugins
aggregators
aggregators/all
aggregators/basicstats
aggregators/final
aggregators/histogram
aggregators/minmax
aggregators/valuecounter
inputs
inputs/activemq
inputs/aerospike
inputs/all
inputs/amqp_consumer
inputs/apache
inputs/aurora
inputs/bcache
inputs/beanstalkd
inputs/bind
inputs/bond
inputs/burrow
inputs/cassandra
inputs/ceph
inputs/cgroup
inputs/chrony
inputs/cisco_telemetry_gnmi
inputs/cisco_telemetry_mdt
inputs/cloud_pubsub
inputs/cloud_pubsub_push
inputs/cloudwatch
inputs/conntrack
inputs/consul
inputs/couchbase
inputs/couchdb
inputs/cpu
inputs/dcos
inputs/disk
inputs/diskio
inputs/disque
inputs/dmcache
inputs/dns_query
inputs/docker
Helper functions copied from https://github.com/docker/cli/blob/master/cli/command/container/stats_helpers.go
 Helper functions copied from https://github.com/docker/cli/blob/master/cli/command/container/stats_helpers.go
inputs/docker_log
inputs/dovecot
inputs/ecs
inputs/elasticsearch
inputs/exec
inputs/fail2ban
inputs/fibaro
inputs/file
inputs/filecount
inputs/filestat
inputs/fluentd
inputs/github
inputs/graylog
inputs/haproxy
inputs/hddtemp
inputs/hddtemp/go-hddtemp
inputs/http
inputs/http_listener_v2
inputs/http_response
inputs/httpjson
inputs/icinga2
inputs/influxdb
inputs/influxdb_listener
inputs/internal
inputs/interrupts
inputs/ipmi_sensor
inputs/ipset
inputs/iptables
inputs/ipvs
inputs/jenkins
inputs/jolokia
inputs/jolokia2
inputs/jti_openconfig_telemetry
inputs/jti_openconfig_telemetry/auth
Package authentication is a generated protocol buffer package.
 Package authentication is a generated protocol buffer package.
inputs/jti_openconfig_telemetry/oc
Package telemetry is a generated protocol buffer package.
 Package telemetry is a generated protocol buffer package.
inputs/kafka_consumer
inputs/kafka_consumer_legacy
inputs/kapacitor
inputs/kernel
inputs/kernel_vmstat
inputs/kibana
inputs/kinesis_consumer
inputs/kube_inventory
inputs/kubernetes
inputs/leofs
inputs/linux_sysctl_fs
inputs/logparser
inputs/lustre2
Lustre 2.x telegraf plugin
 Lustre 2.x telegraf plugin
inputs/mailchimp
inputs/mcrouter
inputs/mem
inputs/memcached
inputs/mesos
inputs/minecraft
inputs/minecraft/internal/rcon
Package rcon implements the communication protocol for communicating with RCON servers.
 Package rcon implements the communication protocol for communicating with RCON servers.
inputs/mongodb
inputs/mqtt_consumer
inputs/multifile
inputs/mysql
inputs/mysql/v1
inputs/nats
inputs/nats_consumer
inputs/neptune_apex
Package neptuneapex implements an input plugin for the Neptune Apex aquarium controller.
 Package neptuneapex implements an input plugin for the Neptune Apex aquarium controller.
inputs/net
inputs/net_response
inputs/nginx
inputs/nginx_plus
inputs/nginx_plus_api
inputs/nginx_upstream_check
inputs/nginx_vts
inputs/nsq
inputs/nsq_consumer
inputs/nstat
inputs/ntpq
inputs/nvidia_smi
inputs/openldap
inputs/opensmtpd
inputs/openweathermap
inputs/passenger
inputs/pf
inputs/pgbouncer
inputs/phpfpm
Package fcgi implements the FastCGI protocol.
 Package fcgi implements the FastCGI protocol.
inputs/ping
inputs/postfix
inputs/postgresql
inputs/postgresql_extensible
inputs/powerdns
inputs/powerdns_recursor
inputs/processes
inputs/procstat
inputs/prometheus
inputs/puppetagent
inputs/rabbitmq
inputs/raindrops
inputs/redis
inputs/rethinkdb
inputs/riak
inputs/salesforce
inputs/sensors
inputs/smart
inputs/snmp
inputs/snmp_legacy
inputs/socket_listener
inputs/solr
inputs/sqlserver
inputs/stackdriver
inputs/statsd
inputs/swap
inputs/syslog
inputs/sysstat
inputs/system
inputs/tail
inputs/tcp_listener
inputs/teamspeak
inputs/temp
inputs/tengine
inputs/tomcat
inputs/trig
inputs/twemproxy
inputs/udp_listener
inputs/unbound
inputs/varnish
inputs/vsphere
inputs/webhooks
inputs/webhooks/filestack
inputs/webhooks/github
inputs/webhooks/mandrill
inputs/webhooks/papertrail
inputs/webhooks/particle
inputs/webhooks/rollbar
inputs/win_perf_counters
inputs/win_services
inputs/wireless
inputs/x509_cert
Package x509_cert reports metrics from an SSL certificate.
 Package x509_cert reports metrics from an SSL certificate.
inputs/zfs
inputs/zipkin
inputs/zipkin/cmd/stress_test_write
inputs/zipkin/cmd/thrift_serialize
A small cli utility meant to convert json to zipkin thrift binary format, and vice versa.
 A small cli utility meant to convert json to zipkin thrift binary format, and vice versa.
inputs/zipkin/codec
inputs/zipkin/codec/jsonV1
inputs/zipkin/codec/thrift
inputs/zipkin/trace
inputs/zookeeper
outputs
outputs/all
outputs/amon
outputs/amqp
outputs/application_insights
outputs/application_insights/mocks
Code generated by mockery v1.0.0
 Code generated by mockery v1.0.0
outputs/azure_monitor
outputs/cloud_pubsub
outputs/cloudwatch
outputs/cratedb
outputs/datadog
outputs/discard
outputs/elasticsearch
outputs/file
outputs/graphite
outputs/graylog
outputs/health
outputs/http
outputs/influxdb
outputs/influxdb_v2
outputs/instrumental
outputs/kafka
outputs/kinesis
outputs/librato
outputs/mqtt
outputs/nats
outputs/nsq
outputs/opentsdb
outputs/prometheus_client
outputs/riemann
outputs/riemann_legacy
outputs/socket_writer
outputs/stackdriver
outputs/syslog
outputs/wavefront
parsers
parsers/collectd
parsers/csv
parsers/dropwizard
parsers/form_urlencoded
parsers/graphite
parsers/grok
parsers/influx
parsers/json
parsers/logfmt
parsers/nagios
parsers/value
parsers/wavefront
processors
processors/all
processors/converter
processors/date
processors/enum
processors/override
processors/parser
processors/pivot
processors/printer
processors/regex
processors/rename
processors/strings
processors/topk
processors/unpivot
serializers
serializers/carbon2
serializers/graphite
serializers/influx
serializers/json
serializers/nowmetric
serializers/splunkmetric
serializers/wavefront
selfstat is a package for tracking and collecting internal statistics about telegraf.
 selfstat is a package for tracking and collecting internal statistics about telegraf.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.