chore(inputs): add descriptions to config in README.md (#10962)

plugins/inputs/example/README.md

@@ -13,6 +13,7 @@ This section contains the default TOML to configure the plugin.  You can
 generate it using `telegraf --usage <plugin-name>`.
 
 ```toml
+# This is an example plugin
 [[inputs.example]]
   example_option = "example_value"
 ```

plugins/inputs/httpjson/README.md

@@ -7,6 +7,7 @@ The httpjson plugin collects data from HTTP URLs which respond with JSON.  It fl
 ## Configuration
 
 ```toml
+# Read flattened metrics from one or more JSON HTTP endpoints
 [[inputs.httpjson]]
   ## NOTE This plugin only reads numerical measurements, strings and booleans
   ## will be ignored.

plugins/inputs/influxdb_listener/README.md

@@ -21,6 +21,7 @@ submits data to InfluxDB determines the destination database.
 ## Configuration
 
 ```toml
+# Accept metrics over InfluxDB 1.x HTTP API
 [[inputs.influxdb_listener]]
   ## Address and port to host HTTP listener on
   service_address = ":8186"

plugins/inputs/mqtt_consumer/README.md

@@ -6,6 +6,7 @@ and creates metrics using one of the supported [input data formats][].
 ## Configuration
 
 ```toml
+# Read metrics from MQTT topic(s)
 [[inputs.mqtt_consumer]]
   ## Broker URLs for the MQTT server or cluster.  To connect to multiple
   ## clusters or standalone servers, use a separate plugin instance.

plugins/inputs/nats_consumer/README.md

@@ -9,6 +9,7 @@ instances of telegraf can read from a NATS cluster in parallel.
 ## Configuration
 
 ```toml
+# Read metrics from NATS subject(s)
 [[inputs.nats_consumer]]
   ## urls of NATS servers
   servers = ["nats://localhost:4222"]

plugins/inputs/postgresql/README.md

@@ -33,6 +33,7 @@ More information about the meaning of these metrics can be found in the [Postgre
 ## Configuration
 
 ```toml
+# Read metrics from one or many postgresql servers
 [[inputs.postgresql]]
   ## specify address via a url matching:
   ##   postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]

plugins/inputs/ras/README.md

@@ -7,6 +7,7 @@ The `RAS` plugin gathers and counts errors provided by [RASDaemon](https://githu
 ## Configuration
 
 ```toml
+# RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required).
 [[inputs.ras]]
   ## Optional path to RASDaemon sqlite3 database.
   ## Default: /var/lib/rasdaemon/ras-mc_event.db

plugins/inputs/sflow/README.md

@@ -21,6 +21,7 @@ avoid cardinality issues:
 ## Configuration
 
 ```toml
+# SFlow V5 Protocol Listener
 [[inputs.sflow]]
   ## Address to listen for sFlow packets.
   ##   example: service_address = "udp://:6343"

plugins/inputs/snmp_legacy/README.md

@@ -11,6 +11,7 @@ In this example, the plugin will gather value of OIDS:
 - `.1.3.6.1.2.1.2.2.1.4.1`
 
 ```toml
+# DEPRECATED! PLEASE USE inputs.snmp INSTEAD.
 [[inputs.snmp_legacy]]
   ## Use 'oids.txt' file to translate oids to names
   ## To generate 'oids.txt' you need to run:

plugins/inputs/snmp_trap/README.md

@@ -14,6 +14,7 @@ path onto the global path variable
 ## Configuration
 
 ```toml
+# Receive SNMP traps
 [[inputs.snmp_trap]]
   ## Transport, local address, and port to listen on.  Transport must
   ## be "udp://".  Omit local address to listen on all interfaces.

plugins/inputs/sql/README.md

@@ -11,6 +11,7 @@ This section contains the default TOML to configure the plugin.  You can
 generate it using `telegraf --usage <plugin-name>`.
 
 ```toml
+# Read metrics from SQL queries
 [[inputs.sql]]
   ## Database Driver
   ## See https://github.com/influxdata/telegraf/blob/master/docs/SQL_DRIVERS_INPUT.md for

plugins/inputs/sqlserver/README.md

@@ -89,10 +89,6 @@ Remove User Id and Password keywords from the connection string in your config f
 ## Configuration
 
 ```toml
-[agent]
-  ## Default data collection interval for all inputs, can be changed as per collection interval needs
-  interval = "10s"
-
 # Read metrics from Microsoft SQL Server
 [[inputs.sqlserver]]
   ## Specify instances to monitor with a list of connection strings.

plugins/inputs/suricata/README.md

@@ -9,6 +9,7 @@ It can also report for triggered Suricata IDS/IPS alerts.
 ## Configuration
 
 ```toml
+# Suricata stats and alerts plugin
 [[inputs.suricata]]
   ## Data sink for Suricata stats log.
   # This is expected to be a filename of a

plugins/inputs/tail/README.md

@@ -22,6 +22,7 @@ The plugin expects messages in one of the
 ## Configuration
 
 ```toml
+# Parse the new lines appended to a file
 [[inputs.tail]]
   ## File names or a pattern to tail.
   ## These accept standard unix glob matching rules, but with the addition of

plugins/inputs/webhooks/README.md

@@ -16,6 +16,7 @@ sudo service telegraf start
 ## Configuration
 
 ```toml
+# A Webhooks Event collector
 [[inputs.webhooks]]
   ## Address and port to host Webhook listener on
   service_address = ":1619"

plugins/inputs/win_eventlog/README.md

@@ -11,6 +11,7 @@ Telegraf minimum version: Telegraf 1.16.0
 ### Configuration
 
 ```toml
+# Input plugin to collect Windows Event Log messages
 [[inputs.win_eventlog]]
   ## Telegraf should have Administrator permissions to subscribe for some Windows Events channels
   ## (System log, for example)

plugins/inputs/win_services/README.md

@@ -7,6 +7,7 @@ Monitoring some services may require running Telegraf with administrator privile
 ## Configuration
 
 ```toml
+# Input plugin to report Windows services info.
 [[inputs.win_services]]
   ## Names of the services to monitor. Leave empty to monitor all the available services on the host. Globs accepted. Case sensitive.
   service_names = [