{"id":9161,"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.","status":"active","version":"3.7.0","language":"python","source_language":"en","source_url":"https://github.com/openstack/oslo.reports","tags":["OpenStack","reporting","diagnostics","error reporting","system information","utilities"],"install":[{"cmd":"pip install oslo.reports","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"Used for standardized configuration across OpenStack projects, which oslo.reports may leverage for gathering configuration data. Not a strict runtime dependency for basic report generation.","package":"oslo.config","optional":true},{"reason":"Required for using predefined views that utilize the Jinja templating system for report serialization (e.g., text or HTML output). Not required for JSON or XML views.","package":"jinja2","optional":true}],"imports":[{"wrong":"from oslo_reports import GuruMeditationReport","symbol":"GuruMeditationReport","correct":"from oslo_reports import GuruMeditationReport"}],"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."},"warnings":[{"fix":"Upgrade your Python environment to version 3.10 or higher. Use `python --version` to check your current interpreter version.","message":"The library explicitly requires Python 3.10 or newer. Attempting to install or run oslo.reports on older Python versions will result in installation failures or runtime errors.","severity":"breaking","affected_versions":"<3.10"},{"fix":"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`.","message":"Module import paths use underscores (`oslo_reports`) while the PyPI package name uses a dash (`oslo-reports`). A common mistake is to try `import oslo.reports`.","severity":"gotcha","affected_versions":"All versions"},{"fix":"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.","message":"Generating reports with specific output formats (e.g., templated text via Jinja2) or incorporating configuration data requires installing optional dependencies like `jinja2` or having `oslo.config` properly set up.","severity":"gotcha","affected_versions":"All versions"}],"env_vars":null,"search_vec":"'3.7.0':57 'accur':35 'administr':32 'cadenc':67 'configur':48 'current':39,54 'detail':18 'diagnost':70 'error':19,71 'follow':60 'framework':15 'general':13 'general-purpos':12 'generat':17 'guru':27 'help':31 'includ':45 'inform':74 'librari':3,8 'live':40 'medit':28 'obtain':33 'often':23 'openstack':7,62,68 'oslo':1 'oslo.reports':4 'packag':51 'paramet':49 'project':63 'provid':10 'purpos':14 'refer':24 'regular':65 'releas':66 'report':2,22,29,69,72 'run':46 'state':41 'system':21,44,73 'thread':47 'util':75 'version':52,55 'view':36","created_at":"2026-04-16T18:48:47.302354+00:00","updated_at":"2026-04-16T18:48:47.302354+00:00","problems":{"verify_error":"Traceback (most recent call last):\n  File \"<string>\", line 1, in <module>\nImportError: cannot import name 'GuruMeditationReport' from 'oslo_reports' (/tmp/tmpxc39dms3/venv/lib/python3.12/site-packages/oslo_reports/__init__.py)"},"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"3.8.0","cli_name":"","cli_version":null,"type":"library","homepage":"https://docs.openstack.org/oslo.reports","github":null,"docs":null,"changelog":null,"pypi":"https://pypi.org/project/oslo-reports/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["observability","devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"import_fail","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-07-10","install_tag":null}}