Setting Up Logging

There are two ways of configuring log4j logging in WSO2 Carbon products: you can manually edit the log4j.properties file or configure logging through the management console. Configuration made through the management console can be persisted in the WSO2 registry so that it is available even after the server restarts. There is also an option to restore the original Log4j configuration from the log4j.properties file using the management console. However, if you modify the log4j.properties file and restart the server, the earlier log4j configuration persisted in the registry is overwritten.

For information on viewing the contents of the logs, see Application Logs and System Logs.

Follow the instructions below to set up logging.

1. Sign in to the ESB Management Console.

2. Click Configure > Logging.

The "Logging Configuration" window appears.

3. Select Persist All Configurations Changes if you want your modifications to be persisted and available even after a server restart.

4. Use the options in the following sections to configure the layout and amount of information about system activity you want to record.

• Global Log4J Configuration
• Configure Log4J Appenders
• Configure Log4J Loggers

Global Log4J Configuration

This section allows you to assign a single log level and log pattern to all loggers.

• Log Level - Reflects a minimum level that this logger cares about. You can view the hierarchy of levels below.
• Log Pattern - Defines the output format of the log file.

Configure Log4J Appenders

Log4j allows logging requests to print to multiple destinations. These output destinations are called appenders. You can attach several appenders to one logger.

• Name-The name of an appender. By default, WSO2 ESB comes with the following log appenders configured:
  • CARBON_CONSOLE - Logs to the console when the server is running.
  • CARBON_LOGFILE - Writes the logs to <ESB_HOME>/repository/logs/wso2-esb.log.
  • SERVICE_APPENDER - Writes mediation time audit messages to <ESB_HOME>/repository/logs/wso2-esb-service.log.
  • TRACE_APPENDER - Writes mediation time tracing/debug messages to the <ESB_HOME>/repository/logs/wso2-esb-trace.log for tracing enabled services.
  • TRACE_MEMORYAPPENDER
  • CARBON_MEMORY
  • CARBON_SYS_LOG - Allows separation of the software that generates messages from the system that stores them and the software that reports and analyzes them.
• Log pattern - Defines the output format of the log file.
• Threshold - Filters log entries based on their level. For example, threshold set to "WARN" will allow log entry to pass into appender if its level is "WARN," "ERROR" or "FATAL," other entries will be discarded.

Hierarchy of Levels:

• TRACE - Designates finer-grained informational events than the DEBUG.
• DEBUG - Designates fine-grained informational events that are most useful to debug an application.
• INFO - Designates informational messages that highlight the progress of the application at coarse-grained level.
• WARN - Designates potentially harmful situations.
• ERROR - Designates error events that might still allow the application to continue running.
• FATAL - Designates very severe error events that will presumably lead the application to abort.

Configure Log4J Loggers

This section allows you to browse through all loggers, define a log level, and switch on/off additivity to any of them. You can filter loggers by the first characters (use the Starts With button) or by a combination of characters (use the Contains button).

• Logger - The name of a logger.
• Parent Logger - The name of a parent logger.
• Level - Allows to select level (threshold) from the drop-down menu. After you specify the level for a certain logger, a log request for that logger will only be enabled if its level is equal or higher to the logger’s one. If a given logger is not assigned a level, then it inherits one from its closest ancestor with an assigned level. See hierarchy of levels above.
• Additivity - Allows to inherit all the appenders of the parent Logger if set as "True."