Add documentation

collectors/gpfsMetric.md

@@ -5,7 +5,8 @@
     "mmpmon_path": "/path/to/mmpmon",
     "exclude_filesystem": [
       "fs1"
-    ]
+    ],
+    "send_bandwidths" : true
   }
 ```
 
@@ -18,13 +19,16 @@ in the configuration.
 The path to the `mmpmon` command can be configured with the `mmpmon_path` option
 in the configuration. If nothing is set, the collector searches in `$PATH` for `mmpmon`.
 
+
 Metrics:
-* `bytes_read`
+* `gpfs_bytes_read`
 * `gpfs_bytes_written`
 * `gpfs_num_opens`
 * `gpfs_num_closes`
 * `gpfs_num_reads`
 * `gpfs_num_readdirs`
 * `gpfs_num_inode_updates`
+* `gpfs_bw_read` (if `send_bandwidths == true`)
+* `gpfs_bw_write` (if `send_bandwidths == true`)
 
 The collector adds a `filesystem` tag to all metrics

collectors/infinibandMetric.md

@@ -5,7 +5,9 @@
   "ibstat": {
     "exclude_devices": [
       "mlx4"
-    ]
+    ],
+    "send_abs_values": true,
+    "send_derived_values": true
   }
 ```
 
@@ -22,5 +24,9 @@ Metrics:
 * `ib_xmit`
 * `ib_recv_pkts`
 * `ib_xmit_pkts`
+* `ib_recv_bw` (if `send_derived_values == true`)
+* `ib_xmit_bw` (if `send_derived_values == true`)
+* `ib_recv_pkts_bw` (if `send_derived_values == true`)
+* `ib_xmit_pkts_bw` (if `send_derived_values == true`)
 
 The collector adds a `device` tag to all metrics

collectors/lustreMetric.md

@@ -9,21 +9,26 @@
     "exclude_metrics": [
       "setattr",
       "getattr"
-    ]
+    ],
+    "send_abs_values" : true,
+    "send_derived_values" : true
   }
 ```
 
 The `lustrestat` collector reads from the procfs stat files for Lustre like `/proc/fs/lustre/llite/lnec-XXXXXX/stats`.
 
 Metrics:
-* `read_bytes`
-* `read_requests`
-* `write_bytes`
-* `write_requests`
-* `open`
-* `close`
-* `getattr`
-* `setattr`
-* `statfs`
-* `inode_permission`
+* `lustre_read_bytes`
+* `lustre_read_requests`
+* `lustre_write_bytes`
+* `lustre_write_requests`
+* `lustre_open`
+* `lustre_close`
+* `lustre_getattr`
+* `lustre_setattr`
+* `lustre_statfs`
+* `lustre_inode_permission`
+* `lustre_read_bytes_bw` (if `send_derived_values == true`)
+* `lustre_write_bytes_bw` (if `send_derived_values == true`)
 
+This collector adds an `device` tag.

collectors/netstatMetric.md

@@ -5,17 +5,23 @@
   "netstat": {
     "include_devices": [
       "eth0"
-    ]
+    ],
+    "send_abs_values" : true,
+    "send_derived_values" : true
   }
 ```
 
 The `netstat` collector reads data from `/proc/net/dev` and outputs a handful **node** metrics. With the `include_devices` list you can specify which network devices should be measured. **Note**: Most other collectors use an _exclude_ list instead of an include list.
 
 Metrics:
-* `net_bytes_in` (`unit=bytes/sec`)
-* `net_bytes_out` (`unit=bytes/sec`)
-* `net_pkts_in` (`unit=packets/sec`)
-* `net_pkts_out` (`unit=packets/sec`)
+* `net_bytes_in` (`unit=bytes`)
+* `net_bytes_out` (`unit=bytes`)
+* `net_pkts_in` (`unit=packets`)
+* `net_pkts_out` (`unit=packets`)
+* `net_bytes_in_bw` (`unit=bytes/sec` if `send_derived_values == true`)
+* `net_bytes_out_bw` (`unit=bytes/sec` if `send_derived_values == true`)
+* `net_pkts_in_bw` (`unit=packets/sec` if `send_derived_values == true`)
+* `net_pkts_out_bw` (`unit=packets/sec` if `send_derived_values == true`)
 
 The device name is added as tag `device`.