openstack/ironic-specs
Code Issues Proposed changes

Update metrics spec with fixes and more info

Browse Source 
This improves the problem description, fixes config options to use "_"
rather than "-", and adds another reference as to why metrics are
useful to operators.

blueprint add-pluggable-metrics-backend-for-ironic-and-ipa

Change-Id: I647fc1ab265eccf79591f0a4e4dc6b25d0e13fa8
This commit is contained in:
Jim Rollenhagen 2015-07-31 08:55:01 -07:00
parent 4a2f00190d
commit 815f296871
1 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
specs/liberty/add-pluggable-metrics-backend-for-ironic-and-ipa.rst
View File

@ -18,11 +18,16 @@ creation of alternative backends.
Problem description
===================
Metric data are extremely useful for recognizing and diagnosing problems in
software, and can be used to monitor the health and performance of Ironic/IPA
in a production environment.
Software metrics are extremely useful to operators for recognizing and
diagnosing problems in running software, and can be used to monitor the
real time and historical performance of Ironic and IPA in a production
environment.
Currently, neither Ironic nor IPA report any metric data.
Metrics can be used to determine how quickly (or slowly) parts of the system
are running, how often errors (such as API error responses or BMC failures)
occur, or the performance impact of a given change.
Currently, neither Ironic nor IPA report any application metrics.
Proposed change
===============
@ -216,24 +221,24 @@ Default config options:
# Backend options are "statsd" and "noop"
backend="noop"
statsd-host="localhost"
statsd-port=8125
statsd_host="localhost"
statsd_port=8125
# See proposed changes section for detailed description of how these are used
prepend-host=false
prepend-host-reverse=false
global-prefix=""
prepend_host=false
prepend_host_reverse=false
global_prefix=""
# Backend options are "statsd" and "noop"
agent-backend="noop"
agent-statsd-host="localhost"
agent-statsd-port=8125
agent_backend="noop"
agent_statsd_host="localhost"
agent_statsd_port=8125
# See proposed changes section for detailed description of how these are used
agent-prepend-host=false
agent-prepend-host-reverse=false
agent-prepend-uuid=false
agent-global-prefix=""
agent_prepend_host=false
agent_prepend_host_reverse=false
agent_prepend_uuid=false
agent_global_prefix=""
If the statsd metrics backend is enabled, then deployers must install and
@ -294,6 +299,9 @@ Appropriate documentation must be written.
References
==========
For more on why metrics are useful to operators, and why the statsd project
began: https://codeascraft.com/2011/02/15/measure-anything-measure-everything/
[1] https://github.com/etsy/statsd/blob/master/docs/metric_types.md
[2] https://wiki.openstack.org/wiki/Ceilometer