openstack/cinder
Code Issues Proposed changes

Merge "Update docs to generate Guru Meditation Report"

Browse Source
This commit is contained in:
Jenkins 2015-10-22 04:16:44 +00:00 committed by Gerrit Code Review
commit 944763920d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/devref/gmr.rst
View File

@ -24,13 +24,13 @@ This report is called a *Guru Meditation Report* (*GMR* for short).
Generating a GMR Generating a GMR
---------------- ----------------
A *GMR* can be generated by sending the *USR1* signal to any Cinder process A *GMR* can be generated by sending the *USR2* signal to any Cinder process
with support (see below). with support (see below).
The *GMR* will then be outputted standard error for that particular process. The *GMR* will then be outputted standard error for that particular process.
For example, suppose that ``cinder-api`` has process id ``8675``, and was run For example, suppose that ``cinder-api`` has process id ``8675``, and was run
with ``2>/var/log/cinder/cinder-api-err.log``. with ``2>/var/log/cinder/cinder-api-err.log``.
Then, ``kill -USR1 8675`` will trigger the Guru Meditation report to be printed Then, ``kill -USR2 8675`` will trigger the Guru Meditation report to be printed
to ``/var/log/cinder/cinder-api-err.log``. to ``/var/log/cinder/cinder-api-err.log``.
Structure of a GMR Structure of a GMR
@ -88,4 +88,4 @@ Extending the GMR
As mentioned above, additional sections can be added to the GMR for a As mentioned above, additional sections can be added to the GMR for a
particular executable. For more information, see the inline documentation particular executable. For more information, see the inline documentation
about oslo.reports: about oslo.reports:
`oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_ `oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_