summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/adaptec_raid/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/adaptec_raid/README.md')
-rw-r--r--collectors/python.d.plugin/adaptec_raid/README.md48
1 files changed, 28 insertions, 20 deletions
diff --git a/collectors/python.d.plugin/adaptec_raid/README.md b/collectors/python.d.plugin/adaptec_raid/README.md
index 127d595b2..d35ccecbc 100644
--- a/collectors/python.d.plugin/adaptec_raid/README.md
+++ b/collectors/python.d.plugin/adaptec_raid/README.md
@@ -1,12 +1,24 @@
-# adaptec raid
+<!--
+title: "Adaptec RAID controller monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/adaptec_raid/README.md
+sidebar_label: "Adaptec RAID"
+-->
-Module collects logical and physical devices health metrics.
+# Adaptec RAID controller monitoring with Netdata
-**Requirements:**
+Collects logical and physical devices metrics.
-- `arcconf` program
-- `sudo` program
-- `netdata` user needs to be able to sudo the `arcconf` program without password
+## Requirements
+
+The module uses `arcconf`, which can only be executed by root. It uses
+`sudo` and assumes that it is configured such that the `netdata` user can
+execute `arcconf` as root without password.
+
+Add to `sudoers`:
+
+```
+netdata ALL=(root) NOPASSWD: /path/to/arcconf
+```
To grab stats it executes:
@@ -23,27 +35,23 @@ It produces:
4. **Physical Device Temperature**
-## prerequisite
+## Configuration
-This module uses `arcconf` which can only be executed by root. It uses
-`sudo` and assumes that it is configured such that the `netdata` user can
-execute `arcconf` as root without password.
+**adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
-Add to `sudoers`:
-
-```
-netdata ALL=(root) NOPASSWD: /path/to/arcconf
+```yaml
+adaptec_raid: yes
```
-## configuration
-
- **adaptec_raid** is disabled by default. Should be explicitly enabled in `python.d.conf`.
+Edit the `python.d/adaptec_raid.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
-```yaml
-adaptec_raid: yes
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/adaptec_raid.conf
```
-### Screenshot:
+
![image](https://user-images.githubusercontent.com/22274335/47278133-6d306680-d601-11e8-87c2-cc9c0f42d686.png)