Brazos Portal - Changing the log level

Follow

Overview

The Brazos Portal utilizes Log4j as its logging framework. As of v1.12.0 Brazos Portal log levels can be dynamically adjusted using the Brazos Portal Admin screen. This article explains how to adjust the log levels dynamically and how to change the default logging.

Adjust Logging via Admin Screen

To adjust the log level dynamically in v1.12.0 or later, you will need to go to the Brazos Portal Admin screen (append /admin.html to your Brazos Portal URL) and click the Logging tab:

Brazos Portal Admin Logging Page Screenshot

To change the Brazos Portal log level, simply change to the desired value via the dropdown. When troubleshooting an issue with BP3 Support you will normally be asked to gather debug logs for the com.bp3.portal logger. The default setting is Info. Clicking the Advanced checkbox displays additional Brazos Portal related loggers that can also be adjusted, but this shouldn't be needed unless directed to do so by BP3 Support.

Changes made to logging via the Admin screen will only temporarily change the log level. When the Brazos Portal application is restarted, the log levels will return to the defaults set in the log4j.xml file. 

Changing the Default Logging

For versions of Brazos Portal prior to v1.12.0 or to change the default log levels, the log levels and appenders may be overridden by providing a log4j.xml file and referencing it through a JVM argument.

Sample log4j.xml files are attached that changes the com.bp3.portal logging log level to debug. It can be placed anywhere on the server's file system.

To enable the use of this configuration file:

IBM BPM

  1. Download the sample log4j.xml to the server file system (ex: file:/C:/IBM/log4j.xml or file:/opt/IBM/log4j.xml)
  2. Login to the WAS Admin Console
  3. Go to Servers -> Server Type -> WebSphere Application Server
  4. From the table, click the link for the server that you have the Brazos Portal installed on
  5. In the Server Infrastructure section, expand Java and Process Management and click the Process definition link
  6. In the Additional Properties section, click the Java Virtual Machine link
  7. In the box labelled Generic JVM Arguments, add
    -Dlog4j.configuration=file:<file location> (ex: file:/C:/IBM/log4j.xml or file:/opt/IBM/log4j.xml)
  8. Restart the server

Activiti on Tomcat

  1. Download the sample log4j.xml to the server file system (ex: file:/C:/tomcat/log4j.xml or file:/opt/tomcat/log4j.xml)
  2. Open <tomcat dir>\bin\setenv.bat file in the editor of your choice, creating it if it does not already exist.
  3. Add a line to the file
    set CATALINA_OPTS=-Dlog4j.configuration=file:<file location> (ex: file:/C:/tomcat/log4j.xml or file:/opt/tomcat/log4j.xml)
    If CATALINA_OPTS is already specified, append the content to the existing line.
  4. Restart Tomcat

Servers with existing Log4j configuration

If Log4j has been configured on the server already, then the existing configuration needs to be modified to include Brazos Portal. We recommend that you add all of the appenders and loggers defined in the attached log4j-1.15.xml file to your existing configuration file. Note that this sample log4j is specific to Brazos Portal 1.15, if you are running another version of Portal and need assistance please contact support. If Atmosphere is used by another one of your applications, you may need to remove the additivity="false" attribute on the org.atmosphere loggers that you copy from the sample log4j.xml.

Have more questions? Submit a request

Comments

Powered by Zendesk