MetricsHub
MetricsHub Community Connectors 1.0.24
-
Home
- Connector Developer Guide Sources 21
ipmiSel (Source)
When To Use
Use ipmiSel to report the hardware events a BMC logged in its System Event Log (SEL) between two polls: a power supply failure, a memory ECC error, an intrusion, a fan failure… even when the sensor is back to normal by the time the ipmi source reads it.
The source only returns the entries added since its previous poll, one row per entry. The first poll locates the end of the log without reading it and returns nothing; a restart of the agent starts again with an empty first poll. When the log is cleared on the BMC, the entries logged after the clear are returned from the first one.
Syntax
sources:
selEvents:
type: ipmiSel
maxEventsPerPoll: 50
Properties
| Property | Required | Default | Description |
|---|---|---|---|
type |
Yes | None | ipmiSel. |
maxEventsPerPoll |
No | 50 |
Maximum entries returned by one poll; the entries left out come with the next poll. Use -1 for unlimited. |
executeForEachEntryOf |
No | None | Execute with fan-out context from another source. |
computes |
No | [] |
Post-processing computes. |
forceSerialization |
No | true |
Always on: the IPMI requests of a connector to a host are serialized whatever the value, since a BMC accepts few simultaneous sessions. |
Output
One row per entry, in the order of the log:
recordId;timestamp;sensorType;sensorNumber;sensorName;entity;eventType;description;direction;generatorId;oem
| Column | Content |
|---|---|
recordId |
The SEL record ID, decimal. |
timestamp |
Seconds since the epoch, UTC; empty for the entries logged before the BMC had the time. Some BMCs keep their SEL clock in local time without saying so. |
sensorType |
The sensor type of a system event: Temperature, PowerSupply, Memory, Fan, PhysicalSecurity…; Oem C0h for an OEM sensor type; empty for an OEM record. |
sensorNumber |
The sensor number, 2 uppercase hexadecimal digits; empty for an OEM record. |
sensorName |
The name of the sensor that logged the event, from the SDR repository (PS1 Status); empty when no sensor matches. |
entity |
The entity of that sensor, as in the ipmi source device lines (Power Supply 1); empty when no sensor matches. |
eventType |
The event/reading type code, 2 uppercase hexadecimal digits (01 threshold, 6F sensor-specific); empty for an OEM record. |
description |
The event in words: Power Supply Failure detected, Upper Critical - going high, Uncorrectable ECC…; OEM data ... for an OEM record. |
direction |
Assertion or Deassertion; empty for an OEM record. |
generatorId |
The generator ID of a system event, 4 uppercase hexadecimal digits; empty for an OEM record. |
oem |
For an OEM record: the manufacturer ID as 6 uppercase hexadecimal digits when the record carries one, then its data bytes in hexadecimal, space-separated. |
Example:
17;1761640530;PowerSupply;0A;PS1 Status;Power Supply 1;6F;Power Supply Failure detected;Assertion;0020;
18;1761640531;Fan;21;Fan 2;Fan Device 2;01;Lower Critical - going low;Assertion;0020;
19;;;;;;;OEM data 01 02 03 04 05 06;;;000157 01 02 03 04 05 06
Recommended Pattern
- Keep a bounded
maxEventsPerPoll: a BMC that logs a burst (a flapping sensor) is drained over several polls. - Filter on
sensorType,eventTypeanddirectionwith computes before mapping, and key the monitor onentityto attach the event to the device theipmisource discovered. - Prefer
descriptionover the event data bytes: it is the wording ofipmiutil, the same on every BMC.
A discovery or simple job that reads an ipmiSel source, directly or through ${source::...} references, never removes its instances: the source only returns the entries added since the previous poll, so a missing row does not mean a missing entity (see When Instances Are Removed[1]).
Common Mistakes
- Expecting the backlog of the log on the first poll: it is skipped by design (the
ExecuteIpmiQueryMCP tool reads the whole log, or the lastsinceduration). - Reading the sensor name of an OEM record: only system events (record type
02h) carry a sensor. - Comparing
timestampwith the agent clock on a BMC whose SEL clock is in local time, or not set (timestampempty).
Related
- [1] ../monitors-and-jobs.html#when-instances-are-removed
- [2] ./ipmi.html
- [3] ./ipmi-raw.html
