OpenStack library for creating Guru Meditation Reports and other reports
Go to file
zhoulinhui 6b2ad67208 Fix hacking min version to 3.0.1
flake8 new release 3.8.0 added new checks and gate pep8
job start failing. hacking 3.0.1 fix the pinning of flake8 to
avoid bringing in a new version with new checks.

Though it is fixed in latest hacking but 2.0 and 3.0 has cap for
flake8 as <4.0.0 which mean flake8 new version 3.9.0 can also
break the pep8 job if new check are added.

To avoid similar gate break in future, we need to bump the hacking min
version.

- http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014828.html

Change-Id: Ia71dc29dedb6786c4df4546bb4e7df6956966ec0
2020-10-16 01:21:28 +00:00
doc Adding pre-commit 2020-09-22 10:42:28 +02:00
oslo_reports Stop to use the __future__ module. 2020-06-02 20:40:02 +02:00
releasenotes Update master for stable/victoria 2020-09-11 21:00:11 +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
.pre-commit-config.yaml Adding pre-commit 2020-09-22 10:42:28 +02:00
.stestr.conf Switch to stestr 2018-07-03 16:05:38 +07:00
.zuul.yaml Add Python3 wallaby unit tests 2020-09-11 21:00:13 +00:00
CONTRIBUTING.rst Align contributing doc with oslo's policy 2020-05-04 18:28:54 +02: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 [goal] Migrate testing to ubuntu focal 2020-08-04 03:45:57 +00: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 Remove translation sections from setup.cfg 2020-05-15 11:16:23 +08:00
setup.py remove outdated header 2020-02-11 18:50:21 +01:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-10-16 01:21:28 +00:00
tox.ini Adding pre-commit 2020-09-22 10:42:28 +02:00

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.