IBM Support

When using a JBoss application server, how do I collect logging as requested by the Operational Decision Manager support team?

How To


Summary

I am using JBoss EAP application server. Operational Decision Manager support team has provided me some trace strings to set in my environment, reproduce the problem I am seeing, collect and then share the logs with them for debugging. What steps should I take to perform these actions successfully?

Environment

Application Server: JBoss EAP v6.x, v7.x

Steps

Steps to add the component-specific trace strings for JBoss EAP v6.4 and higher
  1. Download the zip file attached to this document on the system that has JBoss EAP installed into a folder of your choice (downloadLoc)  and unzip it.
  2. Navigate to jboss_home\bin folder and open jboss-cli.xml in a text editor. Find resolve-parameter-values and set its value to true. Save the file.
  3. Open the downloaded file trace.properties in a text editor.
  4. Set the value of traceString property to a single trace string that the ODM support team has provided. For example, traceString=com.ibm.rules.res.execution Similarly set the value of the traceLevel property to the trace level of that trace string. For example, traceLevel=FINEST Save the file.
  5. On the command line navigate to jboss_home\bin and run jboss.cli.bat(.sh) -c --file=downloadLoc\setODMLogging.cli --properties=downloadLoc\trace.properties
  6. Repeat steps 4 and 5 for every additional trace string.

Steps to remove the component-specific trace strings for JBoss EAP v6.4 and higher
  1. Open the downloaded file trace.properties in a text editor.
  2. Set the value of traceString property to a single trace string that the ODM support team has provided. For example, traceString=com.ibm.rules.res.execution Similarly set the value of the traceLevel property to the trace level of that trace string. For example, traceLevel=FINEST Save the file.
  3. On the command line navigate to jboss_home\bin and run jboss.cli.bat(.sh) -c --file=downloadLoc\removeODMLogging.cli --properties=downloadLoc\trace.properties
  4. Repeat steps 2 and 3 for every additional trace string.

Steps to add the component-specific trace strings for JBoss EAP v6.3 and lower
  • On the command line navigate to jboss_home\bin and run jboss.cli.bat(.sh) -c
  • Paste the following lines one by one and hit enter. This will create a new file handler called odm & associate log files called odm.log to it.
    /subsystem=logging/periodic-rotating-file-handler=odm:add(append=true, autoflush=true, suffix=".yyyy-MM-dd", file={"relative-to"=>"jboss.server.log.dir", "path"=>"odm.log"})
    /subsystem=logging/logger=com.ibm.rules:add(handlers=["odm"], level=INFO)
    /subsystem=logging/logger=ilog.rules:add(handlers=["odm"], level=INFO) 

    Henceforth all Operational Decision Manager logs will be written to the odm.log file. If using a standalone server, odm.log, and odm.log.yyyy-MM-dd files will be present in jboss_home\standalone\log folder. Whereas, if using a domain server, odm.log, and odm.log.yyyy-MM-dd files will be present in jboss_home\domain\log folder.
  • In general, the syntax to set the trace string and trace level is -
    /subsystem=logging/logger=TRACE_STRING_ONE:add(handlers=["odm"], level=TRACE_LEVEL_FOR_TRACE_STRING_ONE)
  • To illustrate, let us assume that the Operational Decision Manager support team provides this trace string for additional component logging - 
    com.ibm.rules.res.execution=FINEST In such a case the command to run is
    /subsystem=logging/logger=com.ibm.rules.res.execution:add(handlers=["odm"], level=FINEST)
  • Repeat the earlier step for every additional trace string.
  • Reproduce the problem you are seeing, zip the jboss_home\standalone\log folder if using a standalone server (or jboss_home\domain\log folder if using domain server) and share it with the Operational Decision Manager support team.
  • Follow the steps in the next section to remove the settings made above.

Steps to remove the component-specific trace strings for JBoss EAP v6.3 and lower
  • On the command line navigate to jboss_home\bin and run jboss.cli.bat(.sh) -c.
  • /subsystem=logging/logger=com.ibm.rules:remove
  • /subsystem=logging/logger=ilog.rules:remove
  • In general, the syntax to remove the trace string is -
    /subsystem=logging/logger=TRACE_STRING_ONE:remove
  • As a continuation of the illustration in the earlier section, paste the following lines one by one and hit enter.
    /subsystem=logging/logger=com.ibm.rules.res.execution:remove
  • Repeat the earlier step for every additional trace string.
  • After all trace strings are removed, remove the file handler.
    /subsystem=logging/periodic-rotating-file-handler=odm:remove

Document Location

Worldwide

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSQP76","label":"IBM Operational Decision Manager"},"ARM Category":[{"code":"a8m50000000L1a2AAC","label":"** Other **"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Product Synonym

ODM;Operational Decision Manager

Document Information

Modified date:
17 April 2020

UID

ibm16189759