diff --git a/README.md b/README.md index 55f8c43..7209e9a 100644 --- a/README.md +++ b/README.md @@ -25,32 +25,35 @@ flags are used. usage: smartctl_exporter [] Flags: - -h, --help Show context-sensitive help (also try --help-long and --help-man). - --smartctl.path="/usr/sbin/smartctl" - The path to the smartctl binary - --smartctl.interval=60s The interval between smartctl polls - --smartctl.rescan=10m The interval between rescanning for new/disappeared devices. If the interval is smaller than 1s no - rescanning takes place. If any devices are configured with smartctl.device also no rescanning takes - place. - --smartctl.device=SMARTCTL.DEVICE ... - The device to monitor (repeatable) + -h, --[no-]help Show context-sensitive help (also try --help-long and --help-man). + --smartctl.path="/usr/sbin/smartctl" + The path to the smartctl binary + --smartctl.interval=60s The interval between smartctl polls + --smartctl.rescan=10m The interval between rescanning for new/disappeared devices. If the interval is smaller than 1s no + rescanning takes place. If any devices are configured with smartctl.device also no rescanning takes place. + --[no-]smartctl.scan Enable scanning. This is a default if no devices are specified + --smartctl.device=SMARTCTL.DEVICE ... + The device to monitor. Device type can be specified after a semicolon, eg. '/dev/bus/0;megaraid,1' + (repeatable) --smartctl.device-exclude="" - Regexp of devices to exclude from automatic scanning. (mutually exclusive to - device-include) + Regexp of devices to exclude from automatic scanning. (mutually exclusive to device-include) --smartctl.device-include="" - Regexp of devices to include in automatic scanning. (mutually exclusive to - device-exclude) - --web.telemetry-path="/metrics" - Path under which to expose metrics - --web.systemd-socket Use systemd socket activation listeners instead of port listeners (Linux only). + Regexp of devices to exclude from automatic scanning. (mutually exclusive to device-exclude) + --smartctl.scan-device-type=SMARTCTL.SCAN-DEVICE-TYPE ... + Device type to use during automatic scan. Special by-id value forces predictable device names. (repeatable) + --smartctl.powermode-check="standby" + Whether or not to check powermode before fetching data + --web.telemetry-path="/metrics" + Path under which to expose metrics + --[no-]web.systemd-socket Use systemd socket activation listeners instead of port listeners (Linux only). --web.listen-address=:9633 ... - Addresses on which to expose metrics and web interface. Repeatable for multiple - addresses. - --web.config.file="" [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication. - --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, - error] - --log.format=logfmt Output format of log messages. One of: [logfmt, json] - --version Show application version. + Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. Examples: + `:9100` or `[::1]:9100` for http, `vsock://:9100` for vsock + --web.config.file="" Path to configuration file that can enable TLS or authentication. See: + https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md + --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error] + --log.format=logfmt Output format of log messages. One of: [logfmt, json] + --[no-]version Show application version. ``` ## TLS and basic authentication