summaryrefslogtreecommitdiffstats
path: root/collectors/freeipmi.plugin
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2018-11-23 00:16:56 +0100
committerCosta Tsaousis <costa@tsaousis.gr>2018-11-23 01:16:56 +0200
commit1149ce32401c811a429ac1d3311f6676926e7d92 (patch)
tree0385c9df3912e00ce4cc26bcfb3d4d751bdc4f38 /collectors/freeipmi.plugin
parentcfc740a7a2e7b7236ad1378fdb7a73c281cb867e (diff)
Sanitize headers and htmlstructure (#4713)
* Restructured html site, corrected header in REDISTRIBUTED * Added header * Header updates and restructuring * Move requirements and runtime txts to htmldoc, by adding a netlify.toml that changes the base directory * Minor corrections to support the html doc restructuring * Debugging netlify * Debugging netlify * Debugging netlify * Beautify headers, comment in buildhtml * Beautify headers * Sanitize headers and reorganize static html site * Updated Makefile with moved and created htmldoc scripts
Diffstat (limited to 'collectors/freeipmi.plugin')
-rw-r--r--collectors/freeipmi.plugin/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md
index 6d4ad1865f..1cebf54e11 100644
--- a/collectors/freeipmi.plugin/README.md
+++ b/collectors/freeipmi.plugin/README.md
@@ -1,8 +1,10 @@
-netdata has a [freeipmi](https://www.gnu.org/software/freeipmi/) plugin.
+# freeipmi.plugin
+
+Netdata has a [freeipmi](https://www.gnu.org/software/freeipmi/) plugin.
> FreeIPMI provides in-band and out-of-band IPMI software based on the IPMI v1.5/2.0 specification. The IPMI specification defines a set of interfaces for platform management and is implemented by a number vendors for system management. The features of IPMI that most users will be interested in are sensor monitoring, system event monitoring, power control, and serial-over-LAN (SOL).
-## compile `freeipmi.plugin`
+## Compile `freeipmi.plugin`
1. install `libipmimonitoring-dev` or `libipmimonitoring-devel` (`freeipmi-devel` on RHEL based OS) using the package manager of your system.
@@ -12,7 +14,7 @@ Keep in mind IPMI requires root access, so the plugin is setuid to root.
If you just installed the required IPMI tools, please run at least once the command `ipmimonitoring` and verify it returns sensors information. This command initialises IPMI configuration, so that the netdata plugin will be able to work.
-## netdata use
+## Netdata use
The plugin creates (up to) 8 charts, based on the information collected from IPMI:
@@ -101,7 +103,7 @@ You can set these options in `/etc/netdata/netdata.conf` at this section:
Append to `command options = ` the settings you need. The minimum `update every` is 5 (enforced internally by the plugin). IPMI is slow and CPU hungry. So, once every 5 seconds is pretty acceptable.
-## ignoring specific sensors
+## Ignoring specific sensors
Specific sensor IDs can be excluded from freeipmi tools by editing `/etc/freeipmi/freeipmi.conf` and setting the IDs to be ignored at `ipmi-sensors-exclude-record-ids`. **However this file is not used by `libipmimonitoring`** (the library used by netdata's `freeipmi.plugin`).
@@ -135,7 +137,7 @@ ID | Name | Type | State | Reading | Unit
```
-## debugging
+## Debugging
You can run the plugin by hand: