From 99df104cdd54cb7d64f3969d0de9cc34a9b983ef Mon Sep 17 00:00:00 2001 From: Jason Kulatunga Date: Sat, 28 May 2022 15:50:05 -0700 Subject: [PATCH] documentation changes. --- README.md | 3 ++- docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index af29cc0..3eb5620 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,12 @@ Scrutiny uses `smartctl --scan` to detect devices/drives. - All RAID controllers supported by `smartctl` are automatically supported by Scrutiny. - While some RAID controllers support passing through the underlying SMART data to `smartctl` others do not. - In some cases `--scan` does not correctly detect the device type, returning [incomplete SMART data](https://github.com/AnalogJ/scrutiny/issues/45). - Scrutiny will eventually support overriding detected device type via the config file. + Scrutiny supports overriding detected device type via the config file: see [example.collector.yaml](https://github.com/AnalogJ/scrutiny/blob/master/example.collector.yaml) - If you use docker, you **must** pass though the RAID virtual disk to the container using `--device` (see below) - This device may be in `/dev/*` or `/dev/bus/*`. - If you're unsure, run `smartctl --scan` on your host, and pass all listed devices to the container. +See [docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md](./docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md) for help ## Docker diff --git a/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md b/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md index 0db3fb8..6821238 100644 --- a/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md +++ b/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md @@ -52,6 +52,8 @@ If the output is the same, your devices will be processed by Scrutiny. In some cases `--scan` does not correctly detect the device type, returning [incomplete SMART data](https://github.com/AnalogJ/scrutiny/issues/45). Scrutiny will supports overriding the detected device type via the config file. +[example.collector.yaml](https://github.com/AnalogJ/scrutiny/blob/master/example.collector.yaml) + ### RAID Controllers (Megaraid/3ware/HBA/Adaptec/HPE/etc) Smartctl has support for a large number of [RAID controllers](https://www.smartmontools.org/wiki/Supported_RAID-Controllers), however this support is not automatic, and may require some additional device type hinting. You can provide this information to the Scrutiny collector @@ -138,3 +140,17 @@ Thankfully the collector has a special `--host-id` flag (or `COLLECTOR_HOST_ID` See the [docs/INSTALL_HUB_SPOKE.md](/docs/INSTALL_HUB_SPOKE.md) guide for more information. +## Collector DEBUG mode + +You can use environmental variables to enable debug logging and/or log files for the collector: + +```bash +DEBUG=true +COLLECTOR_LOG_FILE=/tmp/collector.log +``` + +Or if you're not using docker, you can pass CLI arguments to the collector during startup: + +```bash +scrutiny-collector-metrics run --debug --log-file /tmp/collector.log +``` \ No newline at end of file