fix(readmes): standarize first line of readmes (#7973)
This commit is contained in:
parent
a6c8f5be13
commit
40c6d189fe
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Input Plugin: Azure Storage Queue
|
||||
# Azure Storage Queue Input Plugin
|
||||
|
||||
This plugin gathers sizes of Azure Storage Queues.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf plugin: bcache
|
||||
# bcache Input Plugin
|
||||
|
||||
Get bcache stat from stats_total directory and dirty_data file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: Burrow
|
||||
# Burrow Kafka Consumer Lag Checking Input Plugin
|
||||
|
||||
Collect Kafka topic, consumer and partition status
|
||||
via [Burrow](https://github.com/linkedin/Burrow) HTTP [API](https://github.com/linkedin/Burrow/wiki/HTTP-Endpoint).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
|
||||
# Telegraf plugin: Cassandra
|
||||
# Cassandra Input Plugin
|
||||
|
||||
### **Deprecated in version 1.7**: Please use the [jolokia2](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/jolokia2) plugin with the [cassandra.conf](/plugins/inputs/jolokia2/examples/cassandra.conf) example configuration.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# CGroup Input Plugin For Telegraf Agent
|
||||
# CGroup Input Plugin
|
||||
|
||||
This input plugin will capture specific statistics per cgroup.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Cisco model-driven telemetry (MDT)
|
||||
# Cisco Model-Driven Telemetry (MDT) Input Plugin
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Google Cloud PubSub Push Input Service Plugin
|
||||
# Google Cloud PubSub Push Input Plugin
|
||||
|
||||
The Google Cloud PubSub Push listener is a service input plugin that listens for messages sent via an HTTP POST from [Google Cloud PubSub][pubsub].
|
||||
The plugin expects messages in Google's Pub/Sub JSON Format ONLY.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Amazon CloudWatch Statistics Input
|
||||
# Amazon CloudWatch Statistics Input Plugin
|
||||
|
||||
This plugin will pull Metric Statistics from Amazon CloudWatch.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Conntrack Plugin
|
||||
# Conntrack Input Plugin
|
||||
|
||||
Collects stats from Netfilter's conntrack-tools.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: Couchbase
|
||||
# Couchbase Input Plugin
|
||||
|
||||
## Configuration:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Disque Input
|
||||
# Disque Input Plugin
|
||||
|
||||
[Disque](https://github.com/antirez/disque) is an ongoing experiment to build a distributed, in-memory, message broker.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# gNMI (gRPC Network Management Interface)
|
||||
# gNMI (gRPC Network Management Interface) Input Plugin
|
||||
|
||||
This plugin consumes telemetry data based on the [gNMI](https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md) Subscribe method. TLS is supported for authentication and encryption. This input plugin is vendor-agnostic and is supported on any platform that supports the gNMI spec.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# GrayLog plugin
|
||||
# GrayLog Input Plugin
|
||||
|
||||
The Graylog plugin can collect data from remote Graylog service URLs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# influxdb plugin
|
||||
# InfluxDB Input Plugin
|
||||
|
||||
The InfluxDB plugin will collect metrics on the given InfluxDB servers.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Ipset Plugin
|
||||
# Ipset Input Plugin
|
||||
|
||||
The ipset plugin gathers packets and bytes counters from Linux ipset.
|
||||
It uses the output of the command "ipset save".
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Iptables Plugin
|
||||
# Iptables Input Plugin
|
||||
|
||||
The iptables plugin gathers packets and bytes counters for rules within a set of table and chain from the Linux's iptables firewall.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Jenkins Plugin
|
||||
# Jenkins Input Plugin
|
||||
|
||||
The jenkins plugin gathers information about the nodes and jobs running in a jenkins instance.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf plugin: Jolokia
|
||||
# Jolokia Input Plugin
|
||||
|
||||
**Deprecated in version 1.5:** Please use the [jolokia2](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/jolokia2) plugin.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Jolokia2 Input Plugins
|
||||
# Jolokia2 Input Plugin
|
||||
|
||||
The [Jolokia](http://jolokia.org) _agent_ and _proxy_ input plugins collect JMX metrics from an HTTP endpoint using Jolokia's [JSON-over-HTTP protocol](https://jolokia.org/reference/html/protocol.html).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Kafka Consumer Input Plugin
|
||||
# Kafka Consumer Legacy Input Plugin
|
||||
|
||||
The [Kafka](http://kafka.apache.org/) consumer plugin polls a specified Kafka
|
||||
topic and adds messages to InfluxDB. The plugin assumes messages follow the
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Kapacitor Plugin
|
||||
# Kapacitor Input Plugin
|
||||
|
||||
The Kapacitor plugin collects metrics from the given Kapacitor instances.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Kube_Inventory Plugin
|
||||
# Kubernetes Inventory Input Plugin
|
||||
|
||||
This plugin generates metrics derived from the state of the following Kubernetes resources:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Linux Sysctl FS Input
|
||||
# Linux Sysctl FS Input Plugin
|
||||
|
||||
The linux_sysctl_fs input provides Linux system level file metrics. The documentation on these fields can be found at https://www.kernel.org/doc/Documentation/sysctl/fs.txt.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Mailchimp Input
|
||||
# Mailchimp Input Plugin
|
||||
|
||||
Pulls campaign reports from the [Mailchimp API](https://developer.mailchimp.com/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# MarkLogic Plugin
|
||||
# MarkLogic Input Plugin
|
||||
|
||||
The MarkLogic Telegraf plugin gathers health status metrics from one or more host.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Mem Input Plugin
|
||||
# Memory Input Plugin
|
||||
|
||||
The mem plugin collects system memory metrics.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: Nginx
|
||||
# Nginx Input Plugin
|
||||
|
||||
### Configuration:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: nginx_plus
|
||||
# Nginx Plus Input Plugin
|
||||
|
||||
Nginx Plus is a commercial version of the open source web server Nginx. The use this plugin you will need a license. For more information about the differences between Nginx (F/OSS) and Nginx Plus, [click here](https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: nginx_plus_api
|
||||
# Nginx Plus API Input Plugin
|
||||
|
||||
Nginx Plus is a commercial version of the open source web server Nginx. The use this plugin you will need a license. For more information about the differences between Nginx (F/OSS) and Nginx Plus, [click here](https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: Nginx_upstream_check
|
||||
# Nginx Upstream Check Input Plugin
|
||||
|
||||
Read the status output of the nginx_upstream_check (https://github.com/yaoweibin/nginx_upstream_check_module).
|
||||
This module can periodically check the servers in the Nginx's upstream with configured request and interval to determine
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: nginx_vts
|
||||
# Nginx Virtual Host Traffic (VTS) Input Plugin
|
||||
|
||||
This plugin gathers Nginx status using external virtual host traffic status module - https://github.com/vozlt/nginx-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 please see its [documentation](https://github.com/vozlt/nginx-module-vts#synopsis).
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Nstat input plugin
|
||||
# Nstat Input Plugin
|
||||
|
||||
Plugin collects network metrics from `/proc/net/netstat`, `/proc/net/snmp` and `/proc/net/snmp6` files
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# `nvidia-smi` Input Plugin
|
||||
# Nvidia System Management Interface (SMI) Input Plugin
|
||||
|
||||
This plugin uses a query on the [`nvidia-smi`](https://developer.nvidia.com/nvidia-system-management-interface) binary to pull GPU stats including memory and GPU usage, temp and other.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Openldap Input Plugin
|
||||
# OpenLDAP Input Plugin
|
||||
|
||||
This plugin gathers metrics from OpenLDAP's cn=Monitor backend.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# PF Plugin
|
||||
# PF Input Plugin
|
||||
|
||||
The pf plugin gathers information from the FreeBSD/OpenBSD pf firewall. Currently it can retrieve information about the state table: the number of current entries in the table, and counters for the number of searches, inserts, and removals to the table.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# PostgreSQL plugin
|
||||
# PostgreSQL Input Plugin
|
||||
|
||||
This postgresql plugin provides metrics for your postgres database. It currently works with postgres 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 postgres. See table:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# PostgreSQL plugin
|
||||
# PostgreSQL Extensible Input Plugin
|
||||
|
||||
This postgresql plugin provides metrics for your postgres database. It has been
|
||||
designed to parse SQL queries in the plugin section of your `telegraf.conf`.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Telegraf Plugin: PuppetAgent
|
||||
# PuppetAgent Input Plugin
|
||||
|
||||
#### Description
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Plugin: Redis
|
||||
# Redis Input Plugin
|
||||
|
||||
### Configuration:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# RethinkDB Input
|
||||
# RethinkDB Input Plugin
|
||||
|
||||
Collect metrics from [RethinkDB](https://www.rethinkdb.com/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Riak Plugin
|
||||
# Riak Input Plugin
|
||||
|
||||
The Riak plugin gathers metrics from one or more riak instances.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# sensors Input Plugin
|
||||
# LM Sensors Input Plugin
|
||||
|
||||
Collect [lm-sensors](https://en.wikipedia.org/wiki/Lm_sensors) metrics - requires the lm-sensors
|
||||
package installed.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# SNMP Input Plugin
|
||||
# SNMP Legacy Input Plugin
|
||||
|
||||
The SNMP input plugin gathers metrics from SNMP agents
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# socket listener service input plugin
|
||||
# Socket Listener Input Plugin
|
||||
|
||||
The Socket Listener is a service input plugin that listens for messages from
|
||||
streaming (tcp, unix) or datagram (udp, unixgram) protocols.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Solr input plugin
|
||||
# Solr Input Plugin
|
||||
|
||||
The [solr](http://lucene.apache.org/solr/) plugin collects stats via the
|
||||
[MBean Request Handler](https://cwiki.apache.org/confluence/display/solr/MBean+Request+Handler)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Telegraf Service Plugin: statsd
|
||||
# StatsD Input Plugin
|
||||
|
||||
### Configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Systemd Units Plugin
|
||||
# systemd Units Input Plugin
|
||||
|
||||
The systemd_units plugin gathers systemd unit status on Linux. It relies on
|
||||
`systemctl list-units --all --type=service` to collect data on service status.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# TCP listener service input plugin
|
||||
# TCP Listener Input Plugin
|
||||
|
||||
> DEPRECATED: As of version 1.3 the TCP listener plugin has been deprecated in favor of the
|
||||
> [socket_listener plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Temp Input plugin
|
||||
# Temperature Input Plugin
|
||||
|
||||
The temp input plugin gather metrics on system temperature. This plugin is
|
||||
meant to be multi platform and uses platform specific collection methods.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# UDP listener service input plugin
|
||||
# UDP Listener Input Plugin
|
||||
|
||||
> DEPRECATED: As of version 1.3 the UDP listener plugin has been deprecated in favor of the
|
||||
> [socket_listener plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# uWSGI
|
||||
# uWSGI Input Plugin
|
||||
|
||||
The uWSGI input plugin gathers metrics about uWSGI using its [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Webhooks
|
||||
# Webhooks Input Plugin
|
||||
|
||||
This is a Telegraf service plugin that start an http server and register multiple webhook listeners.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# win_perf_counters readme
|
||||
# Windows Performance Counters Input Plugin
|
||||
|
||||
This document presents the input plugin to read Performance Counters on Windows operating systems.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# X509 Cert Input Plugin
|
||||
# x509 Certificate Input Plugin
|
||||
|
||||
This plugin provides information about X509 certificate accessible via local
|
||||
file or network connection.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# ZFS plugin
|
||||
# ZFS Input Plugin
|
||||
|
||||
This ZFS plugin provides metrics from your ZFS filesystems. It supports ZFS on
|
||||
Linux and FreeBSD. It gets ZFS stat from `/proc/spl/kstat/zfs` on Linux and
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Zipkin Plugin
|
||||
# Zipkin Input Plugin
|
||||
|
||||
This plugin implements the Zipkin http server to gather trace and timing data needed to troubleshoot latency problems in microservice architectures.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Zookeeper Input Plugin
|
||||
# Zookeeper Input Plugin
|
||||
|
||||
The zookeeper plugin collects variables outputted from the 'mntr' command
|
||||
[Zookeeper Admin](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html).
|
||||
|
|
|
|||
Loading…
Reference in New Issue