Skip to content

Commit

Permalink
chore: Fix readme linter errors for input plugins A-D (#10964)
Browse files Browse the repository at this point in the history
  • Loading branch information
reimda authored and MyaLongmire committed Jul 6, 2022
1 parent e1fdf6f commit c1915c5
Show file tree
Hide file tree
Showing 40 changed files with 435 additions and 275 deletions.
8 changes: 5 additions & 3 deletions plugins/inputs/activemq/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ActiveMQ Input Plugin

This plugin gather queues, topics & subscribers metrics using ActiveMQ Console API.
This plugin gather queues, topics & subscribers metrics using ActiveMQ Console
API.

## Configuration

Expand Down Expand Up @@ -35,7 +36,8 @@ This plugin gather queues, topics & subscribers metrics using ActiveMQ Console A

## Metrics

Every effort was made to preserve the names based on the XML response from the ActiveMQ Console API.
Every effort was made to preserve the names based on the XML response from the
ActiveMQ Console API.

- activemq_queues
- tags:
Expand Down Expand Up @@ -74,7 +76,7 @@ Every effort was made to preserve the names based on the XML response from the A
- enqueue_counter
- dequeue_counter

### Example Output
## Example Output

```shell
activemq_queues,name=sandra,host=88284b2fe51b,source=localhost,port=8161 consumer_count=0i,enqueue_count=0i,dequeue_count=0i,size=0i 1492610703000000000
Expand Down
22 changes: 14 additions & 8 deletions plugins/inputs/aerospike/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Aerospike Input Plugin

The aerospike plugin queries aerospike server(s) and get node statistics & stats for
all the configured namespaces.
The aerospike plugin queries aerospike server(s) and get node statistics & stats
for all the configured namespaces.

For what the measurements mean, please consult the [Aerospike Metrics Reference Docs](http://www.aerospike.com/docs/reference/metrics).
For what the measurements mean, please consult the [Aerospike Metrics Reference
Docs](http://www.aerospike.com/docs/reference/metrics).

The metric names, to make it less complicated in querying, have replaced all `-` with `_` as Aerospike metrics come in both forms (no idea why).
The metric names, to make it less complicated in querying, have replaced all `-`
with `_` as Aerospike metrics come in both forms (no idea why).

All metrics are attempted to be cast to integers, then booleans, then strings.

Expand Down Expand Up @@ -55,7 +57,7 @@ All metrics are attempted to be cast to integers, then booleans, then strings.
# num_histogram_buckets = 100 # default: 10
```

## Measurements
## Metrics

The aerospike metrics are under a few measurement names:

Expand Down Expand Up @@ -90,8 +92,9 @@ are available from the aerospike `sets/<namespace_name>/<set_name>` command.
...
```

***aerospike_histogram_ttl***: These are aerospike ttl hisogram measurements, which
is available from the aerospike `histogram:namespace=<namespace_name>;[set=<set_name>;]type=ttl` command.
***aerospike_histogram_ttl***: These are aerospike ttl hisogram measurements,
which is available from the aerospike
`histogram:namespace=<namespace_name>;[set=<set_name>;]type=ttl` command.

```text
telnet localhost 3003
Expand All @@ -100,7 +103,10 @@ is available from the aerospike `histogram:namespace=<namespace_name>;[set=<set_
...
```

***aerospike_histogram_object_size_linear***: These are aerospike object size linear histogram measurements, which is available from the aerospike `histogram:namespace=<namespace_name>;[set=<set_name>;]type=object_size_linear` command.
***aerospike_histogram_object_size_linear***: These are aerospike object size
linear histogram measurements, which is available from the aerospike
`histogram:namespace=<namespace_name>;[set=<set_name>;]type=object_size_linear`
command.

```text
telnet localhost 3003
Expand Down
21 changes: 14 additions & 7 deletions plugins/inputs/aliyuncms/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Alibaba (Aliyun) CloudMonitor Service Statistics Input Plugin

Here and after we use `Aliyun` instead `Alibaba` as it is default naming across web console and docs.
Here and after we use `Aliyun` instead `Alibaba` as it is default naming across
web console and docs.

This plugin will pull Metric Statistics from Aliyun CMS.

## Aliyun Authentication

This plugin uses an [AccessKey](https://www.alibabacloud.com/help/doc-detail/53045.htm?spm=a2c63.p38356.b99.127.5cba21fdt5MJKr&parentId=28572) credential for Authentication with the Aliyun OpenAPI endpoint.
In the following order the plugin will attempt to authenticate.
This plugin uses an [AccessKey][1] credential for Authentication with the Aliyun
OpenAPI endpoint. In the following order the plugin will attempt to
authenticate.

1. Ram RoleARN credential if `access_key_id`, `access_key_secret`, `role_arn`, `role_session_name` is specified
2. AccessKey STS token credential if `access_key_id`, `access_key_secret`, `access_key_sts_token` is specified
Expand All @@ -17,6 +19,8 @@ In the following order the plugin will attempt to authenticate.
6. Environment variables credential
7. Instance metadata credential

[1]: https://www.alibabacloud.com/help/doc-detail/53045.htm?spm=a2c63.p38356.b99.127.5cba21fdt5MJKr&parentId=28572

## Configuration

```toml @sample.conf
Expand Down Expand Up @@ -124,18 +128,21 @@ In the following order the plugin will attempt to authenticate.

### Requirements and Terminology

Plugin Configuration utilizes [preset metric items references](https://www.alibabacloud.com/help/doc-detail/28619.htm?spm=a2c63.p38356.a3.2.389f233d0kPJn0)
Plugin Configuration utilizes [preset metric items references][2]

- `discovery_region` must be a valid Aliyun [Region](https://www.alibabacloud.com/help/doc-detail/40654.htm) value
- `period` must be a valid duration value
- `project` must be a preset project value
- `names` must be preset metric names
- `dimensions` must be preset dimension values

## Measurements & Fields
[2]: https://www.alibabacloud.com/help/doc-detail/28619.htm?spm=a2c63.p38356.a3.2.389f233d0kPJn0

## Metrics

Each Aliyun CMS Project monitored records a measurement with fields for each available Metric Statistic
Project and Metrics are represented in [snake case](https://en.wikipedia.org/wiki/Snake_case)
Each Aliyun CMS Project monitored records a measurement with fields for each
available Metric Statistic Project and Metrics are represented in [snake
case](https://en.wikipedia.org/wiki/Snake_case)

- aliyuncms_{project}
- {metric}_average (metric Average value)
Expand Down
22 changes: 15 additions & 7 deletions plugins/inputs/amd_rocm_smi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# AMD ROCm System Management Interface (SMI) Input Plugin

This plugin uses a query on the [`rocm-smi`](https://github.com/RadeonOpenCompute/rocm_smi_lib/tree/master/python_smi_tools) binary to pull GPU stats including memory and GPU usage, temperatures and other.
This plugin uses a query on the [`rocm-smi`][1] binary to pull GPU stats
including memory and GPU usage, temperatures and other.

[1]: https://github.com/RadeonOpenCompute/rocm_smi_lib/tree/master/python_smi_tools

## Configuration

Expand Down Expand Up @@ -47,20 +50,25 @@ Linux:
rocm-smi rocm-smi -o -l -m -M -g -c -t -u -i -f -p -P -s -S -v --showreplaycount --showpids --showdriverversion --showmemvendor --showfwinfo --showproductname --showserial --showuniqueid --showbus --showpendingpages --showpagesinfo --showretiredpages --showunreservablepages --showmemuse --showvoltage --showtopo --showtopoweight --showtopohops --showtopotype --showtoponuma --showmeminfo all --json
```

Please include the output of this command if opening a GitHub issue, together with ROCm version.
Please include the output of this command if opening a GitHub issue, together
with ROCm version.

### Example Output
## Example Output

```shell
amd_rocm_smi,gpu_id=0x6861,gpu_unique_id=0x2150e7d042a1124,host=ali47xl,name=card0 clocks_current_memory=167i,clocks_current_sm=852i,driver_version=51114i,fan_speed=14i,memory_free=17145282560i,memory_total=17163091968i,memory_used=17809408i,power_draw=7,temperature_sensor_edge=28,temperature_sensor_junction=29,temperature_sensor_memory=92,utilization_gpu=0i 1630572551000000000
amd_rocm_smi,gpu_id=0x6861,gpu_unique_id=0x2150e7d042a1124,host=ali47xl,name=card0 clocks_current_memory=167i,clocks_current_sm=852i,driver_version=51114i,fan_speed=14i,memory_free=17145282560i,memory_total=17163091968i,memory_used=17809408i,power_draw=7,temperature_sensor_edge=29,temperature_sensor_junction=30,temperature_sensor_memory=91,utilization_gpu=0i 1630572701000000000
amd_rocm_smi,gpu_id=0x6861,gpu_unique_id=0x2150e7d042a1124,host=ali47xl,name=card0 clocks_current_memory=167i,clocks_current_sm=852i,driver_version=51114i,fan_speed=14i,memory_free=17145282560i,memory_total=17163091968i,memory_used=17809408i,power_draw=7,temperature_sensor_edge=29,temperature_sensor_junction=29,temperature_sensor_memory=92,utilization_gpu=0i 1630572749000000000
```

### Limitations and notices
## Limitations and notices

Please notice that this plugin has been developed and tested on a limited number of versions and small set of GPUs. Currently the latest ROCm version tested is 4.3.0.
Notice that depending on the device and driver versions the amount of information provided by `rocm-smi` can vary so that some fields would start/stop appearing in the metrics upon updates.
The `rocm-smi` JSON output is not perfectly homogeneous and is possibly changing in the future, hence parsing and unmarshaling can start failing upon updating ROCm.
Please notice that this plugin has been developed and tested on a limited number
of versions and small set of GPUs. Currently the latest ROCm version tested is
4.3.0. Notice that depending on the device and driver versions the amount of
information provided by `rocm-smi` can vary so that some fields would start/stop
appearing in the metrics upon updates. The `rocm-smi` JSON output is not
perfectly homogeneous and is possibly changing in the future, hence parsing and
unmarshaling can start failing upon updating ROCm.

Inspired by the current state of the art of the `nvidia-smi` plugin.
11 changes: 6 additions & 5 deletions plugins/inputs/amqp_consumer/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# AMQP Consumer Input Plugin

This plugin provides a consumer for use with AMQP 0-9-1, a prominent implementation of this protocol being [RabbitMQ](https://www.rabbitmq.com/).
This plugin provides a consumer for use with AMQP 0-9-1, a prominent
implementation of this protocol being [RabbitMQ](https://www.rabbitmq.com/).

Metrics are read from a topic exchange using the configured queue and binding_key.
Metrics are read from a topic exchange using the configured queue and
binding_key.

Message payload should be formatted in one of the [Telegraf Data Formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md).
Message payload should be formatted in one of the [Telegraf Data
Formats](../../../docs/DATA_FORMATS_INPUT.md).

For an introduction to AMQP see:

Expand All @@ -13,8 +16,6 @@ For an introduction to AMQP see:

## Configuration

The following defaults are known to work with RabbitMQ:

```toml @sample.conf
# AMQP consumer plugin
[[inputs.amqp_consumer]]
Expand Down
16 changes: 12 additions & 4 deletions plugins/inputs/apache/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Apache Input Plugin

The Apache plugin collects server performance information using the [`mod_status`](https://httpd.apache.org/docs/2.4/mod/mod_status.html) module of the [Apache HTTP Server](https://httpd.apache.org/).
The Apache plugin collects server performance information using the
[`mod_status`](https://httpd.apache.org/docs/2.4/mod/mod_status.html) module of
the [Apache HTTP Server](https://httpd.apache.org/).

Typically, the `mod_status` module is configured to expose a page at the `/server-status?auto` location of the Apache server. The [ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/core.html#extendedstatus) option must be enabled in order to collect all available fields. For information about how to configure your server reference the [module documentation](https://httpd.apache.org/docs/2.4/mod/mod_status.html#enable).
Typically, the `mod_status` module is configured to expose a page at the
`/server-status?auto` location of the Apache server. The
[ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/core.html#extendedstatus)
option must be enabled in order to collect all available fields. For
information about how to configure your server reference the [module
documentation](https://httpd.apache.org/docs/2.4/mod/mod_status.html#enable).

## Configuration

Expand All @@ -29,7 +36,7 @@ Typically, the `mod_status` module is configured to expose a page at the `/serve
# insecure_skip_verify = false
```

## Measurements & Fields
## Metrics

- apache
- BusyWorkers (float)
Expand All @@ -56,7 +63,8 @@ Typically, the `mod_status` module is configured to expose a page at the `/serve
- TotalkBytes (float)
- Uptime (float)

The following fields are collected from the `Scoreboard`, and represent the number of requests in the given state:
The following fields are collected from the `Scoreboard`, and represent the
number of requests in the given state:

- apache
- scboard_closing (float)
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/apcupsd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ apcupsd should be installed and it's daemon should be running.
- nominal_power
- firmware

## Example output
## Example Output

```shell
apcupsd,serial=AS1231515,status=ONLINE,ups_name=name1 time_on_battery=0,load_percent=9.7,time_left_minutes=98,output_voltage=230.4,internal_temp=32.4,battery_voltage=27.4,input_frequency=50.2,input_voltage=230.4,battery_charge_percent=100,status_flags=8i 1490035922000000000
Expand Down
6 changes: 4 additions & 2 deletions plugins/inputs/aurora/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Aurora Input Plugin

The Aurora Input Plugin gathers metrics from [Apache Aurora](https://aurora.apache.org/) schedulers.
The Aurora Input Plugin gathers metrics from [Apache
Aurora](https://aurora.apache.org/) schedulers.

For monitoring recommendations reference [Monitoring your Aurora cluster](https://aurora.apache.org/documentation/latest/operations/monitoring/)
For monitoring recommendations reference [Monitoring your Aurora
cluster](https://aurora.apache.org/documentation/latest/operations/monitoring/)

## Configuration

Expand Down
8 changes: 2 additions & 6 deletions plugins/inputs/bcache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Get bcache stat from stats_total directory and dirty_data file.

## Measurements
## Metrics

Meta:

Expand Down Expand Up @@ -53,8 +53,6 @@ cache_readaheads

## Configuration

Using this configuration:

```toml @sample.conf
# Read metrics of bcache from stats_total and dirty_data
[[inputs.bcache]]
Expand All @@ -68,14 +66,12 @@ Using this configuration:
bcacheDevs = ["bcache0"]
```

When run with:
## Example Output

```shell
./telegraf --config telegraf.conf --input-filter bcache --test
```

It produces:

```shell
* Plugin: bcache, Collection 1
> [backing_dev="md10" bcache_dev="bcache0"] bcache_dirty_data value=11639194
Expand Down
9 changes: 6 additions & 3 deletions plugins/inputs/beanstalkd/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Beanstalkd Input Plugin

The `beanstalkd` plugin collects server stats as well as tube stats (reported by `stats` and `stats-tube` commands respectively).
The `beanstalkd` plugin collects server stats as well as tube stats (reported by
`stats` and `stats-tube` commands respectively).

## Configuration

Expand All @@ -17,7 +18,9 @@ The `beanstalkd` plugin collects server stats as well as tube stats (reported by

## Metrics

Please see the [Beanstalk Protocol doc](https://raw.githubusercontent.com/kr/beanstalkd/master/doc/protocol.txt) for detailed explanation of `stats` and `stats-tube` commands output.
Please see the [Beanstalk Protocol
doc](https://raw.githubusercontent.com/kr/beanstalkd/master/doc/protocol.txt)
for detailed explanation of `stats` and `stats-tube` commands output.

`beanstalkd_overview` – statistical information about the system as a whole

Expand Down Expand Up @@ -93,7 +96,7 @@ Please see the [Beanstalk Protocol doc](https://raw.githubusercontent.com/kr/bea
- server (address taken from config)
- version

## Example
## Example Output

```shell
beanstalkd_overview,host=server.local,hostname=a2ab22ed12e0,id=232485800aa11b24,server=localhost:11300,version=1.10 cmd_stats_tube=29482i,current_jobs_delayed=0i,current_jobs_urgent=6i,cmd_kick=0i,cmd_stats=7378i,cmd_stats_job=0i,current_waiting=0i,max_job_size=65535i,pid=6i,cmd_bury=0i,cmd_reserve_with_timeout=0i,cmd_touch=0i,current_connections=1i,current_jobs_ready=6i,current_producers=0i,cmd_delete=0i,cmd_list_tubes=7369i,cmd_peek_ready=0i,cmd_put=6i,cmd_use=3i,cmd_watch=0i,current_jobs_reserved=0i,rusage_stime=6.07,cmd_list_tubes_watched=0i,cmd_pause_tube=0i,total_jobs=6i,binlog_records_migrated=0i,cmd_list_tube_used=0i,cmd_peek_delayed=0i,cmd_release=0i,current_jobs_buried=0i,job_timeouts=0i,binlog_current_index=0i,binlog_max_size=10485760i,total_connections=7378i,cmd_peek_buried=0i,cmd_reserve=0i,current_tubes=4i,binlog_records_written=0i,cmd_peek=0i,rusage_utime=1.13,uptime=7099i,binlog_oldest_index=0i,current_workers=0i,cmd_ignore=0i 1528801650000000000
Expand Down
4 changes: 2 additions & 2 deletions plugins/inputs/beat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ known to work with Filebeat and Kafkabeat.
# insecure_skip_verify = false
```

## Measurements & Fields
## Metrics

- **beat**
- Fields:
Expand Down Expand Up @@ -135,7 +135,7 @@ known to work with Filebeat and Kafkabeat.
- beat_name
- beat_version

## Example
## Example Output

```shell
$ telegraf --input-filter beat --test
Expand Down
Loading

0 comments on commit c1915c5

Please sign in to comment.