| 1 | plugin_name: freeipmi.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: freeipmi.plugin |
| 5 | module_name: freeipmi |
| 6 | monitored_instance: |
| 7 | name: Intelligent Platform Management Interface (IPMI) |
| 8 | link: "https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface" |
| 9 | categories: |
| 10 | - data-collection.hardware-and-sensors |
| 11 | icon_filename: "netdata.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - sensors |
| 19 | - ipmi |
| 20 | - freeipmi |
| 21 | - ipmimonitoring |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | "Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations." |
| 26 | method_description: | |
| 27 | The plugin uses open source library IPMImonitoring to communicate with sensors. |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "The plugin needs setuid." |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: "" |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "Linux kernel module for IPMI can create big overhead." |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: |
| 44 | - title: Install freeipmi.plugin |
| 45 | description: | |
| 46 | When using our official DEB/RPM packages, the FreeIPMI plugin is included in a separate package named `netdata-plugin-freeipmi` which needs to be manually installed using your system package manager. It is not installed automatically due to the large number of dependencies it requires. |
| 47 | |
| 48 | When using a static build of Netdata, the FreeIPMI plugin will be included and installed automatically, though you will still need to have FreeIPMI installed on your system to be able to use the plugin. |
| 49 | |
| 50 | 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. |
| 51 | - title: Preliminary actions |
| 52 | description: | |
| 53 | If you have not previously used IPMI on your system, you will probably need to run the `ipmimonitoring` command as root |
| 54 | to initialize IPMI settings so that the Netdata plugin works correctly. It should return information about available sensors on the system. |
| 55 | configuration: |
| 56 | file: |
| 57 | name: "netdata.conf" |
| 58 | section_name: "[plugin:freeipmi]" |
| 59 | options: |
| 60 | description: | |
| 61 | The configuration is set using command line options: |
| 62 | |
| 63 | ``` |
| 64 | # netdata.conf |
| 65 | [plugin:freeipmi] |
| 66 | command options = opt1 opt2 ... optN |
| 67 | ``` |
| 68 | |
| 69 | To display a help message listing the available command line options: |
| 70 | |
| 71 | ```bash |
| 72 | ./usr/libexec/netdata/plugins.d/freeipmi.plugin --help |
| 73 | ``` |
| 74 | folding: |
| 75 | title: "Command options" |
| 76 | enabled: true |
| 77 | list: |
| 78 | - name: SECONDS |
| 79 | description: Data collection frequency. |
| 80 | default_value: "" |
| 81 | required: false |
| 82 | - name: debug |
| 83 | description: Enable verbose output. |
| 84 | default_value: disabled |
| 85 | required: false |
| 86 | - name: no-sel |
| 87 | description: Disable System Event Log (SEL) collection. |
| 88 | default_value: disabled |
| 89 | required: false |
| 90 | - name: reread-sdr-cache |
| 91 | description: Re-read SDR cache on every iteration. |
| 92 | default_value: disabled |
| 93 | required: false |
| 94 | - name: interpret-oem-data |
| 95 | description: Attempt to parse OEM data. |
| 96 | default_value: disabled |
| 97 | required: false |
| 98 | - name: assume-system-event-record |
| 99 | description: treat illegal SEL events records as normal. |
| 100 | default_value: disabled |
| 101 | required: false |
| 102 | - name: ignore-non-interpretable-sensors |
| 103 | description: Do not read sensors that cannot be interpreted. |
| 104 | default_value: disabled |
| 105 | required: false |
| 106 | - name: bridge-sensors |
| 107 | description: Bridge sensors not owned by the BMC. |
| 108 | default_value: disabled |
| 109 | required: false |
| 110 | - name: shared-sensors |
| 111 | description: Enable shared sensors if found. |
| 112 | default_value: disabled |
| 113 | required: false |
| 114 | - name: no-discrete-reading |
| 115 | description: Do not read sensors if their event/reading type code is invalid. |
| 116 | default_value: enabled |
| 117 | required: false |
| 118 | - name: ignore-scanning-disabled |
| 119 | description: Ignore the scanning bit and read sensors no matter what. |
| 120 | default_value: disabled |
| 121 | required: false |
| 122 | - name: assume-bmc-owner |
| 123 | description: Assume the BMC is the sensor owner no matter what (usually bridging is required too). |
| 124 | default_value: disabled |
| 125 | required: false |
| 126 | - name: hostname HOST |
| 127 | description: Remote IPMI hostname or IP address. |
| 128 | default_value: local |
| 129 | required: false |
| 130 | - name: username USER |
| 131 | description: Username that will be used when connecting to the remote host. |
| 132 | default_value: "" |
| 133 | required: false |
| 134 | - name: password PASS |
| 135 | description: Password that will be used when connecting to the remote host. |
| 136 | default_value: "" |
| 137 | required: false |
| 138 | - name: noauthcodecheck / no-auth-code-check |
| 139 | description: Don't check the authentication codes returned. |
| 140 | default_value: "" |
| 141 | required: false |
| 142 | - name: driver-type IPMIDRIVER |
| 143 | description: Specify the driver type to use instead of doing an auto selection. The currently available outofband drivers are LAN and LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The currently available inband drivers are KCS, SSIF, OPENIPMI and SUNBMC. |
| 144 | default_value: "" |
| 145 | required: false |
| 146 | - name: sdr-cache-dir PATH |
| 147 | description: SDR cache files directory. |
| 148 | default_value: /tmp |
| 149 | required: false |
| 150 | - name: sensor-config-file FILE |
| 151 | description: Sensors configuration filename. |
| 152 | default_value: system default |
| 153 | required: false |
| 154 | - name: sel-config-file FILE |
| 155 | description: SEL configuration filename. |
| 156 | default_value: system default |
| 157 | required: false |
| 158 | - name: ignore N1,N2,N3,... |
| 159 | description: Sensor IDs to ignore. |
| 160 | default_value: "" |
| 161 | required: false |
| 162 | - name: ignore-status N1,N2,N3,... |
| 163 | description: Sensor IDs to ignore status (nominal/warning/critical). |
| 164 | default_value: "" |
| 165 | required: false |
| 166 | - name: -v |
| 167 | description: Print version and exit. |
| 168 | default_value: "" |
| 169 | required: false |
| 170 | - name: --help |
| 171 | description: Print usage message and exit. |
| 172 | default_value: "" |
| 173 | required: false |
| 174 | examples: |
| 175 | folding: |
| 176 | enabled: true |
| 177 | title: "Config" |
| 178 | list: |
| 179 | - name: Decrease data collection frequency |
| 180 | description: Basic example decreasing data collection frequency. 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. |
| 181 | config: | |
| 182 | [plugin:freeipmi] |
| 183 | update every = 10 |
| 184 | folding: |
| 185 | enabled: false |
| 186 | - name: Disable SEL collection |
| 187 | description: Append to `command options =` the options you need. |
| 188 | config: | |
| 189 | [plugin:freeipmi] |
| 190 | command options = no-sel |
| 191 | - name: Ignore specific sensors |
| 192 | description: | |
| 193 | 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`. |
| 194 | |
| 195 | **However this file is not used by `libipmimonitoring`** (the library used by Netdata's `freeipmi.plugin`). |
| 196 | |
| 197 | To find the IDs to ignore, run the command `ipmimonitoring`. The first column is the wanted ID: |
| 198 | |
| 199 | ID | Name | Type | State | Reading | Units | Event |
| 200 | 1 | Ambient Temp | Temperature | Nominal | 26.00 | C | 'OK' |
| 201 | 2 | Altitude | Other Units Based Sensor | Nominal | 480.00 | ft | 'OK' |
| 202 | 3 | Avg Power | Current | Nominal | 100.00 | W | 'OK' |
| 203 | 4 | Planar 3.3V | Voltage | Nominal | 3.29 | V | 'OK' |
| 204 | 5 | Planar 5V | Voltage | Nominal | 4.90 | V | 'OK' |
| 205 | 6 | Planar 12V | Voltage | Nominal | 11.99 | V | 'OK' |
| 206 | 7 | Planar VBAT | Voltage | Nominal | 2.95 | V | 'OK' |
| 207 | 8 | Fan 1A Tach | Fan | Nominal | 3132.00 | RPM | 'OK' |
| 208 | 9 | Fan 1B Tach | Fan | Nominal | 2150.00 | RPM | 'OK' |
| 209 | 10 | Fan 2A Tach | Fan | Nominal | 2494.00 | RPM | 'OK' |
| 210 | 11 | Fan 2B Tach | Fan | Nominal | 1825.00 | RPM | 'OK' |
| 211 | 12 | Fan 3A Tach | Fan | Nominal | 3538.00 | RPM | 'OK' |
| 212 | 13 | Fan 3B Tach | Fan | Nominal | 2625.00 | RPM | 'OK' |
| 213 | 14 | Fan 1 | Entity Presence | Nominal | N/A | N/A | 'Entity Present' |
| 214 | 15 | Fan 2 | Entity Presence | Nominal | N/A | N/A | 'Entity Present' |
| 215 | ... |
| 216 | |
| 217 | `freeipmi.plugin` supports the option `ignore` that accepts a comma separated list of sensor IDs to ignore. To configure it set on `netdata.conf`: |
| 218 | config: | |
| 219 | [plugin:freeipmi] |
| 220 | command options = ignore 1,2,3,4,... |
| 221 | troubleshooting: |
| 222 | problems: |
| 223 | list: |
| 224 | - name: Debug Mode |
| 225 | description: | |
| 226 | You can run `freeipmi.plugin` with the debug option enabled, to troubleshoot issues with it. The output should give you clues as to why the collector isn't working. |
| 227 | |
| 228 | - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. |
| 229 | |
| 230 | ```bash |
| 231 | cd /usr/libexec/netdata/plugins.d/ |
| 232 | ``` |
| 233 | |
| 234 | - Switch to the `netdata` user. |
| 235 | |
| 236 | ```bash |
| 237 | sudo -u netdata -s |
| 238 | ``` |
| 239 | |
| 240 | - Run the `freeipmi.plugin` in debug mode: |
| 241 | |
| 242 | ```bash |
| 243 | ./freeipmi.plugin 5 debug |
| 244 | ``` |
| 245 | - name: kimpi0 CPU usage |
| 246 | description: | |
| 247 | There have been reports that kipmi is showing increased CPU when the IPMI is queried. To lower the CPU consumption of the system you can issue this command: |
| 248 | |
| 249 | ```sh |
| 250 | echo 10 > /sys/module/ipmi_si/parameters/kipmid_max_busy_us |
| 251 | ``` |
| 252 | |
| 253 | You can also permanently set the above setting by creating the file `/etc/modprobe.d/ipmi.conf` with this content: |
| 254 | |
| 255 | ```sh |
| 256 | # prevent kipmi from consuming 100% CPU |
| 257 | options ipmi_si kipmid_max_busy_us=10 |
| 258 | ``` |
| 259 | |
| 260 | 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. |
| 261 | |
| 262 | You can also use a higher number (this is the number of microseconds to poll IPMI for a response, before waiting for a tick). |
| 263 | alerts: |
| 264 | - name: ipmi_sensor_state |
| 265 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ipmi.conf |
| 266 | metric: ipmi.sensor_state |
| 267 | info: IPMI sensor ${label:sensor} (${label:component}) state |
| 268 | metrics: |
| 269 | folding: |
| 270 | title: Metrics |
| 271 | enabled: false |
| 272 | description: | |
| 273 | The plugin does a speed test when it starts, to find out the duration needed by the IPMI processor to respond. Depending on the speed of your IPMI processor, charts may need several seconds to show up on the dashboard. |
| 274 | availability: [] |
| 275 | scopes: |
| 276 | - name: global |
| 277 | description: These metrics refer to the entire monitored application. |
| 278 | labels: [] |
| 279 | metrics: |
| 280 | - name: ipmi.sel |
| 281 | description: IPMI Events |
| 282 | unit: "events" |
| 283 | chart_type: area |
| 284 | dimensions: |
| 285 | - name: events |
| 286 | - name: sensor |
| 287 | description: "" |
| 288 | labels: |
| 289 | - name: sensor |
| 290 | description: The sensor name |
| 291 | - name: type |
| 292 | description: One of 45 recognized sensor types (Battery, Voltage...) |
| 293 | - name: component |
| 294 | description: One of 25 recognized components (Processor, Peripheral). |
| 295 | metrics: |
| 296 | - name: ipmi.sensor_state |
| 297 | description: IPMI Sensors State |
| 298 | unit: "state" |
| 299 | chart_type: line |
| 300 | dimensions: |
| 301 | - name: nominal |
| 302 | - name: critical |
| 303 | - name: warning |
| 304 | - name: unknown |
| 305 | - name: ipmi.sensor_temperature_c |
| 306 | description: IPMI Sensor Temperature Celsius |
| 307 | unit: "Celsius" |
| 308 | chart_type: line |
| 309 | dimensions: |
| 310 | - name: temperature |
| 311 | - name: ipmi.sensor_temperature_f |
| 312 | description: IPMI Sensor Temperature Fahrenheit |
| 313 | unit: "Fahrenheit" |
| 314 | chart_type: line |
| 315 | dimensions: |
| 316 | - name: temperature |
| 317 | - name: ipmi.sensor_voltage |
| 318 | description: IPMI Sensor Voltage |
| 319 | unit: "Volts" |
| 320 | chart_type: line |
| 321 | dimensions: |
| 322 | - name: voltage |
| 323 | - name: ipmi.sensor_ampere |
| 324 | description: IPMI Sensor Current |
| 325 | unit: "Amps" |
| 326 | chart_type: line |
| 327 | dimensions: |
| 328 | - name: ampere |
| 329 | - name: ipmi.sensor_fan_speed |
| 330 | description: IPMI Sensor Fans Speed |
| 331 | unit: "RPM" |
| 332 | chart_type: line |
| 333 | dimensions: |
| 334 | - name: rotations |
| 335 | - name: ipmi.sensor_power |
| 336 | description: IPMI Sensor Power |
| 337 | unit: "Watts" |
| 338 | chart_type: line |
| 339 | dimensions: |
| 340 | - name: power |
| 341 | - name: ipmi.sensor_reading_percent |
| 342 | description: IPMI Sensor Reading Percentage |
| 343 | unit: "%" |
| 344 | chart_type: line |
| 345 | dimensions: |
| 346 | - name: percentage |