Log system's User Guide

This document explains how to use Ceylan's Log system and how it works.

Basically, the Log system is made of a Log interface, which describes the contract any Log implementation should fulfill. A basic Log implementation is provided with Ceylan, LogPlugClassical, an a more elaborate one, producing HTML log websites for easier browsing, LogPlugHTML . For direct output on the console, one should use LogPlugConsole.

The Log messages are to be sent to Log channels. There are five default Log channels available :

• display : this Log channel is to be used for any message which should be read by the user,
• comment : this Log channel is to be used for any message which may, or may not, be read by the user. They might interest some users, other not,
• debug : this Log channel is to be used for any message useful for developers to figure out what events occured in the systb,
• warning : this Log channel is to be used to indicate non fatal errors,
• error : this Log channel is to be used to indicate fatal and non recoverable errors.

When a Log message is sent, a level of detail (an unsigned integer) is to be chosen for it. Indeed, each Log listener has its own level of detail too, and a Log listener won't output any Log message whose level of detail is strictly higher than its own registered level : the smaller the number of a level of detail is, the more important the informations it is carrying are.

Please react!

If you have information more detailed or more recent than those presented in this document, if you noticed errors, neglects or points insufficiently discussed, drop us a line!