Update documentation for infiniband plugin

This commit is contained in:
Daniel Nelson 2020-01-16 13:56:23 -08:00
parent 182104f95e
commit 17c165391b
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
4 changed files with 46 additions and 11 deletions

View File

@ -9,6 +9,10 @@
- The `date` processor now uses the UTC timezone when creating its tag. In - The `date` processor now uses the UTC timezone when creating its tag. In
previous versions the local time was used. previous versions the local time was used.
#### New Inputs
- [infiniband](/plugins/inputs/infiniband/README.md) - Contributed by @willfurnell
#### New Outputs #### New Outputs
- [warp10](/plugins/outputs/warp10/README.md) - Contributed by @aurrelhebert - [warp10](/plugins/outputs/warp10/README.md) - Contributed by @aurrelhebert

View File

@ -202,6 +202,7 @@ For documentation on the latest development code see the [documentation index][d
* [http](./plugins/inputs/http) (generic HTTP plugin, supports using input data formats) * [http](./plugins/inputs/http) (generic HTTP plugin, supports using input data formats)
* [http_response](./plugins/inputs/http_response) * [http_response](./plugins/inputs/http_response)
* [icinga2](./plugins/inputs/icinga2) * [icinga2](./plugins/inputs/icinga2)
* [infiniband](./plugins/inputs/infiniband)
* [influxdb](./plugins/inputs/influxdb) * [influxdb](./plugins/inputs/influxdb)
* [influxdb_listener](./plugins/inputs/influxdb_listener) * [influxdb_listener](./plugins/inputs/influxdb_listener)
* [internal](./plugins/inputs/internal) * [internal](./plugins/inputs/internal)

View File

@ -75,6 +75,7 @@ following works:
- github.com/mailru/easyjson [MIT License](https://github.com/mailru/easyjson/blob/master/LICENSE) - github.com/mailru/easyjson [MIT License](https://github.com/mailru/easyjson/blob/master/LICENSE)
- github.com/matttproud/golang_protobuf_extensions [Apache License 2.0](https://github.com/matttproud/golang_protobuf_extensions/blob/master/LICENSE) - github.com/matttproud/golang_protobuf_extensions [Apache License 2.0](https://github.com/matttproud/golang_protobuf_extensions/blob/master/LICENSE)
- github.com/mdlayher/apcupsd [MIT License](https://github.com/mdlayher/apcupsd/blob/master/LICENSE.md) - github.com/mdlayher/apcupsd [MIT License](https://github.com/mdlayher/apcupsd/blob/master/LICENSE.md)
- github.com/Mellanox/rdmamap [Apache License 2.0](https://github.com/Mellanox/rdmamap/blob/master/LICENSE)
- github.com/Microsoft/ApplicationInsights-Go [MIT License](https://github.com/Microsoft/ApplicationInsights-Go/blob/master/LICENSE) - github.com/Microsoft/ApplicationInsights-Go [MIT License](https://github.com/Microsoft/ApplicationInsights-Go/blob/master/LICENSE)
- github.com/Microsoft/go-winio [MIT License](https://github.com/Microsoft/go-winio/blob/master/LICENSE) - github.com/Microsoft/go-winio [MIT License](https://github.com/Microsoft/go-winio/blob/master/LICENSE)
- github.com/miekg/dns [BSD 3-Clause Clear License](https://github.com/miekg/dns/blob/master/LICENSE) - github.com/miekg/dns [BSD 3-Clause Clear License](https://github.com/miekg/dns/blob/master/LICENSE)

View File

@ -1,29 +1,58 @@
# InfiniBand Input Plugin # InfiniBand Input Plugin
This plugin gathers statistics for all InfiniBand devices and ports on the system. These are the counters that can be found in /sys/class/infiniband/<dev>/port/<port>/counters/ This plugin gathers statistics for all InfiniBand devices and ports on the
system. These are the counters that can be found in
`/sys/class/infiniband/<dev>/port/<port>/counters/`
**Supported Platforms**: Linux
### Configuration ### Configuration
This section contains the default TOML to configure the plugin. You can
generate it using `telegraf --usage infiniband`.
```toml ```toml
[[inputs.infiniband]] [[inputs.infiniband]]
# no configuration
``` ```
There are no configuration options for this plugin.
### Metrics ### Metrics
You can find more information about the counters that are gathered here: Actual metrics depend on the InfiniBand devices, the plugin uses a simple
https://community.mellanox.com/s/article/understanding-mlx5-linux-counters-and-status-parameters mapping from counter -> counter value.
[Information about the counters][counters] collected is provided by Mellanox.
[counters]: https://community.mellanox.com/s/article/understanding-mlx5-linux-counters-and-status-parameters
- infiniband
- tags:
- device
- port
- fields:
- excessive_buffer_overrun_errors (integer)
- link_downed (integer)
- link_error_recovery (integer)
- local_link_integrity_errors (integer)
- multicast_rcv_packets (integer)
- multicast_xmit_packets (integer)
- port_rcv_constraint_errors (integer)
- port_rcv_data (integer)
- port_rcv_errors (integer)
- port_rcv_packets (integer)
- port_rcv_remote_physical_errors (integer)
- port_rcv_switch_relay_errors (integer)
- port_xmit_constraint_errors (integer)
- port_xmit_data (integer)
- port_xmit_discards (integer)
- port_xmit_packets (integer)
- port_xmit_wait (integer)
- symbol_error (integer)
- unicast_rcv_packets (integer)
- unicast_xmit_packets (integer)
- VL15_dropped (integer)
There is a simple mapping from counter -> counter value. All counter values are 64 bit integers. A seperate measurement is made for each port.
Each measurement is tagged with the device and port that it relates to. These are strings.
### Example Output ### Example Output
``` ```
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 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
``` ```