Difference between revisions of "Plugin:IPMI"

From collectd Wiki
Jump to: navigation, search
(Sensor "name" hint)
 
Line 16: Line 16:
  
 
  <Plugin "ipmi">
 
  <Plugin "ipmi">
  Sensor "some_sensor"
+
    Sensor "some_sensor"
  Sensor "another_one"
+
    Sensor "another_one"
  IgnoreSelected false
+
    IgnoreSelected false
  NotifySensorAdd false
+
    NotifySensorAdd false
  NotifySensorRemove true
+
    NotifySensorRemove true
  NotifySensorNotPresent false
+
    NotifySensorNotPresent false
 +
    SELEnabled false
 +
    SELClearEvent false
 
  </Plugin>
 
  </Plugin>
 +
 +
=== Parameters ===
 +
 +
{| class="wikitable"
 +
|-
 +
! <br />Name
 +
! <br />Description
 +
! <br />Comment
 +
|-
 +
| <br />Interval
 +
| <br />The interval  within which to retrieve information about  sensors in seconds
 +
| <br />Interval option is supported by collectd  and is defined in <LoadPlugin> block. No additional functionality  should be developed in ipmi  plugin  to support this option.
 +
|-
 +
| <br />Sensor
 +
| <br />Selects sensors to  collect information.
 +
| <br />Depends on ignoreSelected.
 +
|-
 +
| <br />IgnoreSelected
 +
| <br />If TRUE, selects  all sensors except those defined in Sensor.  Else all sensors from the list of Sensor will  be selected.
 +
| <br />If no  configuration if given, the ipmi plugin will collect data from all sensors  found.
 +
|-
 +
| <br />NotifySensorAdd
 +
| <br />Enables or  disables notification to be send when sensor appears.
 +
| <br />If a sensor  appears after initialization time of a minute a notification is sent.
 +
|-
 +
| <br />NotifySensorRemove
 +
| <br />Enables or  disables notification to be send when sensor disappears.
 +
| <br />If a sensor  disappears a notification is sent.
 +
|-
 +
| <br />NotifySensorNotPresent
 +
| <br />Enables or  disables notification to be send when sensor has been (un)plugged.
 +
| <br />If you have for  example dual power supply and one of them is (un)plugged then a notification  is sent.
 +
|-
 +
| <br />SELEnabled
 +
| <br />Enables or  disables subscription for SEL events.
 +
| <br />If system event  log (SEL) is enabled, plugin will listen for sensor threshold and discrete  events. When event is received the notification is sent.
 +
|-
 +
| <br />SELClearEvent
 +
| <br />Enables or  Disables clearing the event after successful handling.
 +
| <br />If SEL clear event  is enabled, plugin will delete event from SEL list after it is received and  successfully handled. In this case other tools that are subscribed for SEL  events will receive an empty event.
 +
|}
 +
 +
== Metrics ==
 +
 +
{| class="wikitable" style="background-color:#FFF;"
 +
|-
 +
! <br />Technology/Category
 +
! <br />Metric/Feature Name
 +
! <br />Date Type
 +
! <br />Format Example
 +
! <br />Collectd Release
 +
! <br />Collectd Plugin
 +
! <br />Description
 +
! <br />Dependencies
 +
! <br />Limitations
 +
! <br />Comments
 +
|-
 +
| <br />IPMI
 +
| <br />Fan  Speed
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Reads  multiple fan speed
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|-
 +
| <br />IPMI
 +
| <br />Air  Flow
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Reads  systemair flow data of system chassis
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|-
 +
| <br />IPMI
 +
| <br />Power  Supply
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Read  the power supply for the CPU
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|-
 +
| <br />IPMI
 +
| <br />Thermal  Control
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Reads  the Thermal Control percentage for CPU
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|-
 +
| <br />IPMI
 +
| <br />Temperature
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Reads  temperature of different compenents in the base board
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|-
 +
| <br />IPMI
 +
| <br />Voltage
 +
| <br />Char  & Int
 +
| <br />None
 +
| <br />5.8
 +
| <br />ipmi
 +
| <br />Reads  voltage on system board
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Gets  Metric from SDR.
 +
|}
  
 
== Example graphs ==
 
== Example graphs ==
Line 31: Line 156:
  
 
* [http://openipmi.sourceforge.net/ OpenIPMI library]
 
* [http://openipmi.sourceforge.net/ OpenIPMI library]
 +
 +
== See Also ==
 +
 +
* [https://wiki.opnfv.org/display/fastpath/IPMI IPMI plugin high level design document]
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
{{DEFAULTSORT:Ipmi}}
 
{{DEFAULTSORT:Ipmi}}

Latest revision as of 17:11, 2 July 2020

IPMI plugin
Type: read
Callbacks: config, init, read, shutdown
Status: supported
First version: 4.4
Copyright: 2008–2009 Florian octo Forster
2008 Peter Holik
2009 Bruno Prémont
License: GPLv2
Manpage: collectd.conf(5)
List of Plugins

The IPMI plugin uses the OpenIPMI library to read hardware sensors from servers using the Intelligent Platform Management Interface (IPMI). IPMI is very common with server hardware but usually not available in consumer hardware.

It might be reasonable to start with no specific configuration for sensors and look up the exact names after suitable sensor data has been logged since the strings needed aren't exactly ipmitool sdr names.

Synopsis

<Plugin "ipmi">
    Sensor "some_sensor"
    Sensor "another_one"
    IgnoreSelected false
    NotifySensorAdd false
    NotifySensorRemove true
    NotifySensorNotPresent false
    SELEnabled false
    SELClearEvent false
</Plugin>

Parameters


Name

Description

Comment

Interval

The interval within which to retrieve information about sensors in seconds

Interval option is supported by collectd and is defined in <LoadPlugin> block. No additional functionality should be developed in ipmi plugin to support this option.

Sensor

Selects sensors to collect information.

Depends on ignoreSelected.

IgnoreSelected

If TRUE, selects all sensors except those defined in Sensor. Else all sensors from the list of Sensor will be selected.

If no configuration if given, the ipmi plugin will collect data from all sensors found.

NotifySensorAdd

Enables or disables notification to be send when sensor appears.

If a sensor appears after initialization time of a minute a notification is sent.

NotifySensorRemove

Enables or disables notification to be send when sensor disappears.

If a sensor disappears a notification is sent.

NotifySensorNotPresent

Enables or disables notification to be send when sensor has been (un)plugged.

If you have for example dual power supply and one of them is (un)plugged then a notification is sent.

SELEnabled

Enables or disables subscription for SEL events.

If system event log (SEL) is enabled, plugin will listen for sensor threshold and discrete events. When event is received the notification is sent.

SELClearEvent

Enables or Disables clearing the event after successful handling.

If SEL clear event is enabled, plugin will delete event from SEL list after it is received and successfully handled. In this case other tools that are subscribed for SEL events will receive an empty event.

Metrics


Technology/Category

Metric/Feature Name

Date Type

Format Example

Collectd Release

Collectd Plugin

Description

Dependencies

Limitations

Comments

IPMI

Fan Speed

Char & Int

None

5.8

ipmi

Reads multiple fan speed





Gets Metric from SDR.

IPMI

Air Flow

Char & Int

None

5.8

ipmi

Reads systemair flow data of system chassis





Gets Metric from SDR.

IPMI

Power Supply

Char & Int

None

5.8

ipmi

Read the power supply for the CPU





Gets Metric from SDR.

IPMI

Thermal Control

Char & Int

None

5.8

ipmi

Reads the Thermal Control percentage for CPU





Gets Metric from SDR.

IPMI

Temperature

Char & Int

None

5.8

ipmi

Reads temperature of different compenents in the base board





Gets Metric from SDR.

IPMI

Voltage

Char & Int

None

5.8

ipmi

Reads voltage on system board





Gets Metric from SDR.

Example graphs

IPMI.png

Dependencies

See Also