From f5006d51e8caf9148d393eb68d53dc9fcd28b7b6 Mon Sep 17 00:00:00 2001 From: Promise Akpan Date: Thu, 15 Aug 2019 12:06:39 +0100 Subject: Fix Markdown Lint warnings (#6664) * make remark access all directories * detailed fix after autofix by remark lint * cross check autofix for this set of files * crosscheck more files * crosschecking and small fixes * crosscheck autofixed md files --- collectors/freeipmi.plugin/README.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) (limited to 'collectors/freeipmi.plugin') diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md index b54c3f42d0..058c2edbc3 100644 --- a/collectors/freeipmi.plugin/README.md +++ b/collectors/freeipmi.plugin/README.md @@ -6,9 +6,9 @@ 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. @@ -18,20 +18,19 @@ If you just installed the required IPMI tools, please run at least once the comm 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 ![image](https://cloud.githubusercontent.com/assets/2662304/23674138/88926a20-037d-11e7-89c0-20e74ee10cd1.png) @@ -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,7 +105,7 @@ 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 @@ -142,7 +140,6 @@ ID | Name | Type | State | Reading | Unit ... ``` - ## Debugging You can run the plugin by hand: @@ -187,4 +184,4 @@ If you need to disable IPMI for Netdata, edit `/etc/netdata/netdata.conf` and se freeipmi = no ``` -[![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%2Ffreeipmi.plugin%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%2Ffreeipmi.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) -- cgit v1.2.3