Ceilometer contains a mechanism whereby developers and system administrators can generate a report about the state of a running Ceilometer executable. This report is called a Guru Meditation Report (GMR for short).
A GMR can be generated by sending the USR1 signal to any Ceilometer process with support (see below). The GMR will then be outputted standard error for that particular process.
For example, suppose that ceilometer-polling has process id 8675, and was run with 2>/var/log/ceilometer/ceilometer-polling.log. Then, kill -USR1 8675 will trigger the Guru Meditation report to be printed to /var/log/ceilometer/ceilometer-polling.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 (currently residing in oslo-incubator), as well as the Ceilometer version module:
from oslo_reports import guru_meditation_report as gmr from ceilometer 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 (usually service.server(server) or something similar), register the GMR hook: