summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/smartd_log/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/smartd_log/README.md')
-rw-r--r--collectors/python.d.plugin/smartd_log/README.md52
1 files changed, 28 insertions, 24 deletions
diff --git a/collectors/python.d.plugin/smartd_log/README.md b/collectors/python.d.plugin/smartd_log/README.md
index f6584be70..6f4dda50c 100644
--- a/collectors/python.d.plugin/smartd_log/README.md
+++ b/collectors/python.d.plugin/smartd_log/README.md
@@ -3,43 +3,44 @@
Module monitor `smartd` log files to collect HDD/SSD S.M.A.R.T attributes.
**Requirements:**
-* `smartmontools`
-It produces following charts for SCSI devices:
+- `smartmontools`
-1. **Read Error Corrected**
+It produces following charts for SCSI devices:
-2. **Read Error Uncorrected**
+1. **Read Error Corrected**
-3. **Write Error Corrected**
+2. **Read Error Uncorrected**
-4. **Write Error Uncorrected**
+3. **Write Error Corrected**
-5. **Verify Error Corrected**
+4. **Write Error Uncorrected**
-6. **Verify Error Uncorrected**
+5. **Verify Error Corrected**
-7. **Temperature**
+6. **Verify Error Uncorrected**
+7. **Temperature**
For ATA devices:
-1. **Read Error Rate**
-2. **Seek Error Rate**
+1. **Read Error Rate**
+
+2. **Seek Error Rate**
-3. **Soft Read Error Rate**
+3. **Soft Read Error Rate**
-4. **Write Error Rate**
+4. **Write Error Rate**
-5. **SATA Interface Downshift**
+5. **SATA Interface Downshift**
-6. **UDMA CRC Error Count**
+6. **UDMA CRC Error Count**
-7. **Throughput Performance**
+7. **Throughput Performance**
-8. **Seek Time Performance**
+8. **Seek Time Performance**
-9. **Start/Stop Count**
+9. **Start/Stop Count**
10. **Power-On Hours Count**
@@ -75,25 +76,28 @@ For ATA devices:
26. **Percent Lifetime Used**
-### prerequisite
+## prerequisite
+
`smartd` must be running with `-A` option to write smartd attribute information to files.
For this you need to set `smartd_opts` (or `SMARTD_ARGS`, check _smartd.service_ content) in `/etc/default/smartmontools`:
-
```
# dump smartd attrs info every 600 seconds
smartd_opts="-A /var/log/smartd/ -i 600"
```
+
You may need to create the smartd directory before smartd will write to it:
-```
+
+```sh
mkdir -p /var/log/smartd
```
-Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontools` (default location). See also [https://linux.die.net/man/8/smartd](https://linux.die.net/man/8/smartd) for more info on the `-A --attributelog=PREFIX` command.
+
+Otherwise, all the smartd `.csv` files may get written to `/var/lib/smartmontools` (default location). See also <https://linux.die.net/man/8/smartd> for more info on the `-A --attributelog=PREFIX` command.
`smartd` appends logs at every run. It's strongly recommended to use `logrotate` for smartd files.
-### configuration
+## configuration
```yaml
local:
@@ -104,4 +108,4 @@ If no configuration is given, module will attempt to read log files in `/var/log
---
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fsmartd_log%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fsmartd_log%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)