Skip to content

Commit 0dfe4ab

Browse files
committed
README: update usage
1 parent dadd662 commit 0dfe4ab

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,36 @@ It provides the following metrics:
1212
## Usage
1313
```
1414
Usage of cumulus-exporter:
15-
-collectors.transceiver.exclude-interfaces string
16-
Comma seperated list of interfaces to exclude from scrape
1715
-collectors.asic
18-
Enable ASIC collector
16+
Enable ASIC collector
1917
-collectors.hwmon
20-
Enable hwmon collector
18+
Enable hwmon collector
2119
-collectors.hwmon.config string
22-
hwmon collector config file (default "hwmon.yml")
20+
hwmon collector config file (default "hwmon.yml")
2321
-collectors.mstpd
24-
Enable mstpd collector
22+
Enable mstpd collector
2523
-collectors.mstpd.mstpctl-path string
26-
mstpctl binary path (default "/sbin/mstpctl")
24+
mstpctl binary path (default "/sbin/mstpctl")
2725
-collectors.transceiver
28-
Enable transceiver collector (rx / tx power, temperatures, etc.)
26+
Enable transceiver collector (rx / tx power, temperatures, etc.)
27+
-collectors.transceiver.exclude-interfaces string
28+
Comma seperated list of interfaces to exclude from scrape
29+
-collectors.transceiver.exclude-interfaces-regex string
30+
Regex Expression for interfaces to exclude from scrape
31+
-collectors.transceiver.include-interfaces string
32+
Comma seperated list of interfaces to include from scrape
33+
-collectors.transceiver.include-interfaces-regex string
34+
Regex Expression for interfaces to include from scrape
2935
-collectors.transceiver.interface-features
30-
Collect interface features (results in many time series
36+
Collect interface features (results in many time series
37+
-log.level string
38+
The level the application logs at (default "info")
3139
-version
32-
Print version and exit
40+
Print version and exit
3341
-web.listen-address string
34-
Address to listen on (default "[::]:9457")
42+
Address to listen on (default "[::]:9457")
3543
-web.telemetry-path string
36-
Path under which to expose metrics (default "/metrics")
44+
Path under which to expose metrics (default "/metrics")
3745
```
3846

3947
## Hwmon configuration

0 commit comments

Comments
 (0)