mirror of
https://github.com/ClusterCockpit/cc-metric-collector.git
synced 2024-12-25 23:19:06 +01:00
Moved documentation to markdown file
This commit is contained in:
parent
9ab7a6424b
commit
5ac3af895d
@ -32,24 +32,6 @@ type InfinibandCollector struct {
|
|||||||
info []InfinibandCollectorInfo
|
info []InfinibandCollectorInfo
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *InfinibandCollector) Help() {
|
|
||||||
fmt.Println("This collector includes all devices that can be found below ", IB_BASEPATH)
|
|
||||||
fmt.Println("and where any of the ports provides a 'lid' file (glob ", IB_BASEPATH, "/<dev>/ports/<port>/lid).")
|
|
||||||
fmt.Println("The devices can be filtered with the 'exclude_devices' option in the configuration.")
|
|
||||||
fmt.Println("For each found LIDs the collector calls the 'perfquery' command")
|
|
||||||
fmt.Println("")
|
|
||||||
fmt.Println("Full configuration object:")
|
|
||||||
fmt.Println("\"ibstat\" : {")
|
|
||||||
fmt.Println(" \"exclude_devices\" : [\"dev1\"]")
|
|
||||||
fmt.Println("}")
|
|
||||||
fmt.Println("")
|
|
||||||
fmt.Println("Metrics:")
|
|
||||||
fmt.Println("- ib_recv")
|
|
||||||
fmt.Println("- ib_xmit")
|
|
||||||
fmt.Println("- ib_recv_pkts")
|
|
||||||
fmt.Println("- ib_xmit_pkts")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Init initializes the Infiniband collector by walking through files below IB_BASEPATH
|
// Init initializes the Infiniband collector by walking through files below IB_BASEPATH
|
||||||
func (m *InfinibandCollector) Init(config json.RawMessage) error {
|
func (m *InfinibandCollector) Init(config json.RawMessage) error {
|
||||||
var err error
|
var err error
|
||||||
|
@ -3,17 +3,21 @@
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
"ibstat": {
|
"ibstat": {
|
||||||
"perfquery_path" : "<path to perfquery command>",
|
|
||||||
"exclude_devices": [
|
"exclude_devices": [
|
||||||
"mlx4"
|
"mlx4"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `ibstat` collector reads either data through the `perfquery` command or the sysfs files below `/sys/class/infiniband/<device>`.
|
The `ibstat` includes all devices that can be found below `/sys/class/infiniband/`
|
||||||
|
and where any of the ports provides a `lid` file (`/sys/class/infiniband/<dev>/ports/<port>/lid`)
|
||||||
|
The devices can be filtered with the `exclude_devices` option in the configuration.
|
||||||
|
The collector reads data through the sysfs files below `/sys/class/infiniband/<device>`.
|
||||||
|
|
||||||
Metrics:
|
Metrics:
|
||||||
* `ib_recv`
|
* `ib_recv`
|
||||||
* `ib_xmit`
|
* `ib_xmit`
|
||||||
|
* `ib_recv_pkts`
|
||||||
|
* `ib_xmit_pkts`
|
||||||
|
|
||||||
The collector adds a `device` tag to all metrics
|
The collector adds a `device` tag to all metrics
|
||||||
|
Loading…
Reference in New Issue
Block a user