Summary

The PegaRULES Log Analyzer (PLA) tool monitors and reports Alert log messages generated by Process Commander system nodes. This tool is designed to parse logs using version 6 alerts messages, which are included with V5.4 and higher.

You can upgrade V5.1 SP2 through V5.3 SP3 systems so that they are compatible with PLA. This article describes how you perform an upgrade.

Suggested Approach

To upgrade your system, do the following.

Install product patch

These Process Commander versions require the following product patches:

• V5.1 SP2 — HFIX-487
• V5.2 SP1 — HFIX-486
• V5.3 SP 1 — HFIX-467 and HFIX-835
• V5.3 SP2 — HFIX-712 and HFIX-835
• V5.3 SP3 — HFIX-835

To obtain the appropriate file, contact Global Customer Support.

Note: V5.1 SP3 does not require a product patch.

Update prlogging.xml

If you are using V5.1 SP2, V5.1 SP3, or V5.2 SP1, edit the prlogging.xml file to change the ConversionPattern parameter for ALERT and ALERT-SOAP appender elements as follows:

1. Open the prlogging.xml file.
   • If you deployed Process Commander as WAR or EAR files, open the file prlogging.xml in a text editor.  The prlogging.xml file is in the directory structure for deployed applications in your application server in contextroot/WEB-INF/classes for WAR deployments, or /APP-INF/bin for EAR deployments.
   • If you deployed Process Commander as a binary application, that is, not in an exploded directory structure, you must extract prlogging.xml from the application:
   1. Stop the Process Commander application.
   2.  Undeploy the Process Commander application.
   3.  If Process Commander is deployed as a web application, locate and unzip the prweb.war file to a location that you have access to.  Then extract the  prlogging.xml file from the WEB-INF\classes directory.
   4.  If Process Commander is deployed as an enterprise application, locate and unzip the prresources.jar (it is in the APP-INF\lib directory.)  Then extract the prlogging.xml file from the .jar.
2. Locate the element for appender name = “ALERT”:<appender name="ALERT"

   class="com.pega.pegarules.priv.util.FileAppenderPega">
               <param name="FileNamePattern" value="'PegaRULES-ALERT-'yyyy-MMM-dd'.log'"/>
               <layout class="com.pega.apache.log4j.PatternLayout">
                     <param name="ConversionPattern" value="%d{GMT}*3*%Y{instance_id}*%X{an}*%X{InteractionNumber}*%t*%c{3}*%X{RequestorId}*%X{userid}*%X{stack}*%X{scope}*%m%n"/>
               </layout>
         </appender>

3. Change the ConversionPattern param element as follows:
   • Replace this element:

   <param name="ConversionPattern" value="%d{GMT}*3*%Y{instance_id}*%X{an}*%X{InteractionNumber}*%t*%c{3}*%X{RequestorId}*%X{userid}*%X{stack}*%X{scope}*%m%n"/>

   • With the following:

   <param name="ConversionPattern" value="%m%n"/>

   • The modified element should look like the following:

   <appender name="ALERT" class="com.pega.pegarules.priv.util.FileAppenderPega">
               <param name="FileNamePattern" value="'PegaRULES-ALERT-'yyyy-MMM-dd'.log'"/>
               <layout class="com.pega.apache.log4j.PatternLayout">
                     <param name="ConversionPattern" value="%m%n"/>
               </layout>
         </appender>

   • Repeat this modification in the appender element for ALERT-SOAP.  The modified element should look like the following:

   <appender name="ALERT-SOAP" class="com.pega.pegarules.priv.util.SOAPAppenderPega">
               <param name="EndPointURL" value="http://sdevrulesb:8888/prweb/PRSOAPServlet" />
               <param name="Mode" value="ALERT" />
               <layout class="com.pega.apache.log4j.PatternLayout">
                     <param name="ConversionPattern" value="%m%n"/>
               </layout>
         </appender>

4. Add the following element:

    < category name="com.pega.pegarules.engine.context.Agent">
         <priority value="info"/>
    </category>

5. Optional : In versions 5.1 through 5.3, each exception in the Pega log is given a time stamp only. You can display the full date and time at the beginning of each row in the log and in the PLA Exceptions list report by replacing %d{ABSOLUTE} with %din the Pega system file appender shown here:

     <appender name="PEGA" class="com.pega.pegarules.priv.util.FileAppenderPega">
            <param name="FileNamePattern" value="'PegaRULES-'yyyy-MMM-dd'.log'"/>          <layout class="com.pega.apache.log4j.PatternLayout">
                  <!-- param name="ConversionPattern" value="%d{ABSOLUTE} [ .20t]
   [%10.10X{pegathread}] [ .20X{app}] (%30.30c{3}) %-5p %X{stack} %X{userid} -    %m%n"/>->
                  <param name="ConversionPattern" value="%d [ .20t]
   [%10.10X{pegathread}] [ .20X{app}] (%30.30c{3}) %-5p %X{stack} %X{userid} -    %m%n"/>
             </layout>  
       </appender>

6. Save the file.
7. If you extracted prlogging.xml from the application as described above, repackage the modified prlogging.xml file into the prweb.war or prresources.jar, as appropriate, and redeploy the Process Commander application.
8. Restart the Process Commander application.

For more information

• Performance alerts, security alerts, and AES
• Understanding alert message settings in the prconfig.xml file
• Understanding Alert log message data
• How to install and use the PegaRULES Log Analyzer
• Understanding the PegaRULES Log Analyzer