openstack/ironic
Code Issues Proposed changes

Add docs about creating release note when metrics change

Browse Source 
This adds a note to the metrics documentation that changing a metric
name or removing a metric will need a release note in the future. There
was consensus about this at the most recent ironic IRC meeting. [0]

[0] http://eavesdrop.openstack.org/irclogs/%23openstack-meeting-3/%23openstack-meeting-3.2017-01-09.log.html#t2017-01-09T17:26:33

Change-Id: Ibdb4fd39a654ea06a526f346358f88b291c4e7a4
This commit is contained in:
Mario Villaplana 2017-01-10 21:46:05 +00:00
parent f2d4d76b7d
commit bbd0e96c4b
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/deploy/metrics.rst
View File

@ -75,7 +75,9 @@ named data points to be emitted from the Bare Metal service. This will
increase if the metrics.preserve_host option is set to true or if multiple increase if the metrics.preserve_host option is set to true or if multiple
drivers are used in the Bare Metal deployment. This estimate may be used to drivers are used in the Bare Metal deployment. This estimate may be used to
determine if a deployer needs to scale their metrics backend to handle the determine if a deployer needs to scale their metrics backend to handle the
additional load before enablng metrics. additional load before enablng metrics. To see which metrics have changed names
or have been removed between releases, refer to the `ironic release notes
<http://docs.openstack.org/releasenotes/ironic/>`_.
.. note:: .. note::
With the default statsd configuration, each timing metric may create With the default statsd configuration, each timing metric may create
@ -95,8 +97,7 @@ Adding New Metrics
================== ==================
If you're a developer, and would like to add additional metrics to ironic, If you're a developer, and would like to add additional metrics to ironic,
please see the ironic-lib developer documentation for details on how to use please see the `ironic-lib developer documentation
the metrics library. <http://docs.openstack.org/developer/ironic-lib/>`_ for details on how to use
the metrics library. A release note should also be created each time a metric
.. TODO:: is changed or removed to alert deployers of the change.
Link to ironic-lib developer documentation once it's published.