This table contains definitions for the fields in the server telemetry and profile telemetry YAML files.
For more information about telemetry, telemetry metric reports, and attributes (fields), see Telemetry streaming basics and Telemetry metric report definitions.
Field | Description | Supported values |
Rsys Log: Remote syslog implements the basic syslog protocol, and extends it with content-based filtering, rich filtering capabilities, and flexible configuration options. | ||
rsyslogServer1 | Remote syslog server 1 address IPv4, IPV6, or FQDN | IP address |
rsyslogServer1Port | Remote syslog server 1 port | Port number |
rsyslogServer2 | Remote syslog server 2 address IPv4, IPV6, or FQDN | IP address |
rsyslogServer2Port | Remote syslog server 2 port | Port number |
Supported telemetry reports: | ||
AggregationMetrics | Contains base metric values for power, temperature, and CUPS (CPU, Memory, IO, System). | Not applicable |
CPUMemMetrics | Contains CPU Memory metrics | |
CPURegisters | On Intel platform the report represents the MSR registers and on AMD platform the report represents the MCA registers. The CPU Register dump is platform specific. | |
FCPortStatistics | Contains Fibre Channel Port statistics | |
FCSensor | Contains FC temperature reading | |
FPGASensor | Contains Field Programmable Gate Arrays (FPGA) temperature reading. | |
FanSensor | Contains RPM reading | |
GPUMetrics | Conatins Graphics Processing Unit Health metrics | |
GPUStatistics | Contains Graphics Processing Unit Frame Buffer and Graphic Device (GR) memory ECC(Error-correcting code) statistics data. | |
MemorySensor | Contains memory temperature reading | |
NICSensor | Conatins Network Card temperature reading | |
NICStatistics | Contains NIC Port and Partition Statistics | |
NVMeSMARTData | Contains NVMe SMART Health record | |
PSUMetrics | Contains power supply metrics | |
PowerMetrics | Contains power consumption for all CPUs, DIMMs, System Input and System Output. | |
PowerStatistics | Contains system power consumption statistics | |
Sensor | Contains all IPMI reading | |
SerialLog | SerialLog Report (Server serial logs) | |
StorageDiskSMARTData | Contains SSSD SMART information | |
StorageSensor | Contains temperature information for the storage internal drives | |
SystemUsage | Contains system usage in percentage. This report is platform-dependent, and the data may not be available on all platforms. | |
ThermalMetrics | Contains thermal metrics | |
ThermalSensor | Contains temperature reading | |
Telemetry report attributes: | ||
metricReportState | Enables metric report definition | Enabled or disabled |
metricReportType | Specifies the type of metric report | Periodic onChange onRequest |
reportActions | Specifies what occurs when a report is generated as per the metricReportType. | Example: LogToMetricReportsCollection RedfishEvent |
reportUpdates | Specifies what to do with subsequent metric reports when a metric report exists. | AppendStopsWhenFull AppendWrapsWhenFull NewReport Overwrite |
suppressRepeatedMetricValue | Suppresses the repeated metric value | Enabled or disabled |
metricReportHeartbeatInterval | Periodically forces a report that contains at least one value for every currently valid metric. This property is a Redfish duration and should always be greater than or equal to the | Example: PT0H0M0S |
recurrenceInterval | Specifies a Redfish duration string. This property is only valid for Periodic reports. | Example: PT0H5M0S |
reportTimeSpan | Specifies the duration of the report | Example: PT0H5M0S |