diff --git a/doc/source/admin/gmr.rst b/doc/source/admin/gmr.rst deleted file mode 100644 index 3b74fcbe6d..0000000000 --- a/doc/source/admin/gmr.rst +++ /dev/null @@ -1,69 +0,0 @@ -Bare Metal Service state report (via Guru Meditation Reports) -============================================================= - -The Bare Metal service contains a mechanism whereby developers and system -administrators can generate a report about the state of running Bare Metal -executables (ironic-api and ironic-conductor). This report is called a Guru -Meditation Report (GMR for short). -GMR provides useful debugging information that can be used to obtain -an accurate view of the current live state of the system. For example, -what threads are running, what configuration parameters are in effect, -and more. The eventlet backdoor facility provides an interactive shell -interface for any eventlet-based process, allowing an administrator to -telnet to a pre-defined port and execute a variety of commands. - -Configuration -------------- - -The GMR feature is optional and requires the oslo.reports_ package to be -installed. For example, using pip:: - - pip install 'oslo.reports>=1.18.0' - -.. _oslo.reports: https://opendev.org/openstack/oslo.reports - -Generating a GMR ----------------- - -A *GMR* can be generated by sending the *USR2* signal to any Bare Metal process -that supports it. The *GMR* will then be output to stderr for that particular -process. For example: - -Suppose that ``ironic-api`` has process ID ``6385``, and was run with -``2>/var/log/ironic/ironic-api-err.log``. Then, sending the *USR* signal:: - - kill -USR2 6385 - -will trigger the Guru Meditation report to be printed to -``/var/log/ironic/ironic-api-err.log``. - -Structure of a GMR ------------------- - -The *GMR* consists of the following sections: - -Package - Shows information about the package to which this process belongs, including - version information. - -Threads - Shows stack traces and thread IDs for each of the threads within this - process. - -Green Threads - Shows stack traces for each of the green threads within this process (green - threads don't have thread IDs). - -Configuration - Lists all the configuration options currently accessible via the CONF object - for the current process. - -.. only:: html - - Sample GMR Report - ----------------- - - Below is a sample GMR report generated for ``ironic-api`` service: - - .. include:: report.txt - :literal: diff --git a/doc/source/admin/operation.rst b/doc/source/admin/operation.rst index 0edde1cb2f..429f29eb67 100644 --- a/doc/source/admin/operation.rst +++ b/doc/source/admin/operation.rst @@ -17,7 +17,6 @@ Configuration and Operation Ceph Object Gateway Emitting Software Metrics Auditing API Traffic - Service State Reporting Tuning Ironic Role Based Access Control Dashboard Integration diff --git a/doc/source/contributor/faq.rst b/doc/source/contributor/faq.rst index 47e22430a9..dac0d08e64 100644 --- a/doc/source/contributor/faq.rst +++ b/doc/source/contributor/faq.rst @@ -133,10 +133,3 @@ the preferred process is: .. _IRC: https://wiki.openstack.org/wiki/Ironic#IRC .. _mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss .. _process for making decisions: http://lists.openstack.org/pipermail/openstack-dev/2016-May/095460.html - -...add support for GMRs to new executables and extending the GMR? ------------------------------------------------------------------ - -For more information, see the -:oslo.reports-doc:`oslo.reports documentation ` -page.