Logging

Log files are generated for bwadmin, bwagent, AppNodes, and applications. Log files capture all executed commands and, depending on the logging level, the corresponding activities.

Log file configuration follows the Logback standard. (Refer to the Logback Project at http://logback.qos.ch/ for detailed information on configuration parameters.)

The log files created by bwadmin and bwagent are written to the BW_HOME/logs folder. (Log files created by other utilities, such as bwdesign, are also written to this folder.) AppNode log files are written to the /log folder for the AppNode. If you contact TIBCO support, your support representative will most likely ask you to send the appropriate log file.

Logging configurations are customized in the following files:

  • For bwadmin: BW_HOME/bin/bwadmin-logback.xml
  • For bwagent: BW_HOME/bin/bwagent-logback.xml
  • For an AppNode: BW_HOME/domains/domain/<AppSpace>/<AppNode>/logback.xml (created after the AppNode has been started)

Logs can be output to the bwadmin console and a log file. Log files can be retrieved by bwadmin and displayed in the console.

To upload or download a logback file, click the Upload or Download link, from the Admin UI.

Logging Levels

The global logging level for each type of log is set to INFO by default. Five levels are supported. Specifying a level includes all higher levels. Levels are listed below in order from lowest (least restrictive) to highest (most restrictive):

  • TRACE: Records fine-grained informational events.
  • DEBUG: Records fine-grained informational events that help in debugging. Useful for diagnostics.
  • INFO: Records informational messages that highlight the progress of the application. Useful for production mode.
  • WARN: Records potentially harmful situations.
  • ERROR: Records error events that are harmful enough to prevent the application from running.
Note: Setting the logging level to DEBUG can adversely affect the performance, especially when logging SOAP messages with attachments or mail with attachments. In such cases, we recommend fine tuning the loggers to log at ERROR level instead of DEBUG.

See the Debugging topic for information on log file components and error code ranges.

Log File Encoding

Log files are generated according to the configuration specified in the logback.xml file. If the encoding is not specified in the logback.xml file, the system default encoding is used when generating the log files.

To save the log files in a specific encoding like UTF-8, add the charset element to the File Appender Encoder configuration in the logback.xml file. 

<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>test.log</file>
      <append>true</append>
        <encoder>
          <charset>UTF-8</charset>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
  </appender>