5.5. Logging Sample Configurations

Procedure 5.1. Configure the Root Logger

1. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <root-logger>
         <level name="INFO"/>

2. List handlers

   handlers is a list of log handlers that are used by the root logger.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
        <root-logger>
           <level name="INFO"/>
           <handlers>
              <handler name="CONSOLE"/>
              <handler name="FILE"/>
           </handlers>
        </root-logger>
     </subsystem>

Procedure 5.2. Configure a Log Category

1. Define the Category

   Use the category property to specify the log category from which log messages will be captured.
   The use-parent-handlers is set to "true" by default. When set to "true", this category will use the log handlers of the root logger in addition to any other assigned handlers.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <logger category="com.company.accounts.rec" use-parent-handlers="true">

2. Set the level property

   Use the level property to set the maximum level of log message that the log category records.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <logger category="com.company.accounts.rec" use-parent-handlers="true">
         <level name="WARN"/>

3. List handlers

   handlers is a list of log handlers.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <logger category="com.company.accounts.rec" use-parent-handlers="true">
         <level name="WARN"/>
         <handlers>
            <handler name="accounts-rec"/>
         </handlers>
      </logger>
   </subsystem>

Procedure 5.3. Configure the Console Log Handler

1. Add the Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">

2. Set the level Property

   The level property sets the maximum level of log messages recorded.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">
         <level name="INFO"/>

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">
         <level name="INFO"/>
         <encoding value="UTF-8"/>

4. Define the target Value

   The target property defines the system output stream where the output of the log handler goes. This can be System.err for the system error stream, or System.out for the standard out stream.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">
         <level name="INFO"/>
         <encoding value="UTF-8"/>
         <target value="System.out"/>

5. Define the filter-spec Property

   The filter-spec property is an expression value that defines a filter. The example provided defines a filter that does not match a pattern: not(match("JBAS.*")).

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">
         <level name="INFO"/>
         <encoding value="UTF-8"/>
         <target value="System.out"/>
         <filter-spec value="not(match(&quot;JBAS.*&quot;))"/>

6. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

   <subsystem xmlns="urn:jboss:domain:logging:1.2">
      <console-handler name="CONSOLE" autoflush="true">
         <level name="INFO"/>
         <encoding value="UTF-8"/>
         <target value="System.out"/>
         <filter-spec value="not(match(&quot;JBAS.*&quot;))"/>
         <formatter>
            <pattern-formatter pattern="%K{level}%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
         </formatter>
      </console-handler>
   </subsystem>

Procedure 5.4. Configure the File Log Handler

1. Add the File Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

   <file-handler name="accounts-rec-trail" autoflush="true">

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <file-handler name="accounts-rec-trail" autoflush="true">
       <level name="INFO"/>

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

   <file-handler name="accounts-rec-trail" autoflush="true">
       <level name="INFO"/>
       <encoding value="UTF-8"/>

4. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

   <file-handler name="accounts-rec-trail" autoflush="true">
       <level name="INFO"/>
       <encoding value="UTF-8"/>
       <file relative-to="jboss.server.log.dir" path="accounts-rec-trail.log"/>

5. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

   <file-handler name="accounts-rec-trail" autoflush="true">
       <level name="INFO"/>
       <encoding value="UTF-8"/>
       <file relative-to="jboss.server.log.dir" path="accounts-rec-trail.log"/>
       <formatter>
           <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
       </formatter>

6. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

   <file-handler name="accounts-rec-trail" autoflush="true">
       <level name="INFO"/>
       <encoding value="UTF-8"/>
       <file relative-to="jboss.server.log.dir" path="accounts-rec-trail.log"/>
       <formatter>
           <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
       </formatter>
       <append value="true"/>
   </file-handler>

Procedure 5.5. Configure the Periodic Log Handler

1. Add the Periodic Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

   <periodic-rotating-file-handler name="FILE" autoflush="true">

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>

4. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>
      <formatter>
         <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
      </formatter>

5. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>
      <formatter>
         <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
      </formatter>
      <file relative-to="jboss.server.log.dir" path="server.log"/>

6. Set the suffix Value

   The suffix is appended to the filename of the rotated logs and is used to determine the frequency of rotation. The format of the suffix is a dot (.) followed by a date string, which is parsable by the java.text.SimpleDateFormat class. The log is rotated on the basis of the smallest time unit defined by the suffix. For example, yyyy-MM-dd will result in daily log rotation. See http://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>
      <formatter>
         <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
      </formatter>
      <file relative-to="jboss.server.log.dir" path="server.log"/>
      <suffix value=".yyyy-MM-dd"/>

7. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

   <periodic-rotating-file-handler name="FILE" autoflush="true">
      <level name="INFO"/>
      <encoding value="UTF-8"/>
      <formatter>
         <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
      </formatter>
      <file relative-to="jboss.server.log.dir" path="server.log"/>
      <suffix value=".yyyy-MM-dd"/>
      <append value="true"/>
   </periodic-rotating-file-handler>

Procedure 5.6. Configure the Size Log Handler

1. Add the Size Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.
   When autoflush is set to "true" the log messages will be sent to the handler's target immediately upon request.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>

3. Set the encoding Output

   Use encoding to set the character encoding scheme to be used for the output.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>

4. Set the file Object

   The file object represents the file where the output of this log handler is written to. It has two configuration properties: relative-to and path.
   The relative-to property is the directory where the log file is written to. JBoss Enterprise Application Platform 6 file path variables can be specified here. The jboss.server.log.dir variable points to the log/ directory of the server.
   The path property is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the relative-to property to determine the complete path.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>
      <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>

5. Specify the rotate-size Value

   The maximum size that the log file can reach before it is rotated. A single character appended to the number indicates the size units: b for bytes, k for kilobytes, m for megabytes, g for gigabytes. For example: 50m for 50 megabytes.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>
      <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>
      <rotate-size value="500k"/>

6. Set the max-backup-index Number

   The maximum number of rotated logs that are kept. When this number is reached, the oldest log is reused.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>
      <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>
      <rotate-size value="500k"/>
      <max-backup-index value="5"/>

7. Specify the formatter

   Use formatter to list the log formatter used by the log handler.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>
      <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>
      <rotate-size value="500k"/>
      <max-backup-index value="5"/>
      <formatter>
           <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
       </formatter>

8. Set the append Property

   When the append property is set to "true", all messages written by this handler will be appended to an existing file. If set to "false" a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.

   <size-rotating-file-handler name="accounts_debug" autoflush="false">
      <level name="DEBUG"/>
      <encoding value="UTF-8"/>
      <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/>
      <rotate-size value="500k"/>
      <max-backup-index value="5"/>
      <formatter>
           <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
       </formatter>
      <append value="true"/>
   </size-rotating-file-handler>

Procedure 5.7. Configure the Async Log Handler

1. Add the Async Log Handler Identifier Information

   The name property sets the unique identifier for this log handler.

   <async-handler name="Async_NFS_handlers">

2. Set the level Property

   The level property sets the maximum level of log message that the root logger records.

   <async-handler name="Async_NFS_handlers">
      <level name="INFO"/>

3. Define the queue-length

   The queue-length defines the maximum number of log messages that will be held by this handler while waiting for sub-handlers to respond.

   <async-handler name="Async_NFS_handlers">
      <level name="INFO"/>
      <queue-length value="512"/>

4. Set Overflow Response

   The overflow-action defines how this handler responds when its queue length is exceeded. This can be set to BLOCK or DISCARD. BLOCK makes the logging application wait until there is available space in the queue. This is the same behavior as an non-async log handler. DISCARD allows the logging application to continue but the log message is deleted.

   <async-handler name="Async_NFS_handlers">
      <level name="INFO"/>
      <queue-length value="512"/>
      <overflow-action value="block"/>

5. List subhandlers

   The subhandlers list is the list of log handlers to which this async handler passes its log messages.

   <async-handler name="Async_NFS_handlers">
      <level name="INFO"/>
      <queue-length value="512"/>
      <overflow-action value="block"/>
      <subhandlers>
         <handler name="FILE"/>
         <handler name="accounts-record"/>
      </subhandlers>
   </async-handler>