White Papers

Document 499
2. Metric Report Definition Properties
2.1 Configurable Properties
MetricReportDefinitionEnabled – This property is used to enable or disable the report. After uploading
the Report Definition, perform PATCH method on this property to dynamically enable or disable the
report. Default is “false”.
MetricReportDefinitionType – Defines the type of the metric report that is generated from the metric
report definition.
Periodic
This is the default for any new reports that are uploaded with unspecified type.
This type of report must have a “Schedule” object with a “RecurrenceInterval”
property. The report is repeatedly generated on a periodic basis as requested
in the “Schedule/RecurrenceInterval” property, with the report being generated
at the expiry of the time period specified by “Schedule/RecurrenceInterval”
property. When metric reports are generated, the report includes metrics
greater than the previous report timestamp up to and including the new report
timestamp.
If a “ReportTimespan” is also present, the resulting metric value list includes
the set-wise union of values that are covered by ReportTimespan and metric
values with timestamps in the interval of previous ReportTimestamp to current
ReportTimestamp.
OnChange
This report is generated anytime a referenced metric change. To prevent
overloading several subsystems with reports, the minimum time between
reports is 10 seconds. If multiple metrics are changed during the 10 seconds
“cooling off” period, all metrics that have changed up until the report generation
time are included in the report.
For “OnChange” reports, a non-null “TimeSpan” property is mandatory, the
“SuppressRepeatedMetricValue
” property is required to be set to true. The
report shall contain all metrics values newer than “Report Timestamp –
TimeSpan” up until the Report Timestamp. Additionally, “OnChange” requires
HeartBeatInterval and schedule to be cleared.
OnRequest
This report is generated when there is a HTTP GET in the report. The report
contains all metrics values newer than Now() - ReportTimeSpan.
Other Requirements:
• ReportUpdates field is IGNORED in input. Output will be fixed to
AppendWrapsWhenFull
• ReportActions field is IGNORED in input. Output will be fixed to
LogToMetricReportsCollection
• ReportTimeSpan must have a value greater than 0
• Schedule property must be either not present in input, or the
RecurrenceInterval must be ‘null’ or equivalent to any variant of ‘PT0S’.
ReportActions – This property specifies what should happen when a report is generated per the
MetricReportDefinitionType, above. The property is an ARRAY, containing zero or more of the following
settings. Note that if no settings are specified, it disables the report. Default is
[“LogToMetricReportsCollection”, “RedfishEvent”]