openstack/cinder
Code Issues Proposed changes

Update docs to generate Guru Meditation Report

Browse Source 
Guru Meditation Reports (GMR) code in oslo.reports was recently updated
to expect SIGUSR2 as opposed to SIGUSR1, because it is reserved by
Apache 'mod_wsgi' for its own use.

Signal was changed and merged in change:
I9d3b6079ba2cca41fe4723723a6f80b2c3c0b9c0

Change-Id: Id58dd3c32b095f4c6b14caf650d36f2fc7dfb12c
This commit is contained in:
Sean McGinnis 2015-10-21 16:23:56 -05:00
parent 25196b4c82
commit a77335012f
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
----------------
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).
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
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``.
Structure of a GMR
@ -88,4 +88,4 @@ Extending the GMR
As mentioned above, additional sections can be added to the GMR for a
particular executable. For more information, see the inline documentation
about oslo.reports:
`oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_
`oslo.reports <http://docs.openstack.org/developer/oslo.reports/>`_