Content of Log Messages 

A large variety of differently skilled people need to read log messages, and most of them need to do this on a regular basis for several different components. Therefore a uniform structure of the log messages is very helpful to make the controlling work as efficient as possible. A good log message must have the following structure:

·        A short description of the error, event or status information (a brief answer to the question “What has happened?”, respectively “What status is reached?”, including a brief information about the object directly involved (for example, a document number or a property key), if appropriate

·        Information about the location or source (an answer to the question “Where did it happen?”)

·        Information about the consequences (in case of error messages and partly also in case of event notifications (warnings)). This is necessary if there are future impacts on hardware or software components.

·        Information about possible countermeasures (in case of error messages and event notifications (warnings)) to solve the problem. This usually includes a description of who (which addressee/role) must perform countermeasures.

If solving the problem is complicated and requires a detailed description, the referencing of external information has to be considered.