oslo.reports is an OpenStack library that provides a general-purpose framework for generating detailed error and system reports, often referred to as 'Guru Meditation Reports'. It helps administrators obtain an accurate view of the current live state of a system, including running threads, configuration parameters, and package versions. The current version is 3.7.0, and it follows the OpenStack project's regular release cadence.
pip install oslo.reportsVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to generate a basic Guru Meditation Report. The `GuruMeditationReport` class, when instantiated, automatically collects a wide range of system diagnostics. The `render_report()` method then serializes this data into a human-readable string. By default, it attempts to use a text output format.
Upgrade your Python environment to version 3.10 or higher. Use `python --version` to check your current interpreter version.
Always use `import oslo_reports` or `from oslo_reports.module import ...` in your Python code, even though you install it as `pip install oslo.reports`.
If experiencing errors related to missing templates or configuration, ensure that relevant optional dependencies are installed (`pip install oslo.reports[jinja2]` if available, or `pip install jinja2 oslo.config` separately) and that `oslo.config` is initialized if configuration is expected.