Telegraf is a plugin-driven agent that collects, processes, aggregates, and writes metrics.It supports four categories of plugins: input, output, aggregator, and processor.In addition to the included plugins, you can run external pluginsthat integrate with the Telegraf Execd processor plugin.
Amazon ECS input plugin (AWS Fargate compatible) uses the Amazon ECS v2 metadata and stats API endpoints to gather stats on running containers in a task.The Telegraf container and the workload that Telegraf is inspecting must be run in the same task. This is similar to (and reuses pieces of) theDocker input plugin, with some ECS-specific modifications for AWS metadata and stats formats.
Typically, the mod_status module is configured to expose a page at the/server-status?auto location of the Apache server.The ExtendedStatusoption must be enabled in order to collect all available fields.For information about how to configure your server reference, see themodule documentation.
The Apache Kafka Consumer input plugin polls a specified Kafka topic and adds messages to InfluxDB.Messages are expected in the line protocol format.Consumer Groupis used to talk to the Kafka cluster so multiple instances of Telegraf can readfrom the same topic in parallel.
The Apache Tomcat input plugin collects statistics available from the ApacheTomcat manager status page ( =true).Using XML=true returns XML data.See the Apache Tomcat documentationfor details on these statistics.
Cisco GNMI Telemetry input plugin consumes telemetry data similar to the GNMI specification.This GRPC-based protocol can utilize TLS for authentication and encryption.This plugin has been developed to support GNMI telemetry as produced by Cisco IOS XR (64-bit) version 6.5.1 and later.
Cisco model-driven telemetry (MDT) is an input plugin that consumes telemetry data from Cisco IOS XR, IOS XE and NX-OS platforms.It supports TCP & GRPC dialout transports. GRPC-based transport can utilize TLS for authentication and encryption.Telemetry data is expected to be GPB-KV (self-describing-gpb) encoded.
The conntrack-tools provide a mechanism for tracking various aspects ofnetwork connections as they are processed by netfilter.At runtime, conntrack exposes many of those connection statistics within /proc/sys/net.Depending on your kernel version, these files can be found in either /proc/sys/net/ipv4/netfilteror /proc/sys/net/netfilter and will be prefixed with either ip_ or nf_.This plugin reads the files specified in its configuration and publishes each one as a field,with the prefix normalized to ip_.
The Consul input plugin will collect statistics about all health checks registered in the Consul.It uses Consul API to query the data.It will not report the telemetry but Consul can report those stats already using StatsD protocol, if needed.
The Docker input plugin uses the Docker Engine API to gather metrics on running Docker containers.The Docker plugin uses the Official Docker Clientto gather stats from the Engine API library documentation.
The Exec input plugin parses supported Telegraf input data formats(line protocol, JSON, Graphite, Value, Nagios, Collectd, and Dropwizard) into metrics.Each Telegraf metric includes the measurement name, tags, fields, and timestamp.
The Execd input plugin runs an external program as a daemon. Programs must output metrics in an acceptedTelegraf input data formaton its standard output. Configure signal to send a signal to the daemon running on each collection interval.The program output on standard error is mirrored to the Telegraf log.
The Fibaro input plugin makes HTTP calls to the Fibaro controller API to gather values of hooked devices.Those values could be true (1) or false (0) for switches, percentage for dimmers, temperature, etc.
The Fluentd input plugin gathers Fluentd server metrics from plugin endpoint provided by in_monitor plugin.This plugin understands data provided by /api/plugin.json resource (/api/config.json is not covered).
The gNMI plugin consumes telemetry data based on thegNMI Subscribe method.The plugin supports TLS for authentication and encryption.This input plugin is vendor-agnostic and is supported on any platform that supports the gNMI spec.
The HTTP input plugin collects metrics from one or more HTTP (or HTTPS) endpoints.The endpoint should have metrics formatted in one of the supported input data formats.Each data format has its own unique set of configuration options which can be added to the input configuration.
The http_listener input plugin was renamed to influxdb_listener.The new name better describes the intended use of the plugin as a InfluxDB relay.For general purpose transfer of metrics in any format via HTTP, use http_listener_v2instead.
The HTTP Listener v2 input plugin listens for metrics sent via HTTP.Metrics may be sent in any supported Telegraf input data format.Note the plugin previously known as http_listener has been renamed influxdb_listener.To use Telegraf as a proxy/relay for InfluxDB, we recommend using influxdb_listener.
The HTTP Response input plugin gathers metrics for HTTP responses.The measurements and fields include response_time, http_response_code,and result_type. Tags for measurements include server and method.
The Huge Pages input plugin gathers Huge pages measurements. Transparent Huge Pages (THP) is a Linux memory management system that reduces the overhead of Translation Lookaside Buffer (TLB) lookups on machines with large amounts of memory by using larger memory pages.
The InfluxDB Listener input plugin listens for requests sentaccording to the InfluxDB HTTP API.The intent of the plugin is to allow Telegraf to serve as a proxy, or router,for the HTTP /write endpoint of the InfluxDB HTTP API.
When chaining Telegraf instances using this plugin, CREATE DATABASE requestsreceive a 200 OK response with message body "results":[] but they are notrelayed. The output configuration of the Telegraf instance which ultimatelysubmits data to InfluxDB determines the destination database.
The InfluxDB v2 Listener input plugin listens for requests sentaccording to the InfluxDB HTTP API.The intent of the plugin is to allow Telegraf to serve as a proxy, or router,for the HTTP /api/v2/write endpoint of the InfluxDB HTTP API.
The JTI OpenConfig Telemetry input plugin reads Juniper Networks implementationof OpenConfig telemetry data from listed sensors using the Junos Telemetry Interface.Refer to openconfig.net for more details about OpenConfigand Junos Telemetry Interface (JTI).
The Kubernetes input plugin talks to the kubelet API using the /stats/summaryendpoint to gather metrics about the running pods and containers for a single host.It is assumed that this plugin is running as part of a daemonset within aKubernetes installation. This means that Telegraf is running on every node within the cluster.Therefore, you should configure this plugin to talk to its locally running kubelet.
The Microsoft SQL Server input plugin provides metrics for your Microsoft SQL Server instance.It currently works with SQL Server versions 2008+.Recorded metrics are lightweight and use Dynamic Management Views supplied by SQL Server.
The Monit input plugin gathers metrics and status information about local processes, remote hosts, files,file systems, directories, and network interfaces managed and watched by Monit. To use this plugin,enable the HTTPD TCP port in Monit.
The Multifile input plugin allows Telegraf to combine data from multiple filesinto a single metric, creating one field or tag per file.This is often useful creating custom metrics from the /sys or /proc filesystems.
The NATS Consumer input plugin reads from specified NATS subjects and adds messages to InfluxDB.Messages are expected in the Telegraf input data formats.A Queue Group is used when subscribing to subjects so multiple instances of Telegrafcan read from a NATS cluster in parallel.
The Neptune Apex input plugin collects real-time data from the Apex status.xml page.The Neptune Apex controller family allows an aquarium hobbyist to monitor andcontrol their tanks based on various probes.The data is taken directly from the /cgi-bin/status.xml at the interval specifiedin the telegraf.conf configuration file.
The NGINX VTS input plugin gathers NGINX status using external virtual hosttraffic status module - -module-vts.This is an NGINX module that provides access to virtual host status information.It contains the current status such as servers, upstreams, caches.This is similar to the live activity monitoring of NGINX Plus.For module configuration details, see theNGINX VTS module documentation.
The NGINX Upstream Check input plugin reads the status output of thenginx_upstream_check.This module can periodically check the NGINX upstream servers using the configuredrequest and interval to determine if the server is still available.If checks are failed, then the server is marked as down and will not receiveany requests until the check passes and the server will be marked as up again.
The PF input plugin gathers information from the FreeBSD/OpenBSD pf firewall.Currently it can retrieve information about the state table: the number of currententries in the table, and counters for the number of searches, inserts, and removalsto the table. The pf plugin retrieves this information by invoking the pfstat command.
The Postfix input plugin reports metrics on the postfix queues.For each of the active, hold, incoming, maildrop, and deferredqueues,it will report the queue length (number of items),size (bytes used by items), and age (age of oldest item in seconds).
The PostgreSQL input plugin provides metrics for your PostgreSQL database.It currently works with PostgreSQL versions 8.1+.It uses data from the built-in pg_stat_database and pg_stat_bgwriter views.The metrics recorded depend on your version of PostgreSQL.
The Processes input plugin gathers info about the total number of processesand groups them by status (zombie, sleeping, running, etc.). On Linux, thisplugin requires access to procfs (/proc); on other operating systems,it requires access to execute ps.
4a15465005