diff options
Diffstat (limited to 'collectors/freeipmi.plugin/README.md')
| -rw-r--r-- | collectors/freeipmi.plugin/README.md | 37 |
1 files changed, 17 insertions, 20 deletions
diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md index 246955f95..058c2edbc 100644 --- a/collectors/freeipmi.plugin/README.md +++ b/collectors/freeipmi.plugin/README.md @@ -6,32 +6,31 @@ Netdata has a [freeipmi](https://www.gnu.org/software/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. +1. install `libipmimonitoring-dev` or `libipmimonitoring-devel` (`freeipmi-devel` on RHEL based OS) using the package manager of your system. -2. re-install netdata from source. The installer will detect that the required libraries are now available and will also build `freeipmi.plugin`. +2. re-install Netdata from source. The installer will detect that the required libraries are now available and will also build `freeipmi.plugin`. 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. +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 The plugin creates (up to) 8 charts, based on the information collected from IPMI: -1. number of sensors by state -2. number of events in SEL -3. Temperatures CELCIUS -4. Temperatures FAHRENHEIT -5. Voltages -6. Currents -7. Power -8. Fans - +1. number of sensors by state +2. number of events in SEL +3. Temperatures CELCIUS +4. Temperatures FAHRENHEIT +5. Voltages +6. Currents +7. Power +8. Fans It also adds 2 alarms: -1. Sensors in non-nominal state (i.e. warning and critical) -2. SEL is non empty +1. Sensors in non-nominal state (i.e. warning and critical) +2. SEL is non empty  @@ -96,7 +95,6 @@ The plugin supports a few options. To see them, run: For more information: https://github.com/netdata/netdata/tree/master/collectors/freeipmi.plugin - ``` You can set these options in `/etc/netdata/netdata.conf` at this section: @@ -107,11 +105,11 @@ You can set these options in `/etc/netdata/netdata.conf` at this section: command options = ``` -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. +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 -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`). +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`). So, `freeipmi.plugin` supports the option `ignore` that accepts a comma separated list of sensor IDs to ignore. To configure it, edit `/etc/netdata/netdata.conf` and set: @@ -142,7 +140,6 @@ ID | Name | Type | State | Reading | Unit ... ``` - ## Debugging You can run the plugin by hand: @@ -180,11 +177,11 @@ options ipmi_si kipmid_max_busy_us=10 This instructs the kernel IPMI module to pause for a tick between checking IPMI. Querying IPMI will be a lot slower now (e.g. several seconds for IPMI to respond), but `kipmi` will not use any noticeable CPU. You can also use a higher number (this is the number of microseconds to poll IPMI for a response, before waiting for a tick). -If you need to disable IPMI for netdata, edit `/etc/netdata/netdata.conf` and set: +If you need to disable IPMI for Netdata, edit `/etc/netdata/netdata.conf` and set: ``` [plugins] freeipmi = no ``` -[]() +[](<>) |