redfish plugin¶


Plugin name	`redfish`
Type	read
Callbacks	init, config, read, shutdown
Status	supported
Since	5.11
Copyright	2018 Intel Corporation, Marcin Mozejko , Martin Kennelly , Adrian Boczkowski,
License	MIT License
Configuration	collectd.conf(5)

The Redfish plugin collects out-of-band sensor data from Redfish endpoints. It can get multiple resources from different hardware that supports the Redfish protocol.

The sensor types and sensor names are defined via configuration. The following types of Redfish sensors are supported:

Redfish sensor type	Collectd sensor value type	collectd sensor units
Power	voltage	volts
Temperature	temperature	Celsius
Fan	fanspeed	rpm

Synopsis¶

  <Plugin redfish>
    <Query "fans">
      Endpoint "/Chassis[0]/Thermal"
      <Resource "Fans">
        <Property "ReadingRPM">
          PluginInstance "chassis-1"
          Type "rpm"
        </Property>
      </Resource>
    </Query>
    <Query "temperatures">
      Endpoint "/Chassis[0]/Thermal"
      <Resource "Temperatures">
        <Property "ReadingCelsius">
          PluginInstance "chassis-1"
          Type "degrees"
        </Property>
      </Resource>
    </Query>
    <Query "voltages">
      Endpoint "/Chassis[0]/Power"
      <Resource "Voltages">
        <Property "ReadingVolts">
          PluginInstance "chassis-1"
          Type "volts"
        </Property>
      </Resource>
    </Query>
    <Service "local">
      Host "127.0.0.1:5000"
      User "user"
      Passwd "passwd"
      Queries "fans" "voltages" "temperatures"
    </Service>
  </Plugin>

Parameters¶

The following configuration options are supported by Redfish collectd plugin:

Name	Description
Query	Section defining a query performed on Redfish interface
Endpoint	URI of the REST API Endpoint for accessing the BMC
Resource	Selects single resource or array to collect information
Property	Selects property from which data is gathered
PluginInstance	Plugin instance of collectd metric
Type	Type of collectd metric
TypeInstance	Type instance of collectd metric
Service	Section defining service to be sent requests
Username	BMC username
Password	BMC password
Queries	Queries to run

Example graphs¶

None yet. Add one now!

Metrics¶

Technology/ Category	Metric/Feature Name	Date Type	Format Example	Collectd Release	Collectd Plugin	Description	Comments
Collectd	Collectd daemon	None	None	5.8	None	The userspace daemon that runs on individual hosts that collects platform metrics and relay them via plugin subscribers
Redfish	Collectd plugin	None	None	Future	None	The redfish plugin collects information about sensors provided by BMC. Sensor types and sensor names are defined via configuration file.
Redfish	Fan speed	Double	12600.00	Future	Redfish	The current sensor status of Fan (fan speed).	Colected Sensor Unit - RPM
Redfish	Temperature	Double	39.00	Future	Redfish	The current sensor status of temperature.	Colected Sensor Unit - Celsius
Redfish	Power consumption	Double	1.22	Future	Redfish	The current sensor status of power consumption.	Colected Sensor Unit - Volts

Implementation Details¶

To support the Redfish based sensor monitoring, the standard Redfish interfaces are used as mentioned in the DMTF Redfish standard. The goal of the plugin is to utilise the standard REST API URLs to reach the sensor resources. In order to implement and utilize the Redfish interfaces one must understand the concept of resource maps in DMTF Redfish architecture.

Dependencies¶

History¶

5.11 The Redfish plugin was added to collect out-of-band sensor data from Redfish endpoints.

Configuration¶

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

The redfish plugin collects sensor data using REST protocol called Redfish.

Sample configuration:

<Plugin redfish>
  <Query "fans">
    Endpoint "/redfish/v1/Chassis/Chassis-1/Thermal"
    <Resource "Fans">
      <Property "ReadingRPM">
        PluginInstance "chassis-1"
        Type "rpm"
      </Property>
    </Resource>
  </Query>
  <Query "temperatures">
    Endpoint "/redfish/v1/Chassis/Chassis-1/Thermal"
    <Resource "Temperatures">
      <Property "ReadingCelsius">
        PluginInstance "chassis-1"
        Type "degrees"
      </Property>
    </Resource>
  </Query>
  <Query "voltages">
    Endpoint "/redfish/v1/Chassis/Chassis-1/Power"
    <Resource "Voltages">
      <Property "ReadingVolts">
        PluginInstance "chassis-1"
        Type "volts"
      </Property>
    </Resource>
  </Query>
  <Service "local">
    Host "127.0.0.1:5000"
    User "user"
    Passwd "passwd"
    Queries "fans" "voltages" "temperatures"
  </Service>
</Plugin>

Query: Section defining a query performed on Redfish interface
Endpoint: URI of the REST API Endpoint for accessing the BMC
Resource: Selects single resource or array to collect data.
Property: Selects property from which data is gathered
PluginInstance: Plugin instance of dispatched collectd metric
Type: Type of dispatched collectd metric
TypeInstance: Type instance of collectd metric
Service: Section defining service to be sent requests
Username: BMC username
Password: BMC password
Queries: Queries to run