docs: Update all readme to pass linter (#12615)

plugins/inputs/burrow/README.md

@@ -112,3 +112,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   * cluster (string)
   * topic (string)
   * partition (int)
+
+## Example Output

plugins/inputs/cgroup/README.md

@@ -83,3 +83,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # ]
   # files = ["*"]
 ```
+
+## Example Output

plugins/inputs/cloud_pubsub/README.md

@@ -104,3 +104,7 @@ subscriptions/topics.
 [pubsub]: https://cloud.google.com/pubsub
 [pubsub create sub]: https://cloud.google.com/pubsub/docs/admin#create_a_pull_subscription
 [input data formats]: /docs/DATA_FORMATS_INPUT.md
+
+## Metrics
+
+## Example Output

plugins/inputs/cloud_pubsub_push/README.md

@@ -82,3 +82,7 @@ This plugin assumes you have already created a PUSH subscription for a given
 PubSub topic.
 
 [pubsub]: https://cloud.google.com/pubsub
+
+## Metrics
+
+## Example Output

plugins/inputs/consul_agent/README.md

@@ -45,3 +45,5 @@ Consul collects various metrics. For every details, please have a look at Consul
 following documentation:
 
 - [https://www.consul.io/api/agent#view-metrics](https://www.consul.io/api/agent#view-metrics)
+
+## Example Output

plugins/inputs/csgo/README.md

@@ -47,3 +47,5 @@ If no servers are specified, no data will be collected
     - sv_ms (float)
     - variance_ms (float)
     - tick_ms (float)
+
+## Example Output

plugins/inputs/disque/README.md

@@ -45,3 +45,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
     - used_cpu_user_children
     - registered_jobs
     - registered_queues
+
+## Example Output

plugins/inputs/ecs/README.md

@@ -229,7 +229,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
     - started_at
     - type
 
-## Example
+## Example Output
 
 ```shell
 ecs_task,cluster=test,family=nginx,host=c4b301d4a123,revision=2,task_arn=arn:aws:ecs:aws-region-1:012345678901:task/a1234abc-a0a0-0a01-ab01-0abc012a0a0a desired_status="RUNNING",known_status="RUNNING",limit_cpu=0.5,limit_mem=512 1542641488000000000

plugins/inputs/elasticsearch/README.md

@@ -879,3 +879,5 @@ Emitted when the appropriate `shards_stats` options are set.
     - warmer_current (float)
     - warmer_total (float)
     - warmer_total_time_in_millis (float)
+
+## Example Output

plugins/inputs/elasticsearch_query/README.md

@@ -193,3 +193,7 @@ of the examples below.
 
 [joda]: https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern
 [agg]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics.html
+
+## Metrics
+
+## Example Output

plugins/inputs/eventhub_consumer/README.md

@@ -116,3 +116,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 [Full documentation of the available environment variables][envvar].
 
 [envvar]: https://github.com/Azure/azure-event-hubs-go#environment-variables
+
+## Metrics
+
+## Example Output

plugins/inputs/exec/README.md

@@ -86,3 +86,7 @@ available for output:
 ```shell
 $host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50)
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/execd/README.md

@@ -136,3 +136,7 @@ end
 
 [Input Data Formats]: ../../../docs/DATA_FORMATS_INPUT.md
 [inputs.exec]: ../exec/README.md
+
+## Metrics
+
+## Example Output

plugins/inputs/file/README.md

@@ -54,3 +54,5 @@ format of the file.
 
 [input data format]: /docs/DATA_FORMATS_INPUT.md
 [tail]: /plugins/inputs/tail
+
+## Example Output

plugins/inputs/filestat/README.md

@@ -25,7 +25,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   md5 = false
 ```
 
-## Measurements & Fields
+## Metrics
+
+### Measurements & Fields
 
 - filestat
   - exists (int, 0 | 1)
@@ -33,12 +35,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   - modification_time (int, unix time nanoseconds)
   - md5 (optional, string)
 
-## Tags
+### Tags
 
 - All measurements have the following tags:
   - file (the path the to file, as specified in the config)
 
-### Example
+## Example Output
 
 ```shell
 $ telegraf --config /etc/telegraf/telegraf.conf --input-filter filestat --test

plugins/inputs/fireboard/README.md

@@ -59,7 +59,7 @@ values are included if they are less than a minute old.
   - fields:
     - temperature (float, unit)
 
-## Example
+## Example Output
 
 This section shows example output in Line Protocol format.  You can often use
 `telegraf --input-filter <plugin-name> --test` or use the `file` output to get

plugins/inputs/fluentd/README.md

@@ -51,7 +51,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   ]
 ```
 
-## Measurements & Fields
+## Metrics
+
+### Measurements & Fields
 
 Fields may vary depending on the plugin type
 
@@ -71,7 +73,7 @@ Fields may vary depending on the plugin type
   - buffer_stage_byte_size   (float, unit)
   - buffer_available_buffer_space_ratios (float, unit)
 
-## Tags
+### Tags
 
 - All measurements have the following tags:
   - plugin_id        (unique plugin id)

plugins/inputs/graylog/README.md

@@ -67,3 +67,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 Please refer to GrayLog metrics api browser for full metric end points:
 `http://host:9000/api/api-browser`
+
+## Metrics
+
+## Example Output

plugins/inputs/hddtemp/README.md

@@ -41,7 +41,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   - fields:
     - temperature
 
-## Example output
+## Example Output
 
 ```shell
 hddtemp,source=server1,unit=C,status=,device=sdb,model=WDC\ WD740GD-00FLA1 temperature=43i 1481655647000000000

plugins/inputs/httpjson/README.md

@@ -65,7 +65,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   #   apiVersion = "v1"
 ```
 
-## Measurements & Fields
+## Metrics
+
+### Measurements & Fields
 
 - httpjson
   - response_time (float): Response time in seconds
@@ -73,7 +75,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 Additional fields are dependant on the response of the remote service being
 polled.
 
-## Tags
+### Tags
 
 - All measurements have the following tags:
   - server: HTTP origin as defined in configuration as `servers`.
@@ -83,7 +85,7 @@ tags.  Top level keys are defined as keys in the root level of the object in a
 single object response, or in the root level of each object within an array of
 objects.
 
-## Examples Output
+## Example Output
 
 This plugin understands responses containing a single JSON object, or a JSON
 Array of Objects.

plugins/inputs/hugepages/README.md

@@ -31,7 +31,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # types = ["root", "per_node"]
 ```
 
-## Measurements
+## Metrics
+
+### Measurements
 
 **The following measurements are supported by Hugepages plugin:**
 

plugins/inputs/influxdb_listener/README.md

@@ -93,3 +93,5 @@ curl -i -XPOST 'http://localhost:8186/write' --data-binary 'cpu_load_short,host=
 
 [influxdb_http_api]: https://docs.influxdata.com/influxdb/v1.8/guides/write_data/
 [http_listener_v2]: /plugins/inputs/http_listener_v2/README.md
+
+## Example Output

plugins/inputs/influxdb_v2_listener/README.md

@@ -70,3 +70,5 @@ curl -i -XPOST 'http://localhost:8186/api/v2/write' --data-binary 'cpu_load_shor
 ```
 
 [influxdb_http_api]: https://docs.influxdata.com/influxdb/latest/api/
+
+## Example Output

plugins/inputs/intel_pmu/README.md

@@ -201,7 +201,7 @@ On each Telegraf interval, Intel PMU plugin transmits following data:
 | unit      | name of event-capable PMU that the event was counted for, as listed in /sys/bus/event_source/devices/ e.g. uncore_cbox_1, uncore_imc_1 etc.  Present for non-aggregated uncore events only |
 | events_tag| (optional) tag as defined in "intel_pmu.uncore_events" configuration element                           |
 
-## Example outputs
+## Example Output
 
 Event group:
 

plugins/inputs/intel_rdt/README.md

@@ -133,7 +133,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # use_sudo = false
 ```
 
-## Exposed metrics
+## Metrics
 
 | Name          | Full name                                     | Description |
 |---------------|-----------------------------------------------|-------------|

plugins/inputs/ipmi_sensor/README.md

@@ -87,7 +87,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # cache_path = ""
 ```
 
-## Measurements
+## Metrics
 
 Version 1 schema:
 

plugins/inputs/ipset/README.md

@@ -70,6 +70,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```
 
+## Metrics
+
 ## Example Output
 
 ```sh

plugins/inputs/iptables/README.md

@@ -97,13 +97,15 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   chains = [ "INPUT" ]
 ```
 
-## Measurements & Fields
+## Metrics
+
+### Measurements & Fields
 
 * iptables
   * pkts (integer, count)
   * bytes (integer, bytes)
 
-## Tags
+### Tags
 
 * All measurements have the following tags:
   * table

plugins/inputs/jolokia/README.md

@@ -76,9 +76,11 @@ The Jolokia plugin collects JVM metrics exposed as MBean's attributes through
 jolokia REST endpoint. All metrics are collected for each server configured.
 See [official Jolokia website](https://jolokia.org/) for more information.
 
-## Measurements
+## Metrics
 
 Jolokia plugin produces one measure for each metric configured,
 adding Server's `jolokia_name`, `jolokia_host` and `jolokia_port` as tags.
 
 [jolokia2]: /plugins/inputs/jolokia2
+
+## Example Output

plugins/inputs/kafka_consumer_legacy/README.md

@@ -55,3 +55,7 @@ Running integration tests requires running Zookeeper & Kafka. See Makefile
 for kafka container command.
 
 [Kafka Consumer input plugin]: ../kafka_consumer/README.md
+
+## Metrics
+
+## Example Output

plugins/inputs/kapacitor/README.md

@@ -33,7 +33,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # insecure_skip_verify = false
 ```
 
-## Measurements and fields
+## Metrics
+
+### Measurements and fields
 
 - [kapacitor](#kapacitor)
   - [num_enabled_tasks](#num_enabled_tasks) _(integer)_

plugins/inputs/kernel/README.md

@@ -57,7 +57,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # no configuration
 ```
 
-## Measurements & Fields
+## Metrics
 
 - kernel
   - boot_time (integer, seconds since epoch, `btime`)
@@ -68,10 +68,6 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   - processes_forked (integer, `processes`)
   - entropy_avail (integer, `entropy_available`)
 
-## Tags
-
-None
-
 ## Example Output
 
 ```shell

plugins/inputs/kernel_vmstat/README.md

@@ -128,7 +128,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # no configuration
 ```
 
-## Measurements & Fields
+## Metrics
 
 - kernel_vmstat
   - nr_free_pages (integer, `nr_free_pages`)
@@ -223,10 +223,6 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   - thp_collapse_alloc_failed (integer, `thp_collapse_alloc_failed`)
   - thp_split (integer, `thp_split`)
 
-## Tags
-
-None
-
 ## Example Output
 
 ```shell

plugins/inputs/kinesis_consumer/README.md

@@ -108,3 +108,7 @@ Sort key: shard_id
 
 [kinesis]: https://aws.amazon.com/kinesis/
 [input data formats]: /docs/DATA_FORMATS_INPUT.md
+
+## Metrics
+
+## Example Output

plugins/inputs/lanz/README.md

@@ -91,7 +91,7 @@ Get the max buffer_size for over the last hour for all switches.
 SELECT max("buffer_size") AS "max_buffer_size" FROM "global_buffer_usage_record" WHERE time > now() - 1h GROUP BY time(10s), "hostname"
 ```
 
-## Example output
+## Example Output
 
 ```shell
 lanz_global_buffer_usage_record,entry_type=2,host=telegraf.int.example.com,port=50001,source=switch01.int.example.com timestamp=158334105824919i,buffer_size=505i,duration=0i 1583341058300643815

plugins/inputs/leofs/README.md

@@ -23,7 +23,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   servers = ["127.0.0.1:4010"]
 ```
 
-## Measurements & Fields
+## Metrics
 
 ### Statistics specific to the internals of LeoManager
 
@@ -162,9 +162,9 @@ All measurements have the following tags:
 
 - node
 
-### Example output
+## Example Output
 
-#### LeoManager
+### LeoManager
 
 ```bash
 $ ./telegraf --config ./plugins/inputs/leofs/leo_manager.conf --input-filter leofs --test
@@ -186,7 +186,7 @@ $ ./telegraf --config ./plugins/inputs/leofs/leo_manager.conf --input-filter leo
   1524105758000000000
 ```
 
-#### LeoStorage
+### LeoStorage
 
 ```bash
 $ ./telegraf --config ./plugins/inputs/leofs/leo_storage.conf --input-filter leofs --test
@@ -233,7 +233,7 @@ $ ./telegraf --config ./plugins/inputs/leofs/leo_storage.conf --input-filter leo
   1524529826000000000
 ```
 
-#### LeoGateway
+### LeoGateway
 
 ```shell
 $ ./telegraf --config ./plugins/inputs/leofs/leo_gateway.conf --input-filter leofs --test

plugins/inputs/linux_sysctl_fs/README.md

@@ -26,3 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 [[inputs.linux_sysctl_fs]]
   # no configuration
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/logparser/README.md

@@ -123,3 +123,7 @@ configuration.
 
 [tail]: /plugins/inputs/tail/README.md
 [grok parser]: /plugins/parsers/grok/README.md
+
+## Metrics
+
+## Example Output

plugins/inputs/mailchimp/README.md

@@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
     - list_stats_unsub_rate (double, percentage)
     - list_stats_open_rate (double, percentage)
     - list_stats_click_rate (double, percentage)
+
+## Example Output

plugins/inputs/mock/README.md

@@ -67,6 +67,10 @@ The available algorithms for generating mock data include:
 * Step - always add the step value, negative values accepted
 * Stock - generate fake, stock-like price values based on a volatility variable
 
+## Metrics
+
+Metrics are entirely based on the user's own configuration and settings.
+
 ## Example Output
 
 The following example shows all available algorithms configured with an

plugins/inputs/multifile/README.md

@@ -45,6 +45,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
     conversion = "float(3)"
 ```
 
+## Metrics
+
 Each file table can contain the following options:
 
 * `file`:

plugins/inputs/mysql/README.md

@@ -384,3 +384,5 @@ The unit of fields varies by the tags.
   * engine
   * row_format
   * create_options
+
+## Example Output

plugins/inputs/nginx/README.md

@@ -34,7 +34,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   response_timeout = "5s"
 ```
 
-## Measurements & Fields
+## Metrics
 
 - Measurement
   - accepts

plugins/inputs/nomad/README.md

@@ -39,3 +39,5 @@ have a look at Nomad following documentation:
 
 - [https://www.nomadproject.io/docs/operations/metrics](https://www.nomadproject.io/docs/operations/metrics)
 - [https://www.nomadproject.io/docs/operations/telemetry](https://www.nomadproject.io/docs/operations/telemetry)
+
+## Example Output

plugins/inputs/nsd/README.md

@@ -186,3 +186,5 @@ dots in the nsd-control stat name are replaced by underscores (see
     - server
   - fields:
     - queries
+
+## Example Output

plugins/inputs/nsq/README.md

@@ -29,3 +29,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   ## Use TLS but skip chain & host verification
   # insecure_skip_verify = false
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/nsq_consumer/README.md

@@ -48,3 +48,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 [nsq]: https://nsq.io
 [input data formats]: /docs/DATA_FORMATS_INPUT.md
+
+## Metrics
+
+## Example Output

plugins/inputs/nstat/README.md

@@ -360,3 +360,5 @@ error would be raised.
 * All measurements have the following tags
   * host (host of the system)
   * name (the type of the metric: snmp, snmp6 or netstat)
+
+## Example Output

plugins/inputs/powerdns/README.md

@@ -34,7 +34,7 @@ On many systems this can be accomplished by adding the `telegraf` user to the
 usermod telegraf -a -G pdns
 ```
 
-## Measurements & Fields
+## Metrics
 
 - powerdns
   - corrupt-packets

plugins/inputs/puppetagent/README.md

@@ -95,7 +95,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   location = "/var/lib/puppet/state/last_run_summary.yaml"
 ```
 
-## Measurements
+## Metrics
 
 ### PuppetAgent int64 measurements
 
@@ -164,3 +164,5 @@ Meta:
 Measurement names:
 
 - puppetagent_version_puppet
+
+## Example Output

plugins/inputs/rethinkdb/README.md

@@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
     - total_reads (integer, reads)
     - written_docs_per_sec (integer, writes)
     - total_writes (integer, writes)
+
+## Example Output

plugins/inputs/riemann_listener/README.md

@@ -50,3 +50,7 @@ configuration above.
 Riemann `Service` is mapped as `measurement`. `metric` and `TTL` are converted
 into field values.  As Riemann tags as simply an array, they are converted into
 the `influx_line` format key-value, where both key and value are the tags.
+
+## Metrics
+
+## Example Output

plugins/inputs/solr/README.md

@@ -36,7 +36,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # password = "pa$$word"
 ```
 
-## Example output of gathered metrics
+## Metrics
+
+## Example Output
 
 ```shell
 ➜  ~ telegraf -config telegraf.conf -input-filter solr -test

plugins/inputs/statsd/README.md

@@ -276,3 +276,5 @@ mem.cached.localhost:256|g
 
 Consult the [Template Patterns](/docs/TEMPLATE_PATTERN.md) documentation for
 additional details.
+
+## Example Output

plugins/inputs/tcp_listener/README.md

@@ -20,3 +20,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   # socket_listener plugin
   # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/twemproxy/README.md

@@ -22,3 +22,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
   ## Monitor pool name
   pools = ["redis_pool", "mc_pool"]
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/udp_listener/README.md

@@ -19,3 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 [[inputs.udp_listener]]
   # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener
 ```
+
+## Metrics
+
+## Example Output

plugins/inputs/vault/README.md

@@ -46,3 +46,5 @@ following Vault documentation:
 
 - [https://www.vaultproject.io/docs/internals/telemetry](https://www.vaultproject.io/docs/internals/telemetry)
 - [https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring](https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring)
+
+## Example Output

plugins/inputs/webhooks/README.md

@@ -96,3 +96,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 1. Import your plugin in the `webhooks.go` file and add it to the `Webhooks` struct
 
 Both [Github](github/) and [Rollbar](rollbar/) are good example to follow.
+
+## Metrics
+
+## Example Output

plugins/inputs/zipkin/README.md

@@ -195,3 +195,5 @@ influxDB engine][1].
   ]
 }
 ```
+
+## Example Output