Lines Matching full:report
26 with metrics report and trigger management. This service is described later in
44 - Metric Report Definitions - defines how metric report shall be created (which
47 generated according to the Metric Report Definitions
77 | | | | Metric | | Metric | |Metric report| | | | Redfish | | | |
86 | | | +--------> report <---------+ | | | | |
98 [Redfish Telemetry Model][1]. Metric report definitions uses Redfish sensors
99 URIs for metric report creation. Those sensors are also used to get URI->D-Bus
113 Metric Report Definition resource for each sensor's metric.
115 Telemetry service supports creating and managing metric report, which may
116 contain single or multiple metrics from sensors. This metric report is mapped to
117 Metric Report for the Redfish Telemetry Service.
119 The diagram below shows the flows for creation and update of metric report.
128 |Metric report definition flow| | | |
134 | | report | | | |
144 | | HTTP response | +-+Create Report | |
146 | | Metric Report | Report D-Bus path <-+ | |
154 |Periodic metric report update flow| | | |
155 +----------------------------------+ +-+Metric report | |
157 | | | <-+report update | |
161 | | Send report as SSE or push-style event | | |
168 | | Report URI | | Sensor's Properties- | |
170 | | +-+Map report's URI <--------------------------+ |
174 | | | on report D-Bus | |PropertiesChanged | | |
176 | | +-----------------------> |to metric report timer| | |
178 | | Return metric | Return report data | |thing that triggers | | |
179 | | report in JSON <-----------------------+ |metric report update | | |
186 |On change metric report update flow| | Sensor's Properties- | |
191 | | | | |triggers report | |
196 | | Send report as SSE or push-style event | | |
203 | | Report URI | | | |
205 | | +-+Map report's URI | | |
209 | | | on report D-Bus | |signal triggers the | | |
210 | | | object | |report update. It is | | |
213 | | Return metric | Return report data | |sensor triggers report| | |
214 | | report in JSON <-----------------------+ |update. | | |
221 |On demand metric report update flow| | | |
225 | | Report URI | | | |
227 | | +-+Map report's URI | | |
232 | | | method for report | | |
236 | | | | |report to be updated | |
243 | | Send report as SSE or push-style event | | |
254 | | | on report D-Bus | | |
258 | | Return metric | Return report data | | |
259 | | report in JSON <-----------------------+ | |
269 service. Sending metric report as SSE or push-style events shall be done via the
270 [Redfish Event Service][6]. It is marked as optional because metric report does
273 In case of on demand metric report update, Telemetry service performs no
280 for reading report management. The second one will be used for triggers
283 ### Reading report management
285 The reading report management D-Bus object:
293 [`xyz.openbmc_project.Telemetry.ReportManager`][8] for report management. The
295 implements `AddReport` method, which is used to create a metric report. The
296 report may contain a single or multiple sensor readings. The way how the report
301 The `AddReport` method returns the path to the newly created report object. The
302 report object implements the [`xyz.openbmc_project.Object.Delete`][10] and
303 [`xyz.openbmc_project.Telemetry.Report`][9] interfaces. The [`Delete`][10]
304 interface is defined to add support for removing Report object, while the
305 [`Report`][9] interface implements methods and properties for Report management
306 along with properties containing telemetry readings. Each report object contains
307 the timestamp of its last update. The report object contains an array of
309 this metric. Each report has also the property that stores update interval (for
358 metric report update.
367 …report which update shall be triggered when trigger condition occurs. This is optional and shall b…
418 …isting reading report. This is required when trigger's action is to update metric report. This pat…
462 report pointed by it's D-Bus path contained in trigger object properties. The
463 update shall cause the reading report's D-Bus object to emit property change
464 signal. This will cause Redfish Metric Report to be streamed out if it was
470 resources. Metric report definitions determines which metrics are to be include
471 in metric report. Metric definition is assigned to particular metric type and it
501 |Triggers | |Metric | |Metric report | |
507 | | | | | | | | report 1 | | Reads | Power |
517 | | Triggers report update | |
526 The diagram shows the relations between Redfish resources. Metric report is
528 Metric Report contains the URI to its metric definition and Redfish sensor,
570 Sample metric report definition:
576 "Name": "Sample Metric Report Definition",
602 Sample metric report:
608 "Name": "Sample Metric Report",
629 Sample trigger, that will trigger metric report update:
670 statistics are shown in the table below. The reading report is mapped into
671 single Metric Report. The runtime data is collected for the Telemetry component
684 | 1 report, 1 sensor | 5188 B | 1% | 1% |
686 | 2 reports, 2 sensors (1 sensor per report) | 5188 B | 1% | 1% |
687 | 1 report, 10 sensors | 5188 B | 1% | 1% |
688 | 10 reports, 10 sensors (same for each report) | 5320 B | 1% | 1-2% |
689 | 2 reports, 20 sensors (10 per report) | 5188 B | 1% | 1% |
690 | 30 reports, 30 sensors (10 per report) | 5444 B | 1% | 5-9% |
691 | 50 reports, 50 sensors (10 per report) | 5572 B | 1% | 11-14% |
693 The last two configurations use 10 sensors per reading report, which gives 3 or
697 In this architecture reading report is created every time when Redfish Metric
698 Report Definition is posted (creating new Metric Report).
788 shall contain creating metric report by POSTing proper metric report definition,
789 reading metric report (using GET on proper URI) and deleting the metric report.
798 scenarios with sending metric report as an event, triggering metric report
806 periodic metric report jitter, delays in event logging or sending, BMC's CPU
821 …enbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Telemetry/Report.interface.yaml