oslo.reports
oslo.reports library
Decision gist · record as of 2026-08-14
Yes, if you are developing or operating an OpenStack service and need structured diagnostic reporting. The package is actively maintained, has no known vulnerabilities, and integrates cleanly with the oslo ecosystem. Not recommended for non-OpenStack projects unless you need a general-purpose runtime state capture framework and are willing to work with its OpenStack-centric design.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.11 or later; designed for OpenStack deployments and most useful when integrated into an OpenStack service.
- Low install friction with a pure-Python wheel.
- Active maintenance as of 35 days ago.
License · maintenance · safety
Apache-2.0 (permissive) — Apache-2.0 permissive license allows use in commercial and proprietary projects with minimal restrictions; attribution required but no copyleft obligations.
last release 2026-07-10 (35 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 165,160 downloads/mo, #10,528 on PyPI
Alternatives
Verify before relying
pip install oslo.reports
from oslo_reports.guru_meditation_report import GuruMeditationReport
report = GuruMeditationReport()
print(report.format_report())- Whether the package works standalone or requires an OpenStack service context to be useful.
- Performance characteristics when generating reports from long-running processes with many threads.
- Customization API surface for adding project-specific generators and models beyond the documented standard set.
What it is and what it does
oslo.reports is a framework for generating structured diagnostic reports from running OpenStack services. It addresses the problem that logs alone don't capture the live state of a system—what threads are active, which config parameters are in effect, or what exceptions are currently being handled. The package provides a "guru meditation report" mechanism that collects this state into models (stack traces, thread info, exceptions, config, package versions) and serializes them to JSON, XML, or plain text via Jinja templates.
The framework is built on three layers: Models that define structured data for system state, Generators that populate those models with current runtime information, and Views that serialize the models to output formats. OpenStack projects can register custom generators to add project-specific diagnostic data. It depends on oslo.serialization, oslo.config, oslo.i18n, oslo.utils, Jinja2, psutil, and pbr—all mature OpenStack ecosystem libraries.
Use it for
- Generate diagnostic snapshots when an OpenStack service encounters an error or hangs, capturing thread stacks and active configuration.
- Collect runtime state reports from production deployments to aid in triaging and debugging complex distributed system issues.
- Export system state in machine-readable formats (JSON, XML) for automated analysis or archival in incident response workflows.
- Extend with custom generators to include application-specific metrics or state in the diagnostic report.
- Inspect thread behavior and configuration state without stopping or restarting the running service.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are developing or operating an OpenStack service and need structured diagnostic reporting.
The package is actively maintained, has no known vulnerabilities, and integrates cleanly with the oslo ecosystem. Not recommended for non-OpenStack projects unless you need a general-purpose runtime state capture framework and are willing to work with its OpenStack-centric design.
Install
oslo-reports on PyPI
Before you install
Low install friction with a pure-Python wheel. Active maintenance as of 35 days ago. Depends on 7 runtime packages including oslo.serialization, oslo.config, and Jinja2—all standard OpenStack libraries with established track records.
Requires Python 3.11 or later; designed for OpenStack deployments and most useful when integrated into an OpenStack service.
License in practice
Apache-2.0 permissive license allows use in commercial and proprietary projects with minimal restrictions; attribution required but no copyleft obligations.
Quickstart
pip install oslo.reports
from oslo_reports.guru_meditation_report import GuruMeditationReport
report = GuruMeditationReport()
print(report.format_report())
Verify before relying
- Whether the package works standalone or requires an OpenStack service context to be useful.
- Performance characteristics when generating reports from long-running processes with many threads.
- Customization API surface for adding project-specific generators and models beyond the documented standard set.
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.11 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 7 packagespbrJinja2oslo.serializationpsutiloslo.i18noslo.utilsoslo.config |
| Maintenance | Actively maintained 35 days since the last release |
| First released | |
| Downloads | 165,160 / month, #10,528 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Environment :: OpenStackIntended Audience :: Information TechnologyIntended Audience :: System AdministratorsOperating System :: POSIX :: LinuxProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: Implementation :: CPythonTyping :: Typed |
Evidence: oslo_reports-3.9.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “openstack debug report generation”
- oslo.reportsoslo.reports generates structured debug reports from running…
- oslo.metricsCollects and exposes metrics data from Oslo libraries to monitoring…
- os-testros-testr wraps the testr test runner to provide OpenStack-specific…
Give your agent the search over MCP, or paste the wish link into any chat.
More Monitoring packages
Wraps any iterable to display a real-time progress bar in the terminal or Jupyter notebook, showing iteration count, elapsed time, and estimated time remaining.
Provides generated Python code for OpenTelemetry semantic conventions, enabling standardized attribute naming and constant definitions for instrumentation and telemetry collection.
Install it if you are using OpenTelemetry and want to follow semantic conventions correctly.
Provides the reference implementation of the OpenTelemetry API for collecting and exporting traces, metrics, and logs from Python applications.
Provides the abstract API and interfaces for OpenTelemetry instrumentation in Python, defining how to emit traces, metrics, and logs without tying code to a specific SDK implementation.
Exports OpenTelemetry observability data to an OpenTelemetry Collector using Protobuf-encoded messages over HTTP.
Install it if you are using OpenTelemetry in Python and need to send data to a Collector over HTTP.
Provides automatic instrumentation commands and programmatic APIs to inject distributed tracing into Python applications without code changes, detecting and instrumenting packages used by your program.
Install it if you need distributed tracing without code changes and have compatible instrumented packages in your environment.
See also oslo.serialization · oslo.service · oslo.log · oslotest · oslo.config · oslo.vmware · oslo.utils · osprofiler · oslo.policy · oslo.versionedobjects