Difference between revisions of "Plugin:Redfish"

From collectd Wiki
Jump to: navigation, search
(Add Redfish plugin page)
 
 
(2 intermediate revisions by one other user not shown)
Line 9: Line 9:
 
   | Manpage={{Manpage|collectd.conf|5|plugin_redfish}}
 
   | Manpage={{Manpage|collectd.conf|5|plugin_redfish}}
 
}}
 
}}
The '''Redfish plugin''' collects out-of-band sensor data from Redfish endpoints. It can get multiple resource from different hardware that supports the Redfish protocol.
+
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 sensor types and sensor names are defined via configuration.
Line 116: Line 116:
 
== Metrics ==
 
== Metrics ==
  
{|class="wikitable"
+
{| class="wikitable"  
!Name
+
|-
!Type
+
! <br />Technology/<br />  <br />Category
!Type Instance
+
! <br />Metric/Feature Name
!Description
+
! <br />Date Type
!Comment
+
! <br />Format Example
 +
! <br />Collectd Release
 +
! <br />Collectd Plugin
 +
! <br />Description
 +
! <br />Dependencies
 +
! <br />Limitations
 +
! <br />Comments
 +
|-
 +
| <br />Collectd
 +
| <br />Collectd daemon
 +
| <br />None
 +
| <br />None
 +
| <br />5.8
 +
| <br />None
 +
| <br />The userspace  daemon that runs on individual hosts that collects platform metrics and relay  them via plugin subscribers
 +
| <br />
 +
| <br />
 +
| <br />
 +
|-
 +
| <br /> <br />  <br /> <br />  <br />Redfish
 +
| <br />Collectd plugin
 +
| <br />None
 +
| <br />None
 +
| <br />Future
 +
| <br />None
 +
| <br />The redfish plugin  collects information about sensors provided by BMC. Sensor types and sensor  names are defined via configuration file.
 +
| <br />
 +
| <br />
 +
| <br />
 +
|-
 +
| <br /> <br />  <br /> <br />  <br />Redfish
 +
| <br />Fan speed
 +
| <br />Double
 +
| <br />12600.00
 +
| <br />Future
 +
| <br />Redfish
 +
| <br />The current sensor  status of Fan (fan speed).
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Colected Sensor  Unit - RPM
 +
|-
 +
| <br />Redfish
 +
| <br />Temperature
 +
| <br />Double
 +
| <br />39.00
 +
| <br />Future
 +
| <br />Redfish
 +
| <br />The current sensor  status of temperature.
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Colected Sensor  Unit - Celsius
 
|-
 
|-
|  
+
| <br />Redfish
| Sensor type
+
| <br />Power consumption
| Sensor name
+
| <br />Double
| Sensor types and sensor names are defined via configuration file (They will be auto-generated from payload in next code drops).
+
| <br />1.22
| Depends on hardware
+
| <br />Future
 +
| <br />Redfish
 +
| <br />The current sensor   status of power consumption.
 +
| <br />
 +
| <br />
 +
| <br /> <br />  <br />Colected Sensor  Unit - Volts
 
|}
 
|}
  
 
== Implementation Details ==
 
== Implementation Details ==
To support the redfish based sensor monitoring, the standard redfish interfaces are used as mentioned in the DMTF. Idea is to use as much possible 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.  
+
To support the Redfish based sensor monitoring, the standard Redfish interfaces are used as mentioned in the [https://www.dmtf.org/standards/redfish 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.  
  
[[File:redfish_plugin_dataflow.png]]
+
[[File:redfish_plugin_dataflow.png|alt=Collectd Redfish plugin architecture|link=https://collectd.org/wiki/images/6/61/Redfish_plugin_dataflow.png|frame|center|Collectd Redfish plugin architecture]]
  
  
Line 147: Line 202:
 
== See also ==
 
== See also ==
  
 +
* [[Plugin:Redfish/tests]]
 
* [https://www.dmtf.org/sites/default/files/2017_12_RedfishTechnicalOverview.pdf Redfish technical overview]
 
* [https://www.dmtf.org/sites/default/files/2017_12_RedfishTechnicalOverview.pdf Redfish technical overview]
 
* [https://www.dmtf.org/sites/default/files/2017_12_Redfish_Introduction_and_Overview.pdf Redfish intro and overview]
 
* [https://www.dmtf.org/sites/default/files/2017_12_Redfish_Introduction_and_Overview.pdf Redfish intro and overview]
* [https://wiki.opnfv.org/display/fastpath/Redfish Redfish high level design documents]
+
* [https://wiki.opnfv.org/display/fastpath/Redfish Redfish plugin high level design documents]
  
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
{{DEFAULTSORT:Redfish}}
 
{{DEFAULTSORT:Redfish}}

Latest revision as of 18:14, 2 July 2020

Redfish plugin
Type: read
Callbacks: init, config, read, shutdown
Status: supported
First version: 5.11
Copyright: 2018 Intel Corporation
Marcin Mozejko
Martin Kennelly
Adrian Boczkowski
License: MIT license
Manpage: collectd.conf(5)
List of Plugins

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

Dependencies

Limitations

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.

Collectd Redfish plugin architecture
Collectd Redfish plugin architecture


Dependencies

History

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

See also