@cryptotaxi247 / netdata-1 / commits / 69ad057b0

Update FreeIPMI and CUPS plugin documentation. (#13526)

Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: netdatabot <bot@netdata.cloud>

Austin S. Hemmelgarn committed Aug 16, 2022 at 12:09 UTC 69ad057b0d4364349bbb6e2a95eff75de8c107d4
2 files changed +22 -12
collectors/cups.plugin/README.md
+3 -1
@@ -11,9 +11,11 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.
11
12 This plugin needs a running local CUPS daemon (`cupsd`). This plugin does not need any configuration. Supports cups since version 1.7.
13
14 +If you installed Netdata using our native packages, you will have to additionaly install `netdata-plugin-cups` to use this plugin for data collection. It is not installed by default due to the large number of dependencies it requires.
15 +
16 ## Charts
17
16 -`cups.plugin` provides one common section `destinations` and one section per destination.
18 +`cups.plugin` provides one common section `destinations` and one section per destination.
19
20 > Destinations in CUPS represent individual printers or classes (collections or pools) of printers (<https://www.cups.org/doc/cupspm.html#working-with-destinations>)
21
collectors/freeipmi.plugin/README.md
+19 -11
@@ -9,20 +9,30 @@ Netdata has a [freeipmi](https://www.gnu.org/software/freeipmi/) plugin.
9
10 > 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).
11
12 -## Compile `freeipmi.plugin`
12 +## Installing the FreeIPMI plugin
13
14 -1. install `libipmimonitoring-dev` or `libipmimonitoring-devel` (`freeipmi-devel` on RHEL based OS) using the package manager of your system.
14 +When using our official DEB/RPM packages, the FreeIPMI plugin is included in a separate package named
15 +`netdata-plugin-freeipmi` which needs to be manually installed using your system package manager. It is not
16 +installed automatically due to the large number of dependencies it requires.
17
16 -2. re-install Netdata from source. The installer will detect that the required libraries are now available and will also build `freeipmi.plugin`.
18 +When using a static build of Netdata, the FreeIPMI plugin will be included and installed automatically, though
19 +you will still need to have FreeIPMI installed on your system to be able to use the plugin.
20
18 -> ❗ In some distributions `libipmimonitoring.pc` is located in an unregistered directory.
19 -> In that case you should find the file and link it to the standard pkg-config directory. Usually, running
20 -> `sudo ln -s /usr/lib/x86_64-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc`
21 -> resolves the issue.
21 +When using a local build of Netdata, you need to ensure that the FreeIPMI development packages (typically called `libipmimonitoring-dev`, `libipmimonitoring-devel`, or `freeipmi-devel`) are installed when building Netdata.
22
23 -Keep in mind IPMI requires root access, so the plugin is setuid to root.
23 +### Special Considerations
24
25 -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.
25 +Accessing IPMI requires root access, so the FreeIPMI plugin is automatically installed setuid root.
26 +
27 +FreeIPMI does not work correctly on IBM POWER systems, thus Netdata’s FreeIPMI plugin is not usable on such systems.
28 +
29 +If you have not previously used IPMI on your system, you will probably need to run the `ipmimonitoring` command as root to initiailze IPMI settings so that the Netdata plugin works correctly. It should return information about available seensors on the system.
30 +
31 +In some distributions `libipmimonitoring.pc` is located in a non-standard directory, which
32 +can cause building the plugin to fail when building Netdata from source. In that case you
33 +should find the file and link it to the standard pkg-config directory. Usually, running `sudo ln -s
34 +/usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc`
35 +resolves this issue.
36
37 ## Netdata use
38
@@ -190,5 +200,3 @@ If you need to disable IPMI for Netdata, edit `/etc/netdata/netdata.conf` and se
200 [plugins]
201 freeipmi = no
202 ```
193 -
194 -