Universal Event Monitor for SOA Troubleshooting
Logging Operations
This information pertains to logging operations that may assist you in troubleshooting, should that be necessary. It includes different types of log files, their locations, methods of directing output, and examples.
The following table identifies the Universal Event Monitor for SOA for AIX / Linux product directories and files located under the /var/opt/universal parent directory.
Windows
Logging output is directed to the Windows Event Viewer.
Directory / File |
Description |
---|---|
log/uac |
Directory containing log and work artifacts for the UAC component. |
work |
Sub-directory used by the web services framework for temporary operations. It requires no user interaction. |
catalina.out |
Container engine log file. |
container.log |
Web services framework log file. |
derby.log |
Database log file. |
uac.log |
uac log file. |
Logging Configuration
At some point, you may want to check the logs for information regarding the operation of Universal Event Monitor for SOA.
Configuration of the logging operations is done via the log4jConfiguration.xml file for the server component.
AIX |
This file is located in the uac product directory at |
---|---|
UNIX |
This file is located in the uac product directory at |
Windows |
This file is located under |
Logging Levels
The logging levels supported by the logging implementation are:
- DEBUG
- INFO
- WARN
- ERROR (default)
The logging level should be changed only at the request of Stonebranch, Inc. Customer Support, as it can have a huge impact on performance.
Server Component Logging Configuration
By default, the logs are configured to write to a file on Linux and to write to the Event Viewer on Windows with the logging level set to error.
Appenders (Sinks) Availability
The following appenders, or sinks, are available to the server component.
Rolling File Appender
This is the default appender on Linux and logs to a file.
The following attributes can be specified:
- Name - name of the appender.
- File - path and name of the log file.
- Max File Size - maximum size of the log file before rolling over.
- Max Backup Index - number of times the log file can be rolled before starting over.
- Class - java class that implements the logger.
- Conversion Pattern - output format of the log text.
LF5 Appender
Logs to the LF5 program with a user interface that displays the log in row/column format and enables searches within the log file. Use this for debug only.
The following attributes can be specified:
- Name - name of the appender.
- Class - java class that implements the logger.
- Max Number Of Records - maximum number of records displayed.
NT Event Log Appender
This is the default appender on Windows and logs to the Windows Event Viewer.
The following attributes can be specified:
- Name - name of the appender.
- Class - java class that implements the logger.
- Source - source component that is outputting the log.
- Conversion Pattern - output format of the log text.
Console Appender
Logs to the console on STDOUT or STDERR.
The following attributes can be specified:
- Name - name of the appender.
- Class - java class that implements the logger.
- Target - specification to log to STDOUT or STDERR (STDERR is the default).
- Conversion Pattern - the output format of the log text.
Server Component log4jConfiguration.xml Example
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false" threshold="all">
<appender name="RollingFileAppender"
class="org.apache.log4j.RollingFileAppender">
<param name="File" value="/var/opt/universal/log/uac/uac.log"/>
<param name="MaxFileSize" value="1000KB"/>
<param name="MaxBackupIndex" value="4"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %-17c{2} (%30F:%L) %3x - %m%n"/>
</layout>
</appender>
<appender name="LF5Appender" class="org.apache.log4j.lf5.LF5Appender">
<param name="MaxNumberOfRecords" value="1000"/>
</appender>
<appender name="NTEventLogAppender"
class="org.apache.log4j.nt.NTEventLogAppender">
<param name="Source" value="UAC"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%c{1} %M - %m%n"/>
</layout>
</appender>
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
<param name="Target" value="System.err"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %-17c{2} (%30F:%L) %3x - %m%n"/>
</layout>
</appender>
<logger name="com.stonebranch" additivity="true">
<level value="error"/>
</logger>
<root>
<priority value="error"/>
<!--<appender-ref ref="LF5Appender"/>-->
<appender-ref ref="RollingFileAppender"/>
<!--<appender-ref ref="ConsoleAppender"/>-->
<!--appender-ref ref="NTEventLogAppender"/-->
</root>
</log4j:configuration>