openstack/oslo.reports
Code Issues Proposed changes
OpenStack library for creating Guru Meditation Reports and other reports
229 Commits 6 Branches 77 Tags 2.2 MiB
Python 100%
eb3d36a0b4
Go to file
OpenStack Proposal Bot eb3d36a0b4 Imported Translations from Zanata 
For more information about this automatic import see:
https://docs.openstack.org/i18n/latest/reviewing-translation-import.html

Change-Id: I875e75d78e8028aee2256ccf4df87d367be5081a
2018-03-01 06:04:38 +00:00
doc/source switch from oslosphinx to openstackdocstheme 2017-07-03 12:41:24 +08:00
oslo_reports Imported Translations from Zanata 2018-03-01 06:04:38 +00:00
releasenotes Imported Translations from Zanata 2018-03-01 06:04:38 +00:00
.coveragerc remove extraneous coverage omit instruction 2015-10-08 20:26:55 +00:00
.gitignore rearrange content to fit the new standard layout 2017-06-29 19:17:17 +08: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
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 the doc URL according to document migration 2017-07-11 21:54:06 +08:00
LICENSE exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04:00
README.rst Update the documentation link 2017-08-23 15:12:32 +08:00
requirements.txt Updated from global requirements 2017-12-19 01:39:17 +00:00
setup.cfg update the doc URL according to document migration 2017-07-11 21:54:06 +08:00
setup.py Updated from global requirements 2017-03-02 11:53:40 +00:00
test-requirements.txt Updated from global requirements 2018-01-24 01:26:05 +00:00
tox.ini Add bandit to pep8 job 2017-12-12 14:42:13 +08: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.