White Papers

Document 499
LogToMetricReportsCollection
The generated metric report is added to the Metric Reports
collection with an “Id” matching the report definition.
RedfishEvent
The generated metric report is sent as a “Metric Report” event type
to all subscribers: SSE Subscribers, POST Subscribers, and
RSYSLOG subscribers. The report is not saved to the metric reports
collection unless “LogToMetricReportsCollection” is also specified.
Note that the individual subscription types may further have facilities
to filter which reports are sent. For example, SSE can query on only
specific reports. This is property provides base enablement but does
not force this report into streams that have filters.
ReportUpdates – This property controls how subsequent reports are handled after the first report is
generated.
AppendStopsWhenFull
Each time the report is generated, the new metric values are added
to the end of the MetricValues array. The report can contain up to
an “AppendLimit” (not user configurable, described below) number
of metric values. Once the maximum number of metric values have
been added, no more will be added to the report and the
MetricReportDefinition is automatically disabled. The user must
PATCH the MetricReportDefinition back to enable the report to
restart the report generation.
Reports will not stream after they have stopped. The detection of
hitting append limit is ‘asynchronous’, done periodically as a
background task, so streaming may not immediately stop, but
should stop within 15 minutes of hitting the limit.
AppendWrapsWhenFull
When the report is created, new Metrics are added to the
MetricValues array, keeping existing entries.
Once there are more than “AppendLimit” number of metric values
in the MetricValues array, older entries above the AppendLimit
number are dropped from the report.
NewReport
A new report is added, with a name generated taking the report
definition name as a base and adding a dash, then the current
date/time.
Since this implies that many older reports are available under the
older names, this can present a challenge to iDRAC, so defining
this specific behavior for allows:
• Deleting any report that is already processed and is not needed
any more.
• Automatic deletion of reports that are older than the last three,
as iDRAC will keep at most three completed metric reports per
report definition.
Overwrite
Overwrites the older report with a report of the same name
containing newer data. This is the default.
SuppressRepeatedMetricValue – If Enabled, new metrics are added to the MetricValue array if they are
different from the last reported metric. For a single report, if a metric value does not change, it is not added
again.