Dragonflow contains a mechanism whereby developers and system administrators can generate a report about the state of a running Dragonflow executable. This report is called a Guru Meditation Report (GMR for short).
A GMR can be generated by sending the USR2 signal to any Dragonflow process with support (see below). The GMR will then be outputted standard error for that particular process.
For example, suppose that df-local-controller
has process id 2525
, and was run with
2>/var/log/dragonflow/df-controller.log
. Then, kill -USR2 2525
will trigger the Guru Meditation
report to be printed to /var/log/dragonflow/df-controller.log
.
The GMR is designed to be extensible; any particular executable may add its own sections. However, the base GMR consists of several sections:
Adding support for a GMR to a given executable is fairly easy.
First import the module, as well as the Dragonflow version module:
from oslo_reports import guru_meditation_report as gmr
from dragonflow import version
Then, register any additional sections (optional):
TextGuruMeditation.register_section('Some Special Section',
some_section_generator)
Finally (under main), before running the “main loop” of the executable, register the GMR hook:
TextGuruMeditation.setup_autorun(version)
As mentioned above, additional sections can be added to the GMR for a particular executable.
For more information, see the inline documentation under oslo.reports
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.