White Papers

ManualsBrandsDell ManualsConverged InfrastructureEnterprise Solution Resources

Table Of Contents

Document 499

White Paper

Telemetry Metric Report Definition Explained

This Whitepaper explains different parameters of Metric Report Definitions that are configurable using Redfish, Server

Configuration Profile (SCP), and iDRAC Graphical User Interface for the desired telemetry report data and the streaming

behavior.

August 2021

Revisions

Date

Description

August 2021

Initial release

Acknowledgments

Authors: Ankita Goyal, Cyril Jose, Sankara Gara, Michael E Brown

The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the information in this

publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.

Use, copying, and distribution of any software that is described in this publication requires an applicable software license.

subsidiaries. Other trademarks may be trademarks of their respective owners. [8/17/2021] [White Paper] [Document 499]

Summary of content (19 pages)

PAGE 1
White Paper Paper White Telemetry Metric Report Definition Explained This Whitepaper explains different parameters of Metric Report Definitions that are configurable using Redfish, Server Configuration Profile (SCP), and iDRAC Graphical User Interface for the desired telemetry report data and the streaming behavior.
PAGE 2
Table of contents Revisions.............................................................................................................................................................................1 Acknowledgments ...............................................................................................................................................................1 Table of contents ...................................................................................................................
PAGE 3
Executive summary With iDRAC9 v4.00.00.00, Dell EMC introduced the Telemetry Streaming solution for PowerEdge servers. The feature enables IT managers to integrate advanced server hardware operations telemetry into their existing analytics solutions. iDRAC9 v4.40 introduces custom configuration of metric report definition through Redfish and Server Configuration Profile methods.
PAGE 4
1. Introduction Metric Report Definitions defines the backbone of telemetry metric reports. The paper describes definitions of the properties in Metric Report Definitions. Custom telemetry configuration is DMTF Redfish compliant, and this paper discusses the iDRAC behavior for each configuration options. 1.1 Terms and Definition To this technical white paper, following terms and definitions apply: MRD – Metric Report Definitions MR – Metric Report MD – Metric Definitions 1.
PAGE 5
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.
PAGE 6
LogToMetricReportsCollection RedfishEvent The generated metric report is added to the Metric Reports collection with an “Id” matching the report definition. 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.
PAGE 7
Depending on the specific report configuration (“ReportUpdates”, and “MetricReportDefinitionType”), the report level behavior differs. SuppressRepeatedMetricValue prevents addition of consecutive duplicate metric values to a specific metric value stream. Default is “Disabled” for new custom reports. MetricReportHeartbeatInterval – For metric reports that have SuppressRepeatedMetricValues (“suppress”) set to true, some metrics may not change for a very long time and fail to show up in many reports.
PAGE 8
MetricId All the user to select all metrics with the corresponding matched ID to add to the report. All selection criteria here and below are considered (“AND”ed) together to select metrics. MetricProperties Array of URIs of properties included in this metric. This property is not implemented. Allows you to to specify the data source to include. OEM/Dell/Source This is logically “AND”-ed with the metric id and FQDD, if specified.
PAGE 9
3. Sample Metric Report Definitions 3.1 Report with all metrics relevant for CPU.Socket.% Device { "@odata.type": "#MetricReportDefinition.v1_3_3.MetricReportDefinition", "@odata.context": "/redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition", "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/CPUUberReport", "Id": "CPUUberReport", "Name": "All CPU metrics", "Description": "A report with all datapoints relevant to a specific device.
PAGE 10
"Wildcards@odata.count": 0, "Schedule": { "RecurrenceInterval": "PT0H1M0S" }, "MetricReport": { "@odata.id": "/redfish/v1/TelemetryService/MetricReports/CPUUberReport" }, "Metrics": [ { "MetricId": null, "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": null, "CollectionDuration": null, "CollectionTimeScope": "Point", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": "CPU.Socket.
PAGE 11
"@odata.
PAGE 12
{ "MetricId": "TemperatureReading", "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": null, "CollectionDuration": null, "CollectionTimeScope": "Point", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": null, "Source": null } } }, { "MetricId": "RPMReading", "MetricProperties": [], "MetricProperties@odata.
PAGE 13
3.3 Report with System Usage Aggregations { "@odata.type": "#MetricReportDefinition.v1_3_3.MetricReportDefinition", "@odata.context": "/redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition", "@odata.
PAGE 14
"MetricReport": { "@odata.id": "/redfish/v1/TelemetryService/MetricReports/SystemUsageAggregations" }, "Metrics": [ { "MetricId": "CPUUsage", "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": "Average", "CollectionDuration": "PT0H1M0S", "CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.
PAGE 15
"@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": null, "Source": null } } }, { "MetricId": "IOUsage", "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": "Average", "CollectionDuration": "PT0H1M0S", "CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.
PAGE 16
"CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": null, "Source": null } } }, { "MetricId": "MemoryUsage", "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": "Average", "CollectionDuration": "PT0H1M0S", "CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.
PAGE 17
"MetricProperties@odata.count": 0, "CollectionFunction": "Minimum", "CollectionDuration": "PT0H1M0S", "CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": null, "Source": null } } }, { "MetricId": "AggregateUsage", "MetricProperties": [], "MetricProperties@odata.
PAGE 18
{ "MetricId": "AggregateUsage", "MetricProperties": [], "MetricProperties@odata.count": 0, "CollectionFunction": "Minimum", "CollectionDuration": "PT0H1M0S", "CollectionTimeScope": "Interval", "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.DellMetricReportDefinit ion", "CustomLabel": null, "FQDD": null, "Source": null } } } ], "Metrics@odata.count": 12, "Links": { "Triggers": [], "Triggers@odata.count": 0 }, "Oem": { "Dell": { "@odata.type": "#DellMetricReportDefinition.v1_1_0.
PAGE 19
A Technical support and resources • iDRAC Telemetry Workflow Examples 1) GitHub - dell/iDRAC-Telemetry-Reference-Tools: Reference toolset for PowerEdge telemetry metric collection and integration with analytics and visualization solutions. 2) https://github.com/dell/iDRAC-Telemetry-Scripting/ • Open source iDRAC REST API with Redfish Python and PowerShell examples. https://github.