From: Sean McGinnis Date: Wed, 21 Oct 2015 21:23:56 +0000 (-0500) Subject: Update docs to generate Guru Meditation Report X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=a77335012f5df7b411029f9f792f358c3346bc50;p=openstack-build%2Fcinder-build.git Update docs to generate Guru Meditation Report 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 --- diff --git a/doc/source/devref/gmr.rst b/doc/source/devref/gmr.rst index 3d0db3983..a597b1906 100644 --- a/doc/source/devref/gmr.rst +++ b/doc/source/devref/gmr.rst @@ -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 `_ \ No newline at end of file +`oslo.reports `_