About log files and levels

Use the Symphony log files to troubleshoot workload related components such as session director, session manager, and service instance manager.

Log files

The Symphony log files provide information on the general well-being of workload-related daemons and services.

Default log file locations

Symphony component log files

  • Windows—%SOAM_HOME%\logs

  • Linux/UNIX—$SOAM_HOME/logs

Symphony API log files

The Symphony API log file is written to the directory where the client executable resides.

Log file names

Log files are named according to the component they are logging and the host name where the component runs. For example, a log file for the session director running on hostA is named sd.hostA.log.

The following table lists possible log files and on which hosts they can be found.


Log file

Description

Host on which you can find the log file

sd.host_name.log

Messages, events, and errors for session director.

The host on which session director is running.

ssm.host_name.application_name.log

Messages, events, and errors related to workload scheduling for the specified application.

The host on which session manager is running.

sim.host_name.application_name.log

Messages, events, and errors related to tasks that ran for the specified application.

Each compute host running tasks for the application.

api.host_name.log

Messages, events, and errors for the client application that submits work to the system.

The host on which the client application runs.

agent.host_name.log

Only in Symphony DE. Messages, events, and errors related to startup and shut down of Symphony DE processes.

Only in Symphony DE. Found on every host on which Symphony DE runs.

cli.log

Messages, events, and errors related to the command line.

When enabled, found on the host from which the command was issued, in the directory from which the command was issued. By default, no cli.log files exist.


Logging configuration files

Default properties file location

The default locations of the logging configuration (properties) files are:

  • Windows—%SOAM_HOME%\conf

  • Linux/UNIX—$SOAM_HOME/conf

Available properties files

The following properties files are available:

  • agent.log4j.properties

  • api.log4j.properties

  • cli.log4j.properties

  • rs.log4j.properties

  • sd.log4j.properties

  • sim.log4j.properties

  • ssm.log4j.properties

Log file formats

Log file entries follow a format that depends on the log level in which the message was logged.

File format customization

The format of the log-file entries can be changed. For more details, see the log4cxx documentation: http://logging.apache.org/log4cxx/manual/classlog4cxx_1_1PatternLayout.html

Synopsis for INFO log level

time_stamp log_level [process_ID:thread_ID] logger_name - info_message

Synopsis for WARN, ERROR, and FATAL log level messages

time_stamp log_level [process_ID:thread_ID] logger_name - Code[Internal_Code]: file_name:line_number message

Log file attributes

The following information is included for all messages recorded at the INFO, WARN, ERROR, and FATAL log levels:

time_stamp log_level [process_ID:thread_ID] logger_name

The following information is included for some errors:

Code[Internal_Code]: file_name:line_number

The remainder is the main body of the message. It can include information such as error domain, consumer ID, command, workDir, and hostname, along with the message.

Attributes of INFO, WARN, DEBUG, ERROR, and FATAL log level messages

time_stamp

Displays the time when the exception was thrown. The format for the time stamp is:

Year-month-day hour:minute:second.millisecond 
Note:

For Linux/UNIX users only—By default, the time displayed in the logger files is GMT. The format of the timestamp can be changed by editing the related time zone settings in each log4j.properties file in $SOAM_HOME/conf. The properties files contain instructions on how to implement this change.

log_level

Displays the log level of the logger that logged the message.


Level

Description

FATAL

Logs only those messages in which the system is unusable.

ERROR

Logs only those messages that indicate error conditions or more serious messages.

WARN

Logs only those messages that are warnings or more serious messages. This is the default level of debug information.

INFO

Logs all informational messages and more serious messages.

DEBUG

Logs all debug-level and INFO messages.

ALL

Logs all available messages.


process_ID

Displays the ID of the Symphony component. The process ID is used to differentiate between daemons when more than one daemon of the same type runs on the host, such as when multiple session managers run on the same host.

Note:

The soamview app command displays the process ID of the session manager and soamview task displays the process ID of the service instance. The identity of the process that generated the message can be determined by comparing the process ID in the message with the process IDs displayed by soamview app and soamview task.

thread_ID

Displays the thread of the program that triggered the message.

logger_name

Displays the name of the logger component used to set the log level of the component that generated the message. The log4j logger components are listed in the properties files. These loggers are used to set the logging levels of specific components such as session director, session manager, service instance manager, repository service, and the CLI.

error_message

Displays the error message generated by the Symphony API.

error_code

Displays the error code that uniquely identifies the error. Error codes and their corresponding messages are listed in the Error Message Reference.

file_name

Displays the name of the source code file that triggered the message.

line_number

Displays the number of the line in the file that triggered the message.

domain

Displays the domain in which the message was triggered. Domains are virtual groups that categorize messages to precisely identify the component the message applies to.

Possible domains are:

  • Application—Application configuration and deployment

  • SOAM—Any Symphony component such as session manager and session director

  • VEM—Resource management performed by EGO (not available in Symphony DE)

  • OS—Operating system resource management of resources such as memory and disk capacity