Configuring Additional System Logging

This chapter describes other system logging configurations and information that can be used to uncover errors or improper application behavior in addition to Siebel Server and component event logging. It includes the following topics:

About Environment Variables for System Logging

The following system environment variables can be set to assist with logging other aspects of the Siebel application deployment. For information about configuring these environment variables on both Microsoft Windows and UNIX, see Siebel System Administration Guide or review the documentation specific to your operating system for details on changing these variables.

SIEBEL_LOG_EVENTS. The SIEBEL_LOG_EVENTS environment variable sets the event logging level, which determines the extent of information captured in the log file. For level settings and descriptions of information captured, see the table in About Events and Event Logging. More information is captured when the environment variable is set to a higher numeric value, and less information is captured when the variable is set to a lower numeric value. The numeric value is inversely proportional to the severity of the information (0 is more severe than 5, for instance). More disk space is consumed and performance is hindered when the value is set to a value of 5 than a value of 0.
SIEBEL_LOG_ARCHIVES. The SIEBEL_LOG_ARCHIVES environment variable determines the number of log files archived. Set this value to a positive integer; this value indicates the number of files that are saved. For example, if the value is 3, then only the three most recent log files are retained, any additional log files are deleted. When a new log is created, program.log, the previous versions are archived as program_1.log, program_2.log, and so on. The numbers in the filename increase as the file becomes Statistics older. The oldest log file that numbers past the integer setting is deleted. The default value of this variable is ten.
SIEBEL_LOG_DIR. The SIEBEL_LOG_DIR environment variable determines the log file location. Set this variable to change the location from the default directory. Make sure this directory already exists, access permission to write a file in that location is available, and sufficient space is free to support the log file.
SIEBEL_CRASH_HANDLER. The SIEBEL_CRASH_HANDLER environment variable enables the creation of files when there is a malfunction or failure. For information about these files, see About Other Siebel Server Log Files. The default setting is 1, which enables the creation of such files. Setting this variable to 0 disables this function. Only set this variable in consultation with Oracle Global Customer Support. For help with setting this variable, create a service request (SR) on My Oracle Support.
SIEBEL_ASSERT_MODE. The SIEBEL_ASSERT_MODE environment variable enables the creation of assert files. For information about assert files, see About Other Siebel Server Log Files. The default setting is 0, which disables the creation of assert files. Only set this variable in consultation with Oracle Global Customer Support. For help with setting this variable, create a service request (SR) on My Oracle Support.
SIEBEL_SESSMGR_TRACE. The SIEBEL_SESSMGR_TRACE environment variable enables tracing for session manager, which is part of the Siebel Application Interface. By default, this variable is set to 0, which logs fatal and error events to the Siebel Application Interface log file. For information about Siebel Application Interface log files, see About Siebel Application Interface Logging. To enable detailed logging of session manager, set this variable to 1. For more information about configuring logging for Siebel Application Interface, see Configuring Siebel Application Interface Logging.
SIEBEL_SISNAPI_TRACE. The SIEBEL_SISNAPI_TRACE environment variable enables tracing for SISNAPI, which is a Siebel-proprietary communication protocol between the Siebel Application Interface and the Siebel Servers. By default, this variable is set to 0, which logs fatal and error events to the Siebel Application Interface log file. For information about Siebel Application Interface log files, see About Siebel Application Interface Logging. To enable detailed logging of SISNAPI, set this variable to 1. For more information about configuring logging for Siebel Application Interface, see Configuring Siebel Application Interface Logging.
SIEBEL_STDERROUT. The SIEBEL_STDERROUT environment variable enables logging of the standard error files. For more information about standard error files, see Configuring Standard Error Files. By default, this variable is set to 0, which disables standard error file logging. To enable logging of standard error files, set this variable to 1.

Configuring Siebel Gateway Log Files

The Siebel Gateway logs information related to the application container in the SIEBEL_ROOT/applicationcontainer directory where the Siebel Gateway is installed, such as /siebel/ses/applicationcontainer. For information about installing and configuring the Siebel Gateway, see the Siebel Installation Guide for the operating system you are using.

To configure Siebel Gateway logging for the cloudgateway.log file

Edit the gateway.properties file, which is located in the SIEBEL_ROOT/applicationcontainer/webapps directory where the Siebel Gateway is installed.
Set log4j.appender.file.Level to one of the following values:
- ALL. The ALL level has the lowest possible rank and is intended to turn on all logging.
- TRACE. The TRACE level designates finer-grained informational events than DEBUG.
- DEBUG. The DEBUG level designates fine-grained informational events that are most useful to debug an application.
- INFO. The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
- WARN. The WARN level designates potentially harmful situations.
- ERROR. The ERROR level designates error events that might still allow the application to continue running.
- FATAL. The FATAL level designates very severe error events that will presumably lead the application to abort.
  Additionally, you can use the following log level to turn off logging:
- OFF. The OFF level has the highest possible rank and is intended to turn off logging.

Configuring Standard Error Files

Standard error files contain process messages that are directed to standard error and standard out. These messages come from Siebel Server or third-party components and contain important information to help diagnose Siebel Server functionality issues. For example, the information contained in a Siebel Server process message can help identify instances where siebmtshmw, the process shell in which the Siebel Application Object Manager component runs, is unable to start due to problems like incorrect LIBPATH setting or a corrupt registry. For more information about Siebel Server processes, see Siebel System Administration Guide.

When configured, process messages are saved to file in the directory labeled SIEBSRVR_ROOT/log/StdErrOut. The format of the standard error files is as follows:

stderrout_$Process_ID_$Timestamp.log

where:

Process_ID is the operating system process ID number (PID).
Timestamp is the log file creation time, in YYYY-MM-DD HH:MM:SS format.

Standard error file logging is not enabled by default.

To configure standard error file logging

On the computer running the Siebel Server, set the following environment variable to the given value:
- SIEBEL_STDERROUT = 1
For more information about this variable, see About Environment Variables for System Logging.
For more information about setting environment variables, see Siebel System Administration Guide.
Stop and restart the computer running the Siebel Server for the environment variable to take effect.

About Other Siebel Server Log Files

Siebel CRM generates other text log files in the binary (bin) subdirectory of the Siebel Server root directory. These files record conditional responses when certain portions of code are executed during the operation of the application. They appear in the following form listed in the following table.

Log Filename	Description
siebel_assert*.txt	Indicates a fatal condition that might have led to a failure or data corruption.
siebel_crash*.txt	Indicates a process has malfunctioned or failed. These files are produced on UNIX platforms only.
siebel_prefer*.txt	Indicate a less critical error condition that arises but did not lead to a failure, malfunction, or data corruption.

If these files are generated during the normal running of processes when no errors occur, then they can be ignored (or deleted, because they can become very large). However, if these files are generated when errors occur (especially failures), then you can send these files to Oracle Global Customer Support for investigation by creating a service request (SR) on My Oracle Support.

About Flight Data Recorder Log Files

Siebel flight data recorder (FDR) files are records of system and server component behavior at run time. In the event of a system or server component failure, the settings and events leading up to the failure are captured and logged. You can send the Siebel flight data recorder log file to Oracle Global Customer Support by creating a service request (SR) on My Oracle Support. The log file is used to troubleshoot and analyze the specific settings and events that occurred before the failure.

The Siebel flight data recorder log files are stored in the binary (bin) subdirectory of the Siebel Server root directory. They appear in the following form:

TYYYYMMDDHHMM_PProcess_ID.fdr

where:

YYYYMMDDHHMM is the timestamp.
Process_ID is the identification number of the process that failed or was stopped.

For example:

T201705181601_P001376.fdr

is a filename that is based on a component that was started on May 18, 2017 at 4:01 PM, where the process ID value was 1376.

The Siebel flight data recorder feature is enabled by default. However, FDR activation requires the execution of at least one instrumentation point to generate a log file. If a failure happens before execution of the first instrumentation point, then no log file is generated. Instrumentation points are embedded in some workflow business services to provide capture-processing details in case of a system failure or server component failure. For more information about instrumentation and instrumentation points, see Siebel Performance Tuning Guide and Siebel Business Process Framework: Workflow Guide, respectively.

Note: FDR files are stored in binary format and cannot be read with a text editor.

Setting the environment variable SIEBEL_CRASH_HANDLER to 0 disables the creation of FDR files, in addition to several other logging functions. Only set this variable to 0 in consultation with Oracle Siebel Global Customer Support by creating a service request (SR) on My Oracle Support.

About Java EE Connector Architecture Logging

The Java EE Connector Architecture (JCA) provides a Java interface solution between application servers and Enterprise Information Systems (EIS). Siebel CRM supports JCA with the Siebel Resource Adapter. The Siebel Resource Adapter supports the invocation of business services to perform operations, such as pooling connections and managing security. JCA allows you to keep logs for such operations. For more information about JCA logging, see Transports and Interfaces: Siebel Enterprise Application Integration. For more information about JCA, see: http://www.oracle.com/technetwork/java/index.html