We recorded some thoughts on logging at the quartz sprint

[Reed O'Brien]

Relevant to the conversation currently happening at the core sprint, we
recorded some thoughts on what to log at what level, when and where.
Thoughts and examples appreciated.

+-------+-----------+-----------------------------------+---------+------------+
| Level | Audience  | Purpose                           | Example | I/O
Stream |
+-------+-----------+-----------------------------------+---------+------------+
| ERROR | End User  | Conveys information that requires |         |
   |
|       |           | immediate action. Triggers call   |         |
STDERR   |
|       |           | tree/pager duty.                  |         |
   |
+-------+-----------+-----------------------------------+---------+------------+
| WARN  | End User  | Conveys information that requires |         |
   |
|       |           | user intervention soon to ensure  |         |
STDERR   |
|       |           | continuos smooth operation.       |         |
   |
+-------+-----------+-----------------------------------+---------+------------+
| INFO  | End User  | Conveys contextual "happy path"   |         |
   |
|       |           | information about startup.        |         |
STDOUT   |
+-------+-----------+-----------------------------------+---------+------------+
| DEBUG | Developer | Conveys detailed function level   |         |
   |
|       |           | information to aid in isolating   |         |
STDOUT   |
|       |           | code paths during devleopement.   |         |
   |
+-------+-----------+-----------------------------------+---------+------------+
| TRACE | Developer | Conveys detailed branch level     |         |
   |
|       |           | information to aid in isolating   |         |
STDOUT   |
|       |           | code paths during development.    |         |
   |
+-------+-----------+-----------------------------------+---------+------------+

-- 
Reed O'Brien
✉ reed.obrien at canonical.com
✆ 415-562-6797
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20160628/ba45d183/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: logging.rst
Type: text/x-rst
Size: 1782 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20160628/ba45d183/attachment.bin>