OpenStack library for creating Guru Meditation Reports and other reports
Go to file
Ronald Bradford 0ea635df69 Fix coverage configuration and execution
A number of configuration errors prevent the successful creation of code
coverage. This corrects the .coveragerc source/omit setup and the tox
package name generation.

Change-Id: I5329955ee1e5101fe62012c6cae91e39f0fc96e4
2015-10-01 15:33:18 +00:00
doc/source Merge "How to use oslo.reports documentation" 2015-09-26 00:54:56 +00:00
oslo.reports/locale Setup translations 2015-08-09 07:27:54 +02:00
oslo_reports guru_meditation_report: Use SIGUSR2 instead of SIGUSR1 2015-09-14 16:51:33 +02:00
.coveragerc Fix coverage configuration and execution 2015-10-01 15:33:18 +00:00
.gitignore Fix coverage configuration and execution 2015-10-01 15:33:18 +00:00
.gitreview exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
.mailmap exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
.testr.conf exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
CONTRIBUTING.rst exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
HACKING.rst exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
LICENSE exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
MANIFEST.in exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
README.rst Add shields.io version/downloads links/badges into README.rst 2015-09-24 20:52:41 -04:00
babel.cfg exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
openstack-common.conf exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
requirements.txt Updated from global requirements 2015-09-17 12:16:09 +00:00
setup.cfg add auto-generated api documentation 2015-09-25 17:44:51 -04:00
setup.py Updated from global requirements 2015-09-17 12:16:09 +00:00
test-requirements.txt Fix coverage configuration and execution 2015-10-01 15:33:18 +00:00
tox.ini Fix coverage configuration and execution 2015-10-01 15:33:18 +00:00

README.rst

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.