Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(readmes): standardize first line of readmes #7973

Merged
merged 1 commit into from
Aug 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion plugins/inputs/azure_storage_queue/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf Input Plugin: Azure Storage Queue
# Azure Storage Queue Input Plugin

This plugin gathers sizes of Azure Storage Queues.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/bcache/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf plugin: bcache
# bcache Input Plugin

Get bcache stat from stats_total directory and dirty_data file.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/burrow/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
3 changes: 1 addition & 2 deletions plugins/inputs/cassandra/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/cgroup/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CGroup Input Plugin For Telegraf Agent
# CGroup Input Plugin

This input plugin will capture specific statistics per cgroup.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/cisco_telemetry_mdt/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/cloud_pubsub_push/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/cloudwatch/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Amazon CloudWatch Statistics Input
# Amazon CloudWatch Statistics Input Plugin

This plugin will pull Metric Statistics from Amazon CloudWatch.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/conntrack/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Conntrack Plugin
# Conntrack Input Plugin

Collects stats from Netfilter's conntrack-tools.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/couchbase/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf Plugin: Couchbase
# Couchbase Input Plugin

## Configuration:

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/disque/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/gnmi/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/graylog/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GrayLog plugin
# GrayLog Input Plugin

The Graylog plugin can collect data from remote Graylog service URLs.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/influxdb/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# influxdb plugin
# InfluxDB Input Plugin

The InfluxDB plugin will collect metrics on the given InfluxDB servers.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/ipset/README.md
Original file line number Diff line number Diff line change
@@ -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".
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/iptables/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/jenkins/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Jenkins Plugin
# Jenkins Input Plugin

The jenkins plugin gathers information about the nodes and jobs running in a jenkins instance.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/jolokia/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/jolokia2/README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/kafka_consumer_legacy/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/kapacitor/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kapacitor Plugin
# Kapacitor Input Plugin

The Kapacitor plugin collects metrics from the given Kapacitor instances.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/kube_inventory/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kube_Inventory Plugin
# Kubernetes Inventory Input Plugin

This plugin generates metrics derived from the state of the following Kubernetes resources:

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/linux_sysctl_fs/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/mailchimp/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mailchimp Input
# Mailchimp Input Plugin

Pulls campaign reports from the [Mailchimp API](https://developer.mailchimp.com/).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/marklogic/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MarkLogic Plugin
# MarkLogic Input Plugin

The MarkLogic Telegraf plugin gathers health status metrics from one or more host.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/mem/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mem Input Plugin
# Memory Input Plugin

The mem plugin collects system memory metrics.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nginx/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf Plugin: Nginx
# Nginx Input Plugin

### Configuration:

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nginx_plus/README.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nginx_plus_api/README.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nginx_upstream_check/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nginx_vts/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nstat/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/nvidia_smi/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/openldap/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Openldap Input Plugin
# OpenLDAP Input Plugin

This plugin gathers metrics from OpenLDAP's cn=Monitor backend.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/pf/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/postgresql/README.md
Original file line number Diff line number Diff line change
@@ -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:
```
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/postgresql_extensible/README.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/puppetagent/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Telegraf Plugin: PuppetAgent
# PuppetAgent Input Plugin

#### Description

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/redis/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf Plugin: Redis
# Redis Input Plugin

### Configuration:

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/rethinkdb/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RethinkDB Input
# RethinkDB Input Plugin

Collect metrics from [RethinkDB](https://www.rethinkdb.com/).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/riak/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Riak Plugin
# Riak Input Plugin

The Riak plugin gathers metrics from one or more riak instances.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/sensors/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/snmp_legacy/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SNMP Input Plugin
# SNMP Legacy Input Plugin

The SNMP input plugin gathers metrics from SNMP agents

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/socket_listener/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/solr/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/statsd/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Telegraf Service Plugin: statsd
# StatsD Input Plugin

### Configuration

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/systemd_units/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/tcp_listener/README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion plugins/inputs/temp/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/udp_listener/README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion plugins/inputs/uwsgi/README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/webhooks/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Webhooks
# Webhooks Input Plugin

This is a Telegraf service plugin that start an http server and register multiple webhook listeners.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/win_perf_counters/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/x509_cert/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/zfs/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/zipkin/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/zookeeper/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down