blob: dfe4f46210b874e1ee373201d560211ef94726de [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<appendix id="log-codes"> <title>Event log codes</title>
<section id="event-log-codes-format"> <title>Format of the event log codes</title>
<para>
Event log codes issued by @project.name@ have the general syntax
<literal>&lt;XXnnnnL&gt;</literal> where:
<informaltable frame="none" colsep="0" rowsep="0" pgwide="0">
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="6*"/>
<tbody>
<row>
<entry><literal>XX</literal></entry>
<entry>
is a two-letter code (upper-case) identifying the area of the @project.name@ code which issued the log message;
</entry>
</row><row>
<entry><literal>nnnn</literal></entry>
<entry>
is a four-digit message number; and
</entry>
</row>
<row>
<entry><literal>L</literal></entry>
<entry>
is a single-letter (upper-case) code identifying the level of the message.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
The two-letter codes are (this list is not complete):
<informaltable frame="none" colsep="0" rowsep="0" pgwide="0">
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="6*"/>
<tbody>
<row>
<entry><literal>AG</literal></entry> <entry><literal>org.eclipse.virgo.kernel.agent.dm</literal></entry>
</row>
<row>
<entry><literal>DE</literal></entry> <entry><literal>org.eclipse.virgo.kernel.deployer.core</literal></entry>
</row>
<row>
<entry><literal>HD</literal></entry> <entry><literal>org.eclipse.virgo.kernel.deployer.hot</literal></entry>
</row>
<row>
<entry><literal>HR</literal></entry> <entry><literal>org.eclipse.virgo.apps.repository.core</literal></entry>
</row>
<row>
<entry><literal>KE</literal></entry> <entry><literal>org.eclipse.virgo.kernel.core</literal></entry>
</row>
<row>
<entry><literal>KS</literal></entry> <entry><literal>org.eclipse.virgo.kernel.services</literal></entry>
</row>
<row>
<entry><literal>OF</literal></entry> <entry><literal>org.eclipse.virgo.kernel.osgi</literal></entry>
</row>
<row>
<entry><literal>RP</literal></entry> <entry><literal>org.eclipse.virgo.repository</literal></entry>
</row>
<row>
<entry><literal>TC</literal></entry> <entry><literal>org.eclipse.virgo.web.tomcat</literal></entry>
</row>
<row>
<entry><literal>UR</literal></entry> <entry><literal>org.eclipse.virgo.kernel.userregion</literal></entry>
</row>
<row>
<entry><literal>WE</literal></entry> <entry><literal>org.eclipse.virgo.web.core</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
The four-digit numbers identify the message text (with placeholders for inserted values). These are not listed here, but can be discovered by examining the files called
<literal>EventLogMessages.properties</literal>, found in the relevant packages.
</para>
<para>
The single-digit level code is one of:
<informaltable frame="none" colsep="0" rowsep="0" pgwide="0">
<tgroup cols="2">
<colspec colwidth="1*"/>
<colspec colwidth="6*"/>
<tbody>
<row>
<entry><literal>E</literal></entry> <entry>Error level: enabled if level is <literal>ERROR</literal>.</entry>
</row>
<row>
<entry><literal>W</literal></entry> <entry>Warning level: enabled if level is <literal>WARNING</literal> or above.</entry>
</row>
<row>
<entry><literal>I</literal></entry> <entry>Info level: enabled if level is <literal>INFO</literal> or above.</entry>
</row>
<row>
<entry><literal>D</literal></entry> <entry>Debug level: enabled if level is <literal>DEBUG</literal> or above.</entry>
</row>
<row>
<entry><literal>T</literal></entry> <entry>Trace level: always enabled.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
There are never two messages with the same prefix and number, but with different levels.
</para>
</section>
</appendix>