OpenStack library for creating Guru Meditation Reports and other reports
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 3ba127e64f Merge "Align contributing doc with oslo's policy" 2 weeks ago
doc Fix pygments style 1 month ago
oslo_reports Stop to use the __future__ module. 1 month ago
releasenotes Fix pygments style 1 month ago
.coveragerc remove extraneous coverage omit instruction 4 years ago
.gitignore Move doc related modules to doc/requirements.txt 1 year ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap exported from oslo-incubator by 5 years ago
.stestr.conf Switch to stestr 2 years ago
.zuul.yaml Add Python3 victoria unit tests 3 months ago
CONTRIBUTING.rst Align contributing doc with oslo's policy 2 months ago
HACKING.rst Update hacking version 1 year ago
LICENSE exported from oslo-incubator by 5 years ago
README.rst Replace URLs with URLs 1 year ago
lower-constraints.txt Merge "Remove the unused coding style modules" 1 month ago
requirements.txt Updated from global requirements 2 years ago
setup.cfg Remove translation sections from setup.cfg 2 months ago remove outdated header 5 months ago
test-requirements.txt Update hacking for Python3 3 months ago
tox.ini Bump default tox env from py37 to py38 2 months ago


Team and repository tags



Latest Version


When things go wrong in (production) deployments of OpenStack collecting debug data is a key first step in the process of triaging & ultimately resolving the problem. Projects like Nova has extensively used logging capabilities which produce a vast amount of data. This does not, however, enable an admin to obtain an accurate view on the current live state of the system. For example, what threads are running, what config parameters are in effect, and more.

The project oslo.reports hosts a general purpose error report generation framework, known as the "guru meditation report" (cf to address the issues described above.

Models: These classes define structured data for a variety of interesting pieces of state. For example, stack traces, threads, config parameters, package version info, etc. They are capable of being serialized to XML / JSON or a plain text representation

Generators: These classes are used to populate the model classes with the current runtime state of the system

Views: views serialize models into say JSON, text or xml. There is also a predefined view that utilizes Jinja templating system.

There will be a number of standard models / generators available for all OpenStack services

StackTraceModel: a base class for any model which includes a stack trace ThreadModel: a class for information about a thread ExceptionModel: a class for information about a caught exception ConfigModel: a class for information about configuration file settings PackageModel: a class for information about vendor/product/version/package information

Each OpenStack project will have the ability to register further generator classes to provide custom project specific data.