sahara/doc/source/contributor/log-guidelines.rst
Luigi Toscano a70a74aa23 Restructure the documentation according the new spec
Group the existing pages in the new top-level categories; each
category can be seen as a separate document and it has its own
index file.
The content of the pages was not changed, with the obvious
exception of the links between pages.

The autogenerated configuration has not been added yet to
configuration/; it will be fixed in a future commit.

At the same time, as suggested by the doc team, consistently
use only one separator in file names (dash, '-') instead of a mix
of dashes, dots and underscores. This may break even more links on
the Internet, but we are breaking them anyway by moving files.
Redirects can be set, but not in this commit.

Closes-Bug: #1706184
Change-Id: I5a10378d9da2603d617ad4193ea8d90e2afc5104
2017-08-04 18:05:40 +02:00

1.3 KiB

Log Guidelines

Levels Guidelines

During the Kilo release cycle the sahara community defined the following log levels:

  • Debug: Shows everything and is likely not suitable for normal production operation due to the sheer size of logs generated (e.g. scripts executions, process execution, etc.).
  • Info: Usually indicates successful service start/stop, versions and such non-error related data. This should include largely positive units of work that are accomplished (e.g. service setup and configuration, cluster start, job execution information).
  • Warning: Indicates that there might be a systemic issue; potential predictive failure notice (e.g. job execution failed).
  • Error: An error has occurred and the administrator should research the error information (e.g. cluster failed to start, plugin violations of operation).
  • Critical: An error has occurred and the system might be unstable, anything that eliminates part of sahara's intended functionalities; immediately get administrator assistance (e.g. failed to access keystone/database, failed to load plugin).

Formatting Guidelines

Sahara uses string formatting defined in PEP 3101 for logs.