From f07897895a16f5d8a0527dc3e77c49d7d855e3e3 Mon Sep 17 00:00:00 2001
From: Summer Long <slong@redhat.com>
Date: Sun, 6 Apr 2014 17:40:52 +1000
Subject: [PATCH] Added info on Guru Meditation reports for Compute

New section under Troubleshooting.
Related dev change is: I224a426dad084f0e738069207ffbffe7f7935a17

Closes-Bug: #1303253

Change-Id: I74c70289eb57c805ed0c582572802d39425f6964
---
 doc/common/section_support-compute.xml | 34 +++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/doc/common/section_support-compute.xml b/doc/common/section_support-compute.xml
index 1505ade93a..1c65f45103 100644
--- a/doc/common/section_support-compute.xml
+++ b/doc/common/section_support-compute.xml
@@ -1,4 +1,9 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [
+ <!-- Some useful entities borrowed from HTML -->
+<!ENTITY ndash  "&#x2013;">
+<!ENTITY mdash  "&#x2014;">
+<!ENTITY hellip "&#x2026;">
+]>
 <section xmlns="http://docbook.org/ns/docbook"
     xmlns:xi="http://www.w3.org/2001/XInclude"
     xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
@@ -43,6 +48,33 @@
             Alternatively you can set <literal>use_syslog=1</literal>
             so that the nova daemon logs to syslog.</para>
     </section>
+    <section xml:id="section_compute-GuruMed-reports">
+        <title>Guru Meditation reports</title>
+        <para>A Guru Meditation report is sent by the Compute Service upon receipt of the
+                <systemitem>SIGUSR1</systemitem> signal. This report is a general-purpose error
+            report, including a complete report of the service's current state, and is sent to
+                <systemitem>stderr</systemitem>.</para>
+        <para>For example, if you redirect error output to <filename>nova-api-err.log</filename>
+            using <command>nova-api 2&gt;/var/log/nova/nova-api-err.log</command>, resulting in the
+            process ID 8675, you can then run:</para>
+        <screen><prompt>#</prompt> <userinput>kill -USR1 8675</userinput></screen>
+        <para>This command triggers the Guru Meditation report to be printed to
+            <filename>/var/log/nova/nova-api-err.log</filename>.</para>
+        <para>The report has the following sections:
+            <itemizedlist>
+                <listitem><para>Package &mdash; Displays information about the package to which
+                    the process belongs, including version information.</para></listitem>
+                <listitem><para>Threads &mdash; Displays stack traces and thread IDs for each of the threads within the
+                        process.</para></listitem>
+                <listitem><para>Green Threads &mdash; Displays stack traces for each of the green
+                    threads within the process (green threads do not have thread IDs).</para></listitem>
+                <listitem><para>Configuration &mdash; Lists all configuration options currently accessible through the CONF
+                        object for the current process.</para></listitem>
+             </itemizedlist></para>
+        <para>For more information, see <link
+            xlink:href="http://docs.openstack.org/developer/nova/devref/gmr.html"
+            >Guru Meditation Reports</link>.</para>
+    </section>
     <section xml:id="section_compute-common-errors-and-fixes">
         <title>Common errors and fixes for Compute</title>
         <para>The <link xlink:href="ask.openstack.org"