openstack/oslo.reports
Code Issues Proposed changes
OpenStack library for creating Guru Meditation Reports and other reports
266 Commits 7 Branches 79 Tags 2.2 MiB
Python 100%
39ed8ffc50
Go to file
OpenStack Release Bot 39ed8ffc50 Update master for stable/train 
Add file to the reno documentation build to show release notes for
stable/train.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/train.

Change-Id: I886cc59de42a5be385ba3a4aebc65c8fbfc021da
Sem-Ver: feature
2019-09-20 16:36:39 +00:00
doc Move doc related modules to doc/requirements.txt 2019-07-06 00:52:54 +08:00
oslo_reports Update hacking version 2019-02-17 11:16:48 +08:00
releasenotes Update master for stable/train 2019-09-20 16:36:39 +00:00
.coveragerc remove extraneous coverage omit instruction 2015-10-08 20:26:55 +00:00
.gitignore Move doc related modules to doc/requirements.txt 2019-07-06 00:52:54 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:41:50 +00:00
.mailmap exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
.stestr.conf Switch to stestr 2018-07-03 16:05:38 +07:00
.zuul.yaml Add Python 3 Train unit tests 2019-07-05 15:00:15 -04:00
babel.cfg exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
CONTRIBUTING.rst Update the documentation link 2017-08-23 15:12:32 +08:00
HACKING.rst Update hacking version 2019-02-17 11:16:48 +08:00
LICENSE exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
lower-constraints.txt Switch to stestr 2018-07-03 16:05:38 +07:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-23 05:34:29 +00:00
requirements.txt Updated from global requirements 2018-03-15 07:50:21 +00:00
setup.cfg Add Python 3 Train unit tests 2019-07-05 15:00:15 -04:00
setup.py Updated from global requirements 2017-03-02 11:53:40 +00:00
test-requirements.txt Move doc related modules to doc/requirements.txt 2019-07-06 00:52:54 +08:00
tox.ini Merge "Move doc related modules to doc/requirements.txt" 2019-07-11 13:41:22 +00:00

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.