openstack
/
oslo.reports
Code Issues Proposed changes
OpenStack library for creating Guru Meditation Reports and other reports
319 Commits 5 Branches 76 Tags 2.1 MiB
Python 100%
Go to file
yangyawei 5f1602e3db setup.cfg: Replace dashes with underscores 
Setuptools v54.1.0 introduces a warning that the use of dash-separated
options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores. Without
this, we see 'UserWarning' messages like the following on new enough
versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: I8b9c4e1e6fec21134aca37ece8f3881b151d6118
 		2021-05-14 17:35:09 +08:00
doc Adding pre-commit 2020-09-22 10:42:28 +02:00
oslo_reports Replace concatenation with f-strings 2020-12-11 15:45:20 +00: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 Move flake8 as a pre-commit local target. 2021-03-23 13:16:23 +01:00
.stestr.conf Switch to stestr 2018-07-03 16:05:38 +07:00
.zuul.yaml Dropping lower constraints testing 2020-12-18 15:11:40 +01: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
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-23 05:34:29 +00:00
requirements.txt Remove all six usage 2020-10-14 10:24:52 +08:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-14 17:35:09 +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 Remove lower-constraints remnants 2021-02-19 14:57:06 +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.