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 <PRODUCT_HOME>/repository/conf directory.
Note that 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:
org.wso2.carbon.logging.appenders.CarbonConsoleAppenderorg.wso2.carbon.logging.appenders.CarbonDailyRollingFileAppender
For more information on appenders, loggers, their log levels and logging, see http://logging.apache.org/log4j.
Logging functionality is provided by the following feature in the WSO2 feature repository:
Name : WSO2 Carbon - Logging Management Feature
Identifier : org.wso2.carbon.logging.mgt.feature.group
If the above feature is not bundled in your product by default, you can install it using the instructions given in the Feature Management section. Go to the documentation of your Carbon product for more details on how to use the logging feature.
Configuring products for logging
Given below are ways to configure log4j files:
- Manually editing the
log4j.propertiesfile. If you are using a WSO2 Carbon product, you can configure logging through the management console. These changes will be applied at run time. See your product's documentation for details.
In WSO2 products, using the management console is recommended, because all changes made to log4j through the management console persist in the WSO2 Registry. Therefore, those changes will be available after the server restarts. Changes that you make to the logging configuration via the management console will get priority over what is defined in the actual
log4j.propertiesfile. However, if you modify thelog4j.propertiesfile 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 thelog4j.propertiesfile.
Managing log growth
Log growth can be managed by the following configurations in the <PRODUCT_HOME>/repository/conf/log4j.properties file.
- 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.
The 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.
Viewing logs
There are several ways to view system and application logs of a running Carbon instance as described below.
- 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 thewso2carbon.logfile. - Through the command prompt/shell terminal that opens when you run the "
wso2server.bat"/"wso2server.sh" files to start the Carbon server. - If you are using a WSO2 product, logs can be viewed and monitored through the product's management console. See the product's documentation for details.