docs/designs/bmc-health-monitor.md

16 For this purpose, there may exist a metric producer (the subject of discussion
17 of this document), and a metric consumer (a program that makes use of health
23 2. Metric collection, similar to what the read routine in phosphor-hwmon-readd
25 3. Metric staging. When metrics are collected, they will be ready to be read
64 The metric producer should provide
72 - Capability to provide granular details for various metric types, for example -
81 The metric consumer may be written in various different ways. No matter how the
85 The metric consumer is not in the scope of this document.
89 The metric producer is a daemon running on the BMC that performs the required
94 2. Metric collection and
95 3. Metric staging & disperse tasks
147 For 2) Metric collection, this will be done by running certain functions within
151 For 3) Metric staging & disperse, the daemon creates a D-bus service named
157 | xyz.openbmc_project.Metric.Value     | Interface to represent value for Metrics.                 …
158 | xyz.openbmc_project.Metric.Reset     | Interface to reset persistent Metrics counters.           …
159 | xyz.openbmc_project.Common.Threshold | Interface to represent Metric thresholds and signals for t…
160 | xyz.openbmc_project.Time.EpochTime   | Interface to indicate when the metric was collected.      …
162 Each metric will be exposed on a specific object path and above interfaces will
167     |- /xyz/openbmc_project/metric/bmc/memory/total
168     |- /xyz/openbmc_project/metric/bmc/memory/free
169     |- /xyz/openbmc_project/metric/bmc/memory/available
170     |- /xyz/openbmc_project/metric/bmc/memory/shared
171     |- /xyz/openbmc_project/metric/bmc/memory/buffered_and_cached
172     |- /xyz/openbmc_project/metric/bmc/cpu/user
173     |- /xyz/openbmc_project/metric/bmc/cpu/kernel
174     |- /xyz/openbmc_project/metric/bmc/reboot/count
175     |- /xyz/openbmc_project/metric/bmc/reboot/count_with_failure
192 /xyz/openbmc_project/metric/device-0/memory/total
193 /xyz/openbmc_project/metric/device-1/memory/total
199 interface for each metric would need to be associated with the appropriate
205 In comparison, having the metric collection part a separate daemon is better for
208 We have also tried doing the metric collection task by running an external
245 Most of what the Health Monitoring Daemon does is to do metric collection and
273 generated by the Daemon and the metric values from Daemon’s DBus objects.