From bbd0e96c4beeef188170d745078a580efd118719 Mon Sep 17 00:00:00 2001 From: Mario Villaplana Date: Tue, 10 Jan 2017 21:46:05 +0000 Subject: [PATCH] Add docs about creating release note when metrics change 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 --- doc/source/deploy/metrics.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/deploy/metrics.rst b/doc/source/deploy/metrics.rst index b20e45f493..552aa618ba 100644 --- a/doc/source/deploy/metrics.rst +++ b/doc/source/deploy/metrics.rst @@ -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 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 -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 +`_. .. note:: 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, -please see the ironic-lib developer documentation for details on how to use -the metrics library. - -.. TODO:: - Link to ironic-lib developer documentation once it's published. +please see the `ironic-lib developer documentation +`_ for details on how to use +the metrics library. A release note should also be created each time a metric +is changed or removed to alert deployers of the change.