Skip to content

Commit

Permalink
chore: clean up all markdown lint errors for input plugins i through m (
Browse files Browse the repository at this point in the history
  • Loading branch information
MyaLongmire authored Nov 24, 2021
1 parent de6c2f7 commit 8456287
Show file tree
Hide file tree
Showing 47 changed files with 1,172 additions and 1,030 deletions.
30 changes: 15 additions & 15 deletions plugins/inputs/icinga2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The icinga2 plugin uses the icinga2 remote API to gather status on running
services and hosts. You can read Icinga2's documentation for their remote API
[here](https://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/icinga2-api)

### Configuration:
## Configuration

```toml
# Description
Expand All @@ -32,24 +32,24 @@ services and hosts. You can read Icinga2's documentation for their remote API
# insecure_skip_verify = true
```

### Measurements & Fields:
## Measurements & Fields

- All measurements have the following fields:
- name (string)
- state_code (int)
- name (string)
- state_code (int)

### Tags:
## Tags

- All measurements have the following tags:
- check_command - The short name of the check command
- display_name - The name of the service or host
- state - The state: UP/DOWN for hosts, OK/WARNING/CRITICAL/UNKNOWN for services
- source - The icinga2 host
- port - The icinga2 port
- scheme - The icinga2 protocol (http/https)
- server - The server the check_command is running for
- check_command - The short name of the check command
- display_name - The name of the service or host
- state - The state: UP/DOWN for hosts, OK/WARNING/CRITICAL/UNKNOWN for services
- source - The icinga2 host
- port - The icinga2 port
- scheme - The icinga2 protocol (http/https)
- server - The server the check_command is running for

### Sample Queries:
## Sample Queries

```sql
SELECT * FROM "icinga2_services" WHERE state_code = 0 AND time > now() - 24h // Service with OK status
Expand All @@ -58,9 +58,9 @@ SELECT * FROM "icinga2_services" WHERE state_code = 2 AND time > now() - 24h //
SELECT * FROM "icinga2_services" WHERE state_code = 3 AND time > now() - 24h // Service with UNKNOWN status
```

### Example Output:
## Example Output

```
```text
$ ./telegraf -config telegraf.conf -input-filter icinga2 -test
icinga2_hosts,display_name=router-fr.eqx.fr,check_command=hostalive-custom,host=test-vm,source=localhost,port=5665,scheme=https,state=ok name="router-fr.eqx.fr",state=0 1492021603000000000
```
10 changes: 4 additions & 6 deletions plugins/inputs/infiniband/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ system. These are the counters that can be found in

**Supported Platforms**: Linux

### Configuration
## Configuration

```toml
[[inputs.infiniband]]
# no configuration
```

### Metrics
## Metrics

Actual metrics depend on the InfiniBand devices, the plugin uses a simple
mapping from counter -> counter value.
Expand Down Expand Up @@ -49,10 +49,8 @@ mapping from counter -> counter value.
- unicast_xmit_packets (integer)
- VL15_dropped (integer)

## Example Output


### Example Output

```
```shell
infiniband,device=mlx5_0,port=1 VL15_dropped=0i,excessive_buffer_overrun_errors=0i,link_downed=0i,link_error_recovery=0i,local_link_integrity_errors=0i,multicast_rcv_packets=0i,multicast_xmit_packets=0i,port_rcv_constraint_errors=0i,port_rcv_data=237159415345822i,port_rcv_errors=0i,port_rcv_packets=801977655075i,port_rcv_remote_physical_errors=0i,port_rcv_switch_relay_errors=0i,port_xmit_constraint_errors=0i,port_xmit_data=238334949937759i,port_xmit_discards=0i,port_xmit_packets=803162651391i,port_xmit_wait=4294967295i,symbol_error=0i,unicast_rcv_packets=801977655075i,unicast_xmit_packets=803162651391i 1573125558000000000
```
20 changes: 10 additions & 10 deletions plugins/inputs/influxdb/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# InfluxDB Input Plugin

The InfluxDB plugin will collect metrics on the given InfluxDB servers. Read our
[documentation](https://docs.influxdata.com/platform/monitoring/influxdata-platform/tools/measurements-internal/)
for detailed information about `influxdb` metrics.
The InfluxDB plugin will collect metrics on the given InfluxDB servers. Read our
[documentation](https://docs.influxdata.com/platform/monitoring/influxdata-platform/tools/measurements-internal/)
for detailed information about `influxdb` metrics.

This plugin can also gather metrics from endpoints that expose
InfluxDB-formatted endpoints. See below for more information.

### Configuration:
## Configuration

```toml
# Read InfluxDB-formatted JSON metrics from one or more HTTP endpoints
Expand Down Expand Up @@ -37,7 +37,7 @@ InfluxDB-formatted endpoints. See below for more information.
timeout = "5s"
```

### Measurements & Fields
## Measurements & Fields

**Note:** The measurements and fields included in this plugin are dynamically built from the InfluxDB source, and may vary between versions:

Expand Down Expand Up @@ -80,7 +80,7 @@ InfluxDB-formatted endpoints. See below for more information.
- **influxdb_hh_processor** _(Enterprise Only)_: Statistics stored for a single queue (shard).
- **bytesRead**: Size, in bytes, of points read from the hinted handoff queue and sent to its destination data node.
- **bytesWritten**: Total number of bytes written to the hinted handoff queue.
- **queueBytes**: Total number of bytes remaining in the hinted handoff queue.
- **queueBytes**: Total number of bytes remaining in the hinted handoff queue.
- **queueDepth**: Total number of segments in the hinted handoff queue. The HH queue is a sequence of 10MB “segment” files.
- **writeBlocked**: Number of writes blocked because the number of concurrent HH requests exceeds the limit.
- **writeDropped**: Number of writes dropped from the HH queue because the write appeared to be corrupted.
Expand Down Expand Up @@ -125,7 +125,7 @@ InfluxDB-formatted endpoints. See below for more information.
- **HeapInuse**: Number of bytes in in-use spans.
- **HeapObjects**: Number of allocated heap objects.
- **HeapReleased**: Number of bytes of physical memory returned to the OS.
- **HeapSys**: Number of bytes of heap memory obtained from the OS.
- **HeapSys**: Number of bytes of heap memory obtained from the OS.
- **LastGC**: Time the last garbage collection finished.
- **Lookups**: Number of pointer lookups performed by the runtime.
- **MCacheInuse**: Number of bytes of allocated mcache structures.
Expand Down Expand Up @@ -258,9 +258,9 @@ InfluxDB-formatted endpoints. See below for more information.
- **writePartial** _(Enterprise only)_: Total number of batches written to at least one node, but did not meet the requested consistency level.
- **writeTimeout**: Total number of write requests that failed to complete within the default write timeout duration.

### Example Output:
## Example Output

```
```sh
telegraf --config ~/ws/telegraf.conf --input-filter influxdb --test
* Plugin: influxdb, Collection 1
> influxdb_database,database=_internal,host=tyrion,url=http://localhost:8086/debug/vars numMeasurements=10,numSeries=29 1463590500247354636
Expand Down Expand Up @@ -292,7 +292,7 @@ telegraf --config ~/ws/telegraf.conf --input-filter influxdb --test
> influxdb_shard,host=tyrion n_shards=4i 1463590500247354636
```

### InfluxDB-formatted endpoints
## InfluxDB-formatted endpoints

The influxdb plugin can collect InfluxDB-formatted data from JSON endpoints.
Whether associated with an Influx database or not.
Expand Down
9 changes: 5 additions & 4 deletions plugins/inputs/influxdb_listener/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ receive a 200 OK response with message body `{"results":[]}` but they are not
relayed. The output configuration of the Telegraf instance which ultimately
submits data to InfluxDB determines the destination database.

### Configuration:
## Configuration

```toml
[[inputs.influxdb_listener]]
Expand Down Expand Up @@ -64,14 +64,15 @@ submits data to InfluxDB determines the destination database.
# basic_password = "barfoo"
```

### Metrics:
## Metrics

Metrics are created from InfluxDB Line Protocol in the request body.

### Troubleshooting:
## Troubleshooting

**Example Query:**
```

```sh
curl -i -XPOST 'http://localhost:8186/write' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000'
```

Expand Down
9 changes: 5 additions & 4 deletions plugins/inputs/influxdb_v2_listener/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ defer to the output plugins configuration.

Telegraf minimum version: Telegraf 1.16.0

### Configuration:
## Configuration

```toml
[[inputs.influxdb_v2_listener]]
Expand Down Expand Up @@ -42,14 +42,15 @@ Telegraf minimum version: Telegraf 1.16.0
# token = "some-long-shared-secret-token"
```

### Metrics:
## Metrics

Metrics are created from InfluxDB Line Protocol in the request body.

### Troubleshooting:
## Troubleshooting

**Example Query:**
```

```sh
curl -i -XPOST 'http://localhost:8186/api/v2/write' --data-binary 'cpu_load_short,host=server01,region=us-west value=0.64 1434055562000000000'
```

Expand Down
Loading

0 comments on commit 8456287

Please sign in to comment.