soamlog

Dynamically changes the log level for Symphony components.

Synopsis

soamlog subcommand  [options ]
soamlog  -h
soamlog -V

Description

Use soamlog to dynamically change the level of detail logged for messages and errors. The log-level change becomes effective immediately and remains in effect until the host is restarted or the affected process or application is closed.

Symphony component log files are written to the logs directory in SOAM_HOME on the host where the process runs.

When the client path is in the current user's path environment, application logs are written to the directory where the client executable is run. If the client executable path is not in the current user's path environment, application logs are written to the directory where the client executable resides.

Use the log4j.properties file on the host on which a Symphony component runs to customize the contents of the log files for that component. The log4j.properties file is located in the conf directory in SOAM_HOME.

In Symphony DE, all users can change any log level.

In Symphony, the cluster or consumer administrator must have permission to use this command. The cluster administrator can change the logging options for the Session Director (sd). The consumer administrator can change the log levels for the session manager (ssm), service instance manager (sim) and workload of their applications.

-h

Prints command usage to stdout and exits.

-V

Prints product version to stdout and exits.

Subcommand synopsis

sd_all | sd_logger -l  log_level [-u  user_name ] [-x  password ]
ssm_all | ssm_logger application_name -l  log_level [-u  user_name ] [-x  password ]
sim_all | sim_logger application_name -l  log_level [-u  user_name ] [-x  password ]
soamdeploy_all | soamdeploy_logger application_name -l  log_level [-u  user_name ] [-x  password ]
workload application_name -l  log_level [-u  user_name ] [-x  password ]

sd_all | sd_logger -l log_level [-u user_name] [-x password]

sd_all

For activity relating to the Session Director, changes the log level for all logger classes in the sd.log4j.properties file, including those without the sd prefix.

sd_logger

Specifies the name of the log4j.logger you want to change the log level of. For example:

  • SD—Changes the log level for all logger classes in sd.log4j.properties, that are prefixed with sd.

Refer to the appropriate log4j.properties file (in $SOAM_HOME/conf on Linux, %SOAM_HOME%\conf on Windows) for the names of all related loggers. If an invalid logger name is specified, the component log levels are not changed.

-l log_level

Specifies one of the following log levels (listed in order of increasing detail):


Level

Description

LOG_INFO

Log all informational messages and more serious messages.

LOG_WARN

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

LOG_ERROR

Log only those messages that indicate error conditions.

LOG_FATAL

Log only those messages in which the system is unusable.

LOG_DEBUG

Log all debug-level messages.

LOG_ALL

Log all available messages.


-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the log level of the session director

Change the log level of all session director loggers to LOG_ERROR.

soamlog sd_all -l LOG_ERROR

ssm_all | ssm_logger application_name -l log_level [-u user_name] [-x password]

ssm_all

For activity relating to the specified application and the related session manager, changes the log level of all logger classes in the ssm.log4j.properties file, including those without the ssm prefix.

ssm_logger

Specifies the name of the log4j.logger you want to change the log level of. For example:

  • ssm—Changes the log level of all logger classes in the ssm.log4j.properties file, that are prefixed with ssm.

  • ssm.ssmbackend—Changes the log level of all logger classes in the ssm.log4j.properties file, that are prefixed with backend.

Refer to the appropriate log4j.properties file (in$SOAM_HOME/conf on Linux, %SOAM_HOME%\conf on Windows) for the names of all related loggers. If an invalid logger name is specified, the component log levels are not changed.

application_name

Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.

This application must be registered. Log levels of enabled applications can be changed.

-l log_level

Specifies one of the following log levels (listed in order of increasing detail):


Level

Description

LOG_INFO

Log all informational messages and more serious messages.

LOG_WARN

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

LOG_ERROR

Log only those messages that indicate error conditions.

LOG_FATAL

Log only those messages in which the system is unusable.

LOG_DEBUG

Log all debug-level messages.

LOG_ALL

Log all available messages.


-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the log level of the session manager backend loggers

Change the log level of the ssm backend loggers for the sampleApp application to LOG_FATAL.

soamlog ssm.ssmbackend sampleApp -l LOG_FATAL

sim_all | sim_logger application_name -l  log_level [-u user_name] [-x password]

sim_all

For activity relating to the specified application and the service instance manager, changes the log level for all logger classes in the sim.log4j.properties file, including those without the sim prefix.

sim_logger

Specifies the name of the log4j.logger for which you want to change the log level. For example:

  • sim—Changes the log level for all logger classes in the sim.log4j.properties file, that are prefixed with sim.

  • sim.backend—Changes the log level for all logger classes in the sim.log4j.properties file, that are prefixed with backend.

Refer to the appropriate log4j.properties file (in $SOAM_HOME/conf on Linux, %SOAM_HOME%\conf on Windows) for the names of all related loggers. If you specify an invalid logger name, soamlog does not change the log level for any component.

If you specify an invalid logger name, soamlog does not change the log level for any component.

application_name

Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.

-l log_level

Specifies one of the following log levels (listed in order of increasing detail):


Level

Description

LOG_INFO

Log all informational messages and more serious messages.

LOG_WARN

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

LOG_ERROR

Log only those messages that indicate error conditions.

LOG_FATAL

Log only those messages in which the system is unusable.

LOG_DEBUG

Log all debug-level messages.

LOG_ALL

Log all available messages.


-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the log level of the service instance manager for an application

Change the log level of the sim backend loggers for the sampleApp application to LOG_WARN.

soamlog sim.backend sampleApp -l LOG_WARN

soamdeploy_all | soamdeploy_logger application_name -l  log_level [-u user_name] [-x password]

soamdeploy_all

For activity relating to soamdeploy that are started by SIM, changes the log level for all logger classes in the soamdeploy.log4j.properties file, including those without the soamdeploy prefix.

soamdeploy_logger

Specifies the name of the log4j.logger for which you want to change the log level. For example:

  • soamdeploy—Changes the log level for all logger classes in the soamdeploy.log4j.properties file, that are prefixed with soamdeploy.

Refer to the appropriate log4j.properties file (in $SOAM_HOME/conf on Linux, %SOAM_HOME%\conf on Windows) for the names of all related loggers. If you specify an invalid logger name, soamlog does not change the log level for any component.

If you specify an invalid logger name, soamlog does not change the log level for any component.

application_name

Specifies the name of the application. The application name is the same as it appears in the application profile. Enclose the application name in double quotes (" ") if it contains spaces. Precede the application name with two dashes (--) if it starts with a dash.

-l log_level

Specifies one of the following log levels (listed in order of increasing detail):


Level

Description

LOG_INFO

Log all informational messages and more serious messages.

LOG_WARN

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

LOG_ERROR

Log only those messages that indicate error conditions.

LOG_FATAL

Log only those messages in which the system is unusable.

LOG_DEBUG

Log all debug-level messages.

LOG_ALL

Log all available messages.


-u user _name

Specifies the name of the user to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the user name specified here overrides the user name entered in soamlogon.

-x password

Specifies the user password to connect to Symphony for this command. If you are already logged on to Symphony using soamlogon, for this command only the password specified here overrides the password entered in soamlogon.

Change the log level of soamdeploy for an application

Change the log level of all soamdeploy loggers to LOG_ERROR.

soamlog soamdeploy_all sampleApp -l LOG_ERROR

workload application_name -l log_level [-u user_name] [-x password]

For activity relating to the specified application, changes the log level of workload-related log entries in the session manager (ssm), session director (sd) and service instance manager (sim) log files.

Change the workload log level for an application

Change the log level of the sampleApp application

soamlog workload sampleApp -l LOG_DEBUG