FORMAT

The FORMAT element specifies the format of each log message.

The FORMAT element takes an optional attribute Type (whose value can only be TEXT) and a list of field identifiers.

The field identifiers indicate the line format. The fields are separated by spaces. The order of the fields determines the order of the log output.

Table 1. Log message field identifiers
Type Description
category Name of the category filter of the event.
component Name of the component that generate the event.
date Date of the event.
time Time of the event.
relative-time Time elapsed since the dispatcher has started.
process-id Process identifier.
thread-id Thread identifier.
location The file name and line number where the event occurred. Replaces line and file Type attributes from earlier versions.
contexts Internal data representing the successive context the process went through to reach the logged event. These data is formatted as type=value pairs separated by semicolons.
event-type Event name.
event-params Event details. XML fragment representing the structured information attached to the event. This XML fragment will be on a single line. If used this field should be the last one as it can contain data with spaces.
When parsing the content of log files:

Example

<FORMAT Type="TEXT">time event-type event-params</FORMAT>
<FORMAT>date time relative-time process-id thread-id contexts
 event-type event-params</FORMAT>

Parent elements

This element is a child of one of the following elements: LOG