Salesforce

How to enable debug logging for PAS Web applications

« Go Back

Information

 
TitleHow to enable debug logging for PAS Web applications
URL NameHow-to-enable-debug-logging-for-Pacific-AppServer-for-OpenEdge-PASOE
Article Number000184264
EnvironmentProduct: OpenEdge
Version: 11.5, 11.6, 11.7
OS: All supported platforms
Question/Problem Description
How to enable debug logging for Web applications (REST, SOAP, APSV, or WEB transports) on Progress Application Server for OpenEdge (also known as Pacific Application Server for OpenEdge, PAS or PASOE)

How to enable debug logging for Pacific AppServer for OpenEdge (PASOE)

PASOE debugging log. 
Steps to Reproduce
Clarifying Information
Error Message
Defect Number
Enhancement Number
Cause
Resolution
This method has changed in OpenEdge 12, refer to Article  How to configure PAS debug logging in OpenEdge 12.0?  

For each Web application deployed on a Progress Application Server instance, there is a logging.xml file in the directory:
<CATALINA_BASE>/webapps/<Web app name or ROOT>/WEB-INF>
  • CATALINA_BASE is an environment variable containing the path to the PAS instance home directory.
  • Under <CATALINA_BASE>/webapps, the logging.xml file will be in ROOT/WEB-INF or <Web app name>/WEB-INF depending on whether the app is deployed as the ROOT app or as a named app.
The logging.xml file:
  • The logging.xml file contains a block of lines for each PAS transport service (REST, SOAP, APSV and WEB), as well as for certain other PAS components.
  • Each line in a block represents an Adapter component where logging can be enabled, except for the first line of each transport which enables debugging on all the components for that adapter.
  • All the lines are commented out by default; uncomment the lines to enable the required logging for that transport or component.
Logging Levels:

Logging levels are specified in upper-case and are, in order of verbosity :
  •         ERROR (least information)
  •         WARN
  •         INFO
  •         DEBUG
  •         TRACE (most information)

To enable debug logging for individual transports or components of transports:

1. Uncomment the logger name lines to enable the required logging for that transport or component and change the property value from INFO to DEBUG or higher.

    For example, change:

    <!-- REST adapter -->
    <!--     <logger name="com.progress.appserv.adapters.rest" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Adapter" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Binding" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Context" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Management" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Request" level="INFO"/> --> 
    <!--     <logger name="com.progress.appserv.adapters.rest.Timing" level="INFO"/> -->

    To:

    <!-- REST adapter -->
        <logger name="com.progress.appserv.adapters.rest" level="DEBUG"/>
    <!--     <logger name="com.progress.appserv.adapters.rest.Adapter" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Binding" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Context" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Management" level="INFO"/> -->
    <!--     <logger name="com.progress.appserv.adapters.rest.Request" level="INFO"/> --> 
    <!--     <logger name="com.progress.appserv.adapters.rest.Timing" level="INFO"/> -->



2. Stop PAS:

     <CATALINA_BASE>/bin/tcman stop 

3. Clean up the PAS logs:

    <CATALINA_BASE>/bin/tcman clean 

4.  Restart PAS:

     <CATALINA_BASE>/bin/tcman start 

In addition to the logging levels specified for individual transports, there is a "root" node at the bottom of logging.xml that specifies the default logging level for all Web apps. The default level is "WARN". To enable debug logging for all Web apps, change "WARN" to "DEBUG" or higher.

When different logging levels are specified at the root level, the transport level, and the component level, the highest specified level will be used.

For example:
  • If root is set to WARN and the individual transports are all commented out, 
    all WARN-level messages will be logged for all transports. (This is the default setting)
  • If root is set to WARN and com.progress.appserv.adapters.apsv is set to DEBUG, 
    the APSV transport will log messages at the DEBUG level and all other messages will be logged at the WARN level.
  • If root is set to DEBUG and com.progress.appserv.adapters.apsv is set to INFO, 
    all DEBUG-level messages will be logged for all transports

For more information on the different layers that logging can be configured (Tomcat, OpenEdge Multi-Session Agent, and WebApplication) refer to the following Article: Note: "Mapped Diagnostic Content(MDC)" provides additional configurable token fields that can be configured in the SessionManager log file entries. The MDC capability DOES NOT extend to the Agent log file https://docs.progress.com/bundle/openedge-new-info-1174/page/Enhanced-Mapped-Diagnostic-Content-logging-in-PAS-for-OpenEdge.html
Workaround
Notes
Keyword Phrase
Last Modified Date11/8/2021 2:46 PM

Powered by