{"library":"oslo-reports","title":"Oslo Reports Library","description":"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.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install oslo.reports"],"cli":null},"imports":["from oslo_reports.guru_meditation_report import GuruMeditationReport","from oslo_reports.models.base import ReportModel","from oslo_reports.models.with_default_views import ModelWithDefaultViews"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"from oslo_reports.guru_meditation_report import GuruMeditationReport\n\n# Create a Guru Meditation Report instance.\n# By default, it gathers extensive system information.\n# Additional generators can be registered for custom data.\ngmr = GuruMeditationReport()\n\n# Generate the report as a plain text string.\n# Other rendering methods (e.g., to JSON, XML) may be available\n# depending on installed optional dependencies and specific views.\nreport_text = gmr.render_report(output_format='text')\n\nprint(\"--- Guru Meditation Report ---\")\nprint(report_text)\nprint(\"----------------------------\")","lang":"python","description":"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.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}