trivial: Remove cruft from sphinx config file
Change-Id: I707dd369d5a26e463cf3661b82b7563eb575ce5c Signed-off-by: Stephen Finucane <firstname.lastname@example.org>
|1 month ago|
|doc||1 month ago|
|oslo_reports||1 month ago|
|releasenotes||4 months ago|
|.coveragerc||4 years ago|
|.gitignore||6 months ago|
|.gitreview||9 months ago|
|.mailmap||4 years ago|
|.stestr.conf||1 year ago|
|.zuul.yaml||3 months ago|
|CONTRIBUTING.rst||2 years ago|
|HACKING.rst||11 months ago|
|LICENSE||4 years ago|
|README.rst||9 months ago|
|babel.cfg||4 years ago|
|lower-constraints.txt||3 months ago|
|requirements.txt||1 year ago|
|setup.cfg||6 months ago|
|setup.py||2 years ago|
|test-requirements.txt||6 months ago|
|tox.ini||1 month ago|
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.