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

chore: Fix readme linter errors for input plugins M-Z #11274

Merged
merged 4 commits into from
Jun 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
7 changes: 3 additions & 4 deletions plugins/inputs/mailchimp/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Mailchimp Input Plugin

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

## Configuration
[1]: https://developer.mailchimp.com/

This section contains the default TOML to configure the plugin. You can
generate it using `telegraf --usage mailchimp`.
## Configuration

```toml @sample.conf
# Gathers metrics from the /3.0/reports MailChimp API
Expand Down
3 changes: 2 additions & 1 deletion plugins/inputs/marklogic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MarkLogic Input Plugin

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

## Configuration

Expand Down
5 changes: 3 additions & 2 deletions plugins/inputs/mcrouter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ This plugin gathers statistics data from a Mcrouter server.
# timeout = "5s"
```

## Measurements & Fields
## Metrics

The fields from this plugin are gathered in the *mcrouter* measurement.

Description of gathered fields can be found [here](https://github.com/facebook/mcrouter/wiki/Stats-list).
Description of gathered fields can be found
[here](https://github.com/facebook/mcrouter/wiki/Stats-list).

Fields:

Expand Down
19 changes: 12 additions & 7 deletions plugins/inputs/mdstat/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# mdstat Input Plugin

The mdstat plugin gathers statistics about any Linux MD RAID arrays configured on the host
by reading /proc/mdstat. For a full list of available fields see the
/proc/mdstat section of the [proc man page](http://man7.org/linux/man-pages/man5/proc.5.html).
For a better idea of what each field represents, see the
[mdstat man page](https://raid.wiki.kernel.org/index.php/Mdstat).
The mdstat plugin gathers statistics about any Linux MD RAID arrays configured
on the host by reading /proc/mdstat. For a full list of available fields see the
/proc/mdstat section of the [proc man page][man-proc]. For a better idea of
what each field represents, see the [mdstat man page][man-mdstat].

Stat collection based on Prometheus' mdstat collection library at <https://github.com/prometheus/procfs/blob/master/mdstat.go>
Stat collection based on Prometheus' [mdstat collection library][prom-lib].

[man-proc]: http://man7.org/linux/man-pages/man5/proc.5.html

[man-mdstat]: https://raid.wiki.kernel.org/index.php/Mdstat

[prom-lib]: https://github.com/prometheus/procfs/blob/master/mdstat.go

## Configuration

Expand All @@ -18,7 +23,7 @@ Stat collection based on Prometheus' mdstat collection library at <https://githu
# file_name = "/proc/mdstat"
```

## Measurements & Fields
## Metrics

- mdstat
- BlocksSynced (if the array is rebuilding/checking, this is the count of blocks that have been scanned)
Expand Down
10 changes: 7 additions & 3 deletions plugins/inputs/memcached/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This plugin gathers statistics data from a Memcached server.
# insecure_skip_verify = true
```

## Measurements & Fields
## Metrics

The fields from this plugin are gathered in the *memcached* measurement.

Expand Down Expand Up @@ -76,7 +76,9 @@ Fields:
* touch_misses - Number of items that have been touched and not found
* uptime - Number of secs since the server started

Description of gathered fields taken from [here](https://github.com/memcached/memcached/blob/master/doc/protocol.txt).
Description of gathered fields taken from [memcached protocol docs][protocol].

[protocol]: https://github.com/memcached/memcached/blob/master/doc/protocol.txt

## Tags

Expand All @@ -85,7 +87,9 @@ Description of gathered fields taken from [here](https://github.com/memcached/me

## Sample Queries

You can use the following query to get the average get hit and miss ratio, as well as the total average size of cached items, number of cached items and average connection counts per server.
You can use the following query to get the average get hit and miss ratio, as
well as the total average size of cached items, number of cached items and
average connection counts per server.

```sql
SELECT mean(get_hits) / mean(cmd_get) as get_ratio, mean(get_misses) / mean(cmd_get) as get_misses_ratio, mean(bytes), mean(curr_items), mean(curr_connections) FROM memcached WHERE time > now() - 1h GROUP BY server
Expand Down
14 changes: 9 additions & 5 deletions plugins/inputs/mesos/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Mesos Input Plugin

This input plugin gathers metrics from Mesos.
For more information, please check the [Mesos Observability Metrics](http://mesos.apache.org/documentation/latest/monitoring/) page.
This input plugin gathers metrics from Mesos. For more information, please
check the [Mesos Observability Metrics][1] page.

[1]: http://mesos.apache.org/documentation/latest/monitoring/

## Configuration

Expand Down Expand Up @@ -50,10 +52,12 @@ For more information, please check the [Mesos Observability Metrics](http://meso
# insecure_skip_verify = false
```

By default this plugin is not configured to gather metrics from mesos. Since a mesos cluster can be deployed in numerous ways it does not provide any default
values. User needs to specify master/slave nodes this plugin will gather metrics from.
By default this plugin is not configured to gather metrics from mesos. Since a
mesos cluster can be deployed in numerous ways it does not provide any default
values. User needs to specify master/slave nodes this plugin will gather metrics
from.

## Measurements & Fields
## Metrics

Mesos master metric groups

Expand Down
14 changes: 6 additions & 8 deletions plugins/inputs/mock/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mock Data
# Mock Data Input Plugin

The mock input plugin generates random data based on a selection of different
algorithms. For example, it can produce random data between a set of values,
Expand All @@ -9,13 +9,6 @@ required to mock their situation.

## Configuration

The mock plugin only requires that:

1) Metric name is set
2) One of the below data field algorithms is defined

Below is a sample config to generate one of each of the four types:

```toml @sample.conf
# Generate metrics for test and demonstration purposes
[[inputs.mock]]
Expand Down Expand Up @@ -49,6 +42,11 @@ Below is a sample config to generate one of each of the four types:
## volatility = 0.2
```

The mock plugin only requires that:

1) Metric name is set
2) One of the data field algorithms is defined

## Available Algorithms

The available algorithms for generating mock data include:
Expand Down
Loading