openstack/oslo.reports
Code Issues Proposed changes
OpenStack library for creating Guru Meditation Reports and other reports
289 Commits 6 Branches 79 Tags 2.2 MiB
Python 100%
7dcae118a8
Go to file
Hervé Beraud 7dcae118a8 Align contributing doc with oslo's policy 
Related to:
- https://review.opendev.org/#/c/723044/
- https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Change-Id: I9fd7b10805b00a0615f0ad1b5a682bed2eac4359
2020-05-04 18:28:54 +02:00
doc [ussuri][goal] Drop python 2.7 support and testing 2020-02-06 10:25:49 +01:00
oslo_reports Merge "Use unittest.mock instead of third party mock" 2020-04-06 15:06:02 +00:00
releasenotes Update master for stable/ussuri 2020-04-14 10:16:42 +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 Python3 victoria unit tests 2020-04-14 10:16:44 +00:00
babel.cfg exported from oslo-incubator by graduate.sh 2015-06-03 12:49:50 -04: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 Merge "Use unittest.mock instead of third party mock" 2020-04-06 15:06:02 +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 Add py38 package metadata 2020-04-24 08:23:13 -05:00
setup.py remove outdated header 2020-02-11 18:50:21 +01:00
test-requirements.txt Update hacking for Python3 2020-04-02 14:59:15 +02:00
tox.ini Bump default tox env from py37 to py38 2020-04-24 10:25:50 -05: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.