Skip to main content

​
Redfish Receiver

Status Maintainers: @steven-freed, @khushijain21 Source: opentelemetry-collector-contrib

​
Supported Telemetry

Metrics

​
Overview

​
Purpose

The purpose of this component is to monitor devices running a Redfish API which is quite often a BMC (Baseboard Management Controller) such as; Dell iDRAC, HPE iLO, etc.

​
Prerequisites

This receiver supports Redfish versions:
  • v1

​
Configuration

These configuration options are for connecting to Redfish API servers. The following settings are optional:
  • collection_interval: (default = 60s): This receiver collects metrics on an interval. This value must be a string readable by Golang’s time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.
  • initial_delay (default = 0s): defines how long this receiver waits before starting.
  • servers: The list of redfish servers to be monitored.
Each server has the following properties:
  • base_url (required): base url to monitor in the form [https][://][host]:[port].
  • username (required): Redfish username.
  • password (required): Redfish password.
  • insecure (optional, default: false): Sets the protocol security.
  • timeout (optional, default: 60s): Sets the Redfish client timeout.
  • redfish (optional): Redfish configuration.
  • computer_system_id (required): Redfish computer system id to monitor.
  • resources (required): The list of Redfish resources to monitor.
The redfish configuration has the following properties:
  • version (optional, default: v1): Redfish API version.
The redfish resource options include the below:
  • ComputerSystem
  • Chassis
  • Fans
  • Temperatures

​
Example Configuration

receivers:
  redfish:
    collection_interval: 60s
    servers:
    - base_url: https://16.1.15.1
      username: "${BMC_USER}"
      password: "${BMC_PASSWORD}"
      insecure: true
      computer_system_id: "1"
      redfish:
        version: v1
      resources:
      - ComputerSystem
      - Fans
The full list of settings exposed for this receiver are documented in config.go.

​
Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml

​
Metrics

Metric NameDescriptionUnitTypeAttributes
✅ chassis.powerstateMeasures the power state of a chassis (-1 unknown, 0 off, 1 on).{powerstate}Gaugechassis.id, chassis.asset_tag, chassis.model, chassis.name, chassis.manufacturer, chassis.serial_number, chassis.sku, chassis.chassis_type
✅ chassis.status.healthMeasures the health of a chassis (-1 unknown, 0 critical, 1 ok, 2 warning).{statushealth}Gaugechassis.id, chassis.asset_tag, chassis.model, chassis.name, chassis.manufacturer, chassis.serial_number, chassis.sku, chassis.chassis_type
✅ chassis.status.stateMeasures the state of a chassis (-1 unknown, 0 disabled, 1 enabled).{statusstate}Gaugechassis.id, chassis.asset_tag, chassis.model, chassis.name, chassis.manufacturer, chassis.serial_number, chassis.sku, chassis.chassis_type
✅ fan.readingMeasures the reading of a chassis fan.{}Gaugechassis.id, fan.name, fan.reading_units
✅ fan.status.healthMeasures the health of a chassis fan (-1 unknown, 0 critical, 1 ok, 2 warning).{statushealth}Gaugechassis.id, fan.name
✅ fan.status.stateMeasures the state of a chassis fan (-1 unknown, 0 disabled, 1 enabled).{statusstate}Gaugechassis.id, fan.name
✅ system.powerstateMeasures the power state of a system (-1 unknown, 0 off, 1 on).{powerstate}Gaugesystem.id, system.asset_tag, system.bios_version, system.model, system.name, system.manufacturer, system.serial_number, system.sku, system.system_type
✅ system.status.healthMeasures the health of a system (-1 unknown, 0 critical, 1 ok, 2 warning).{statushealth}Gaugesystem.id, system.asset_tag, system.bios_version, system.model, system.name, system.manufacturer, system.serial_number, system.sku, system.system_type
✅ system.status.stateMeasures the state of a system (-1 unknown, 0 disabled, 1 enabled).{statusstate}Gaugesystem.id, system.asset_tag, system.bios_version, system.model, system.name, system.manufacturer, system.serial_number, system.sku, system.system_type
✅ temperature.readingMeasures the reading of a chassis temperature.°CGaugechassis.id, temperature.name
✅ temperature.status.healthMeasures the health of a chassis temperature (-1 unknown, 0 critical, 1 ok, 2 warning).{statushealth}Gaugechassis.id, temperature.name
✅ temperature.status.stateMeasures the state of a chassis temperature (-1 unknown, 0 disabled, 1 enabled).{statusstate}Gaugechassis.id, temperature.name

​
Attributes

Attribute NameDescriptionTypeValues
chassis.asset_tagChassis asset tag.string
chassis.chassis_typeChassis type.string
chassis.idChassis id.string
chassis.manufacturerChassis manufacturer.string
chassis.modelChassis model.string
chassis.nameChassis name.string
chassis.serial_numberChassis serial number.string
chassis.skuChassis sku.string
fan.nameFan name.string
fan.reading_unitsFan reading units.string
system.asset_tagSystem asset tag.string
system.bios_versionSystem bios version.string
system.idSystem id.string
system.manufacturerSystem manufacturer.string
system.modelSystem model.string
system.nameSystem name.string
system.serial_numberSystem serial number.string
system.skuSystem sku.string
system.system_typeSystem type.string
temperature.nameTemperature name.string

​
Resource Attributes

Attribute NameDescriptionTypeEnabled
host.nameSystem host name.string✅
url.fullFull URL of Redfish API endpoint.string✅
Last generated: 2026-04-13