Logging is one of the most important aspects of a production-grade server. A properly configured logging system is vital for identifying errors, security threats and usage patterns. All WSO2 products are shipped with the log4j logging capabilities, which generates administrative activities and server side logs. The
log4j.properties file, which governs how logging is performed by the server can be found in the
Java logging and Log4j integration: In addition to the logs from libraries that use Log4j, all logs from libraries (such as, Tomcat, Hazelcast and more) that use Java logging framework are also visible in the same log files. That is, when Java logging is enabled in Carbon, only the Log4j appenders will write to the log files. If the Java Logging Handlers have logs, these logs will be delegated to the log events of the corresponding Log4j appenders. A Pub/Sub registry pattern implementation has been used in the latter mentioned scenario to plug the handlers and appenders. The following default log4j appenders in the
log4j.properties file are used for this implementation:
Managing log growth: Log growth can be managed by the following configurations in the
- Configurable log rotation: By default, log rotation is on a daily basis.
- Log rotation based on time as opposed to size: This helps to inspect the events that occurred during a specific time.
- Log files are archived to maximise the use of space.
log4j-based logging mechanism uses appenders to append all the log messages into a file. That is, at the end of the log rotation period, a new file will be created with the appended logs and archived. The name of the archived log file will always contain the date on which the file is archived.
Identifying forged messages: From Carbon 4.4.3 onwards, it is possible to use a UUID in log messages so that any forged messages can be easily identified. The UUID is logged using a new conversion character ‘K’ in the log pattern layout. By default, the UUID will be generated every time the server starts. However, you can configure your server to generate the UUID more or less frequently, by specifying an exact time interval in the
log4j.properties file. See the section on configuring log4j properties for more information on log patterns.
See the following topics related to log management in WSO2 Carbon products;
Configuring products for log monitoring
Given below are ways to configure log4j files:
- Manually editing the
- Configure logging using the management console.
Using the management console to configure logging is recommended because all changes made to log4j through the management console persists in the WSO2 Registry. Therefore, those changes will be available after the server restarts and will get priority over what is defined in the actual
log4j.properties file. Also, note that the logging configuration you define using the management console will apply at run time. However, if you modify the
log4j.properties file and restart the server, the earlier log4j configuration that persisted in the registry will be overwritten. There is also an option in the management console to restore the original log4j configuration from the
In each Carbon product, users can configure and adjust the logging levels for each type of activity/ transaction. There are several ways to view the system log and application logs of a running Carbon instance.
- Through the log files that are stored in the
<PRODUCT_HOME>/repository/logsfolder. This folder contains current logs in a log file with a date stamp. Older logs are archived in the
- Through the command prompt/shell terminal that opens when you run the "
wso2server.sh" files to start the Carbon server.
- Through the management console of your product.
Limiting the size of the wso2carbon.log file
You can limit the size of the
<PRODUCT_HOME>/repository/logs/wso2carbon.log file by following the steps given below. This is useful if you want to archive the logs and get backups periodically.
- Change the
log4j.appender.CARBON_LOGFILE=org.wso2.carbon.utils.logging.appenders.CarbonDailyRollingFileAppenderappender in the
log4j.propertiesfile as follows.
Add the following two properties under
If the size of the log file is exceeding the value defined in the
MaxFileSizeproperty, then the content is copied to a backup file and the logs are continued to be added to a new empty log file. The
MaxBackupIndexproperty makes the Log4j keep a given maximum number of backup files for the logs.