docs/designs/hw-fault-monitor.md

23 locally analyze fault and sensor information and then based on specified
32 - Host Error Monitor logs CPU error information such as CATERR details and takes
34   https://github.com/openbmc/host-error-monitor
36 - bmcweb implements a Redfish webserver for openbmc:
41 - Phosphor Debug Collector (phosphor-debug-collector) collects various debug
43   https://github.com/openbmc/phosphor-debug-collector
45 - Dbus-sensors reads and saves sensor values and makes them available to other
46   modules via D-Bus: https://github.com/openbmc/dbus-sensors
48 - SEL logger logs to the IPMI and Redfish system event logs when certain events
50   https://github.com/openbmc/phosphor-sel-logger
52 - FRU fault manager controls the blinking of LEDs when faults occur:
53   https://github.com/openbmc/phosphor-led-manager/blob/master/fault-monitor/fru-fault-monitor.hpp
55 - Guard On BMC records and manages a list of faulty components for isolation.
58 …https://github.com/openbmc/docs/blob/9c79837a8a20dc8e131cc8f046d1ceb4a731391a/designs/guard-on-bmc…
66 - The users of this solution are Redfish clients in data center software. The
71 - The fault monitor must be able to handle receiving fault information that is
73   based on fault incidents (e.g. crash dumps).
75 - The fault monitor should allow for logging of a variety of sizes of fault
76   information entries (on the order of bytes to megabytes). In general, more
81 - Fault information must be added to a Redfish LogService in a timely manner
85 - The fault monitor must allow for custom overwrite rules for its log entries
86   (e.g. on overflow, save first errors and more severe errors), or guarantee
96 - On CATERR, the Host Error Monitor requests a crash dump (this is an existing
98   platform-specific system-level data. The fault monitor would therefore
99   additionally collect system-level data such as clock, thermal, and power
101   the crash dump so that it could be post-processed by data center monitoring
104 - The fault monitor would monitor link level retries and link retrainings of
112 - In order to monitor memory out of band, a system could be configured to give
122 host-error-monitor, bmcweb, and phosphor-debug-collector.
125 functionality needed for the fault monitor. For instance, based on the needs of
126 the OEM, the fault monitor will register to be notified of D-Bus signals of
133 log. The fault monitor may also gather relevant sensor data (read via D-Bus from
134 the dbus-sensors services) and add it to the fault log, with a reference to the
146 D-bus object (e.g. xyz/openbmc_project/dump/faultlog) whose interface will
159 Redfish fault log entry to a Redfish client, large-sized fault information (e.g.
160 crashdumps) can be specified as an attachment sub-resource (AdditionalDataURI)
165 of any repair actions that need to be triggered based on the latest fault
181 the version matching the BMC software running on a machine. In such cases,
182 consumers can ignore any types of fault information provided by the fault