Configuring Siebel Gateway Log Files

The Siebel Gateway logs information in the cloudgateway.log file that is related to the application container in the SIEBEL_ROOT/applicationcontainer_internal directory where the Siebel Gateway is installed, such as /siebel/ses/applicationcontainer_internal. For information about installing and configuring the Siebel Gateway, see Siebel Installation Guide.

If you plan to configure the log level for the Siebel Gateway application container, it is recommended to do so after you finish configuring Siebel Gateway using Siebel Management Console.

Logging for the cloudgateway.log file involves editing the log4j2-siebel.properties file. (Values from the gateway.properties file are no longer used for Siebel Gateway logging.) After modifying the log4j2-siebel.properties file, you must restart the application container, as described in Siebel Installation Guide.

To configure Siebel Gateway logging for the cloudgateway.log file

  1. Edit the log4j2-siebel.properties file, which is located in the SIEBEL_ROOT/applicationcontainer_internal/webapps/siebel/WEB-INF/ directory where the Siebel Gateway is installed.

  2. When configuring the log level, modify only the following section, and no other part of the file. The default log level configured in the file is ERROR. For example, you can change the level from ERROR to ALL.

    For log4j2-siebel.properties

    logger.Servlet.level = ALL
    logger.Servlet.additivity = false
    logger.Servlet.appenderRef.rolling.ref = Servlet
    
    logger.CG_LOGGER.level = ALL
    logger.CG_LOGGER.name = CG_LOGGER
    logger.CG_LOGGER.additivity = false
    logger.CG_LOGGER.appenderRef.rolling.ref = CG_LOGGER
    

    Set the 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.

  3. Optionally, you can configure the log4j2-siebel.properties file to include the monitorInterval parameter, which allows changing the log level at runtime for all application container logs that are controlled by this file and not by profiles in Siebel Management Console. If you change the following line:

    For log4j2-siebel.properties

    status = warn
    name = Siebel
    monitorinterval = 300
    

    Then Apache Tomcat checks for changes in the log level within the specified interval (300 seconds, or 5 minutes) and, if the log level changed, then the log statements are written to log files to reflect the change in the log level.

Related Topics

Configuring the Common Logger for Siebel Application Interface

Related Books

Siebel Installation Guide