docs/designs/hw-fault-monitor.md

7 - Heinz Boehmer Fiehn <heinzboehmer@google.com>
8 - Drew Walton <acwalton@google.com>
25 locally analyze fault and sensor information and then based on specified
34 - Host Error Monitor logs CPU error information such as CATERR details and takes
36   <https://github.com/openbmc/host-error-monitor>
38 - bmcweb implements a Redfish webserver for openbmc:
43 - Phosphor Debug Collector (phosphor-debug-collector) collects various debug
45   <https://github.com/openbmc/phosphor-debug-collector>
47 - Dbus-sensors reads and saves sensor values and makes them available to other
48   modules via D-Bus: <https://github.com/openbmc/dbus-sensors>
50 - SEL logger logs to the IPMI and Redfish system event logs when certain events
52   <https://github.com/openbmc/phosphor-sel-logger>
54 - FRU fault manager controls the blinking of LEDs when faults occur:
55   <https://github.com/openbmc/phosphor-led-manager/blob/master/fault-monitor/fru-fault-monitor.hpp>
57 - Guard On BMC records and manages a list of faulty components for isolation.
60 …<https://github.com/openbmc/docs/blob/9c79837a8a20dc8e131cc8f046d1ceb4a731391a/designs/guard-on-bm…
68 - The users of this solution are Redfish clients in data center software. The
73 - The fault monitor must be able to handle receiving fault information that is
75   based on fault incidents (e.g. crash dumps).
77 - The fault monitor should allow for logging of a variety of sizes of fault
78   information entries (on the order of bytes to megabytes). In general, more
83 - Fault information must be added to a Redfish LogService in a timely manner
87 - The fault monitor must allow for custom overwrite rules for its log entries
88   (e.g. on overflow, save first errors and more severe errors), or guarantee
90   recent couple of hours is always kept intact. The log does not have to be
98 - On CATERR, the Host Error Monitor requests a crash dump (this is an existing
100   platform-specific system-level data. The fault monitor would therefore
101   additionally collect system-level data such as clock, thermal, and power
103   the crash dump so that it could be post-processed by data center monitoring
106 - The fault monitor would monitor link level retries and link retrainings of
114 - In order to monitor memory out of band, a system could be configured to give
124 host-error-monitor, bmcweb, and phosphor-debug-collector.
127 functionality needed for the fault monitor. For instance, based on the needs of
128 the OEM, the fault monitor will register to be notified of D-Bus signals of
135 log. The fault monitor may also gather relevant sensor data (read via D-Bus from
136 the dbus-sensors services) and add it to the fault log, with a reference to the
148 D-bus object (e.g. xyz/openbmc_project/dump/faultlog) whose interface will
161 Redfish fault log entry to a Redfish client, large-sized fault information (e.g.
162 crashdumps) can be specified as an attachment sub-resource (AdditionalDataURI)
167 of any repair actions that need to be triggered based on the latest fault
183 the version matching the BMC software running on a machine. In such cases,