openstack/ironic
Code Issues Proposed changes

Merge "docs: Updates redfish metrics docs with required configuration file settings"

Browse Source
This commit is contained in:
Zuul 2024-10-22 18:49:03 +00:00 committed by Gerrit Code Review
commit 1f740c8a90
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`` 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). 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 The payload of each notification is a mapping where keys are sensor types
(``Fan``, ``Temperature``, ``Power`` or ``Drive``) and values are also mappings (``Fan``, ``Temperature``, ``Power`` or ``Drive``) and values are also mappings
from sensor identifiers to the sensor data. from sensor identifiers to the sensor data.