openstack/ironic
Code Issues Proposed changes

docs: Updates redfish metrics docs with required configuration file settings

Browse Source 
Change-Id: Ide7c245e017a92519e17ed1fb62c7fc986a1ae6a
This commit is contained in:
Nicholas Kuechler 2024-10-16 15:29:37 -05:00
parent c80b8bfdb2
commit ae4d5b5c49
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/admin/drivers/redfish/metrics.rst
View File

@ -6,6 +6,25 @@ The ``redfish`` hardware type supports sending hardware metrics via the
a notification will be set to ``hardware.redfish.metrics`` (where ``redfish``
may be replaced by a different driver name for hardware types derived from it).
Enabling redfish hardware metrics requires some ironic.conf configuration file
updates:
.. code-block:: ini
[oslo_messaging_notifications]
# The Drivers(s) to handle sending notifications. Possible
# values are messaging, messagingv2, routing, log, test, noop,
# prometheus_exporter (multi valued)
# Example using the messagingv2 driver:
driver = messagingv2
[sensor_data]
send_sensor_data = true
[metrics]
backend = collector
The payload of each notification is a mapping where keys are sensor types
(``Fan``, ``Temperature``, ``Power`` or ``Drive``) and values are also mappings
from sensor identifiers to the sensor data.