f60e39e054
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/0b834b7ac136bc6c15a8dcfba941d2a7\n' Change-Id: I42823312bcba2d6927bb7e9492e205d514417095
61 lines
2.5 KiB
ReStructuredText
61 lines
2.5 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/oslo.reports.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
===================================
|
|
oslo.reports
|
|
===================================
|
|
|
|
.. image:: https://img.shields.io/pypi/v/oslo.reports.svg
|
|
:target: https://pypi.python.org/pypi/oslo.reports/
|
|
:alt: Latest Version
|
|
|
|
.. image:: https://img.shields.io/pypi/dm/oslo.reports.svg
|
|
:target: https://pypi.python.org/pypi/oslo.reports/
|
|
:alt: 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.
|
|
|
|
* Free software: Apache license
|
|
* Documentation: http://docs.openstack.org/developer/oslo.reports
|
|
* Source: http://git.openstack.org/cgit/openstack/oslo.reports
|
|
* Bugs: http://bugs.launchpad.net/oslo.reports
|