Universal Command Agent for SOA Logging Configuration

Owned by Stonebranch (Deactivated)
Feb 06, 2023
3 min read


Overview

These pages provide information of how to check the logs for information regarding the operation of Universal Command Agent for SOA.

Configuration of the logging operations is done via the log4jConfiguration.xml file for both Universal Application Container (UAC) and Universal Application Interface (UAI).

Logging Levels

The logging levels supported by the logging implementation are:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR (default)
  • FATAL

Note

The logging level should be changed only at the request of Stonebranch, Inc. Customer Support, as it can have a huge impact on performance.

UAC Logging Configuration

For UAC, 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) Available to UAC

The following appenders, or sinks, are available to UAC.

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 a Java 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.

UAI Logging Configuration

For UAI, the logs are configured to write to the console on both Linux and Windows with the logging level set to error.

Appenders (Sinks) Available to UAI

The following appenders, or sinks, are available to UAI:

Rolling File Appender

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 a Java 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.

Console Appender

This is the default appender on Linux and 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 - output format of the log text.