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.
niuke a17d762b50 remove unicode prefix from code 1 day ago
doc remove unicode literal from code 3 weeks ago
oslo_reports Support integer keys of dicts in text serialization 8 months ago
releasenotes remove unicode prefix from code 1 day ago
.coveragerc remove extraneous coverage omit instruction 7 years ago
.gitignore Move doc related modules to doc/requirements.txt 3 years ago
.gitreview OpenDev Migration Patch 3 years ago
.mailmap exported from oslo-incubator by graduate.sh 7 years ago
.pre-commit-config.yaml Move flake8 as a pre-commit local target. 1 year ago
.stestr.conf Switch to stestr 4 years ago
.zuul.yaml Update CI to use unversioned jobs template 5 months ago
CONTRIBUTING.rst Align contributing doc with oslo's policy 2 years ago
HACKING.rst Update hacking version 4 years ago
LICENSE exported from oslo-incubator by graduate.sh 7 years ago
README.rst Replace git.openstack.org URLs with opendev.org URLs 3 years ago
requirements.txt Remove all six usage 2 years ago
setup.cfg Drop python3.6/3.7 support in testing runtime 4 months ago
setup.py remove outdated header 3 years ago
test-requirements.txt Fix hacking min version to 3.0.1 2 years ago
tox.ini Changed minversion in tox to 3.18.0 1 year ago

README.rst

Team and repository tags

image

oslo.reports

Latest Version

Downloads

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 http://en.wikipedia.org/wiki/Guru_Meditation) 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.