openstack/ironic-python-agent
Code Issues Proposed changes

Make code blocks real code blocks in metrics docs

Browse Source 
Makes them an RST block quote and 4 space indents instead of 2.

Change-Id: If2b727ac431e70d714f3df0c622c5516901f3393
This commit is contained in:
Jim Rollenhagen 2016-08-11 07:24:06 -04:00
parent dfaf92b611
commit 5f146d465d
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/metrics.rst
View File

@ -21,13 +21,13 @@ Using a context manager
Using the context manager is the recommended way for sending metrics that time Using the context manager is the recommended way for sending metrics that time
or count sections of code. However, given that you cannot cache the or count sections of code. However, given that you cannot cache the
MetricsLogger, you have to explicitly call get_metrics_logger() from MetricsLogger, you have to explicitly call get_metrics_logger() from
ironic-lib every time. For example: ironic-lib every time. For example::
from ironic_lib import metrics_utils from ironic_lib import metrics_utils
def my_method(): def my_method():
with metrics_utils.get_metrics_logger(__name__).timer(): with metrics_utils.get_metrics_logger(__name__).timer():
return _do_work() return _do_work()
As a note, these metric collectors do work for custom HardwareManagers as As a note, these metric collectors do work for custom HardwareManagers as
well, however, you may want to metric the portions of a method that determine well, however, you may want to metric the portions of a method that determine
@ -39,13 +39,13 @@ Explicitly sending metrics
A feature that may be particularly helpful for deployers writing custom A feature that may be particularly helpful for deployers writing custom
HardwareManagers is the ability to explicitly send metrics. As an example, HardwareManagers is the ability to explicitly send metrics. As an example,
you could add a cleaning step which would retrieve metrics about a device and you could add a cleaning step which would retrieve metrics about a device and
ship them using the provided metrics library. For example: ship them using the provided metrics library. For example::
from ironic_lib import metrics_utils from ironic_lib import metrics_utils
def my_cleaning_step(): def my_cleaning_step():
for name, value in _get_smart_data(): for name, value in _get_smart_data():
metrics_utils.get_metrics_logger(__name__).send_gauge(name, value) metrics_utils.get_metrics_logger(__name__).send_gauge(name, value)
References References
========== ==========