Jump to content
  • How to enable additional logging in TIBCO ActiveMatrix BusinessWorks™ 5


    Kurian Kuruvilla

    This article explains how to enable additional logging for debugging purposes in TIBCO ActiveMatrix BusinessWorks™ 5 (BW).

    General Logging

    Activity Tracing

    To enable additional logging for all the activities in all the process definitions in an application, set the property Trace.Task.* to true.

    Trace.Task.*=true

    It is possible to enable additional logging for specific process definitions or specific activities. A few examples are given below with reference to the following process definition.

    TC_DebugLogging.jpg.740c4f49272009d799f10dd517073ae3.jpg

    To enable additional logging for all the activities in this process definition only, set the property as follows - 

    Trace.Task.BusinessProcesses/MainProcesses/Events/ReceiveEvents.process.*=true

    To enable additional logging for the activity ‘Confirm’ only, set the property as follows -

    Trace.Task.BusinessProcesses/MainProcesses/Events/ReceiveEvents.process.Confirm=true

    Whitespace characters in names must be escaped. To enable additional logging for the activity ‘JDBC Query’, set the property as follows -

    Trace.Task.BusinessProcesses/MainProcesses/Events/ReceiveEvents.process.JDBC\ Query=true

    For an activity within a group, specify the group name followed by the activity name. To enable additional logging for the activity ‘JMS Queue Sender’, set the property as follows -

    Trace.Task.BusinessProcesses/MainProcesses/Events/ReceiveEvents.process.Group/JMS\ Queue\ Sender=true

    Activity Input/Output Logging

    When tracing is enabled for an activity, it is possible to get the activity input and output logged but setting the properties bw.engine.showInput and bw.engine.showOutput to true.

    bw.engine.showInput=true
    bw.engine.showOutput=true

    Process Starter Tracing

    To enable additional logging for all the process starters in all the process definitions, set the property Trace.JC.* to true

    Trace.JC.*=true

    To enable additional logging for the process starter in a specific process definition, specify the process definition.

    Trace.JC.BusinessProcesses/MainProcesses/Events/ReceiveEvents.process=true

    Startup Tracing

    To enable additional logging for the application startup, set the property Trace.Startup to true. When this property is set to true, the properties set for the application, the global variables used and the details of initialization of processes are written to the application log file. 

    Trace.Startup=true

    SSL/TLS Debug Logging

    SSL debug logs are helpful in troubleshooting SSL issues. For instructions on enabling SSL debug logging, see the following link -

    https://support.tibco.com/s/article/How-to-collect-SSL-debug-logs-in-TIBCO-ActiveMatrix-BusinessWorks

    Palette-specific logging

    In addition to BW activity tracing, additional logging can be enabled for third-party components. For example, in the case of Send HTTP Request activity, HttpClient debug logs provide information about connection establishment, message exchange etc. In the case of JDBC activities, JDBC driver debug logs provide information about database operations performed by the driver. 

    HTTP

    On the client side (SOAP Request Reply with HTTP transport or Send HTTP Request), HttpClient debug logging can be enabled  to get outbound requests and inbound responses logged. For instructions on enabling HttpClient debug logging, see the following link -

    https://support.tibco.com/s/article/How-to-capture-HTTP-request-and-response-messages-including-transport-headers

    On the server side, if server type is Tomcat, debug logging can be enabled to get inbound request headers and outbound response headers logged.

    Set the logger org.apache.catalina.filters.RequestDumperFilter to debug in BW_HOME/lib/log4j2.xml

    <logger name="org.apache.catalina.filters.RequestDumperFilter" level="debug"  additivity="false">
        <AppenderRef ref="tibco_bw_log"/>
    </logger>

    Add the following property to DESIGNER_HOME/properties.cfg or application .tra file.

    bw.plugin.http.server.debug=true

    JDBC

    Oracle 

    Oracle JDBC driver logging is based on java.util.logging. To enable additional logging, set the property oracle.jdbc.Trace to true and the property java.util.logging.config.file to the location of the logging properties file in designer.tra/application .tra file.

    java.extended.properties=-Doracle.jdbc.Trace=true -Djava.util.logging.config.file=/tmp/OracleJDBCLog.properties

    For information on the logging properties and Oracle JDBC driver logging in general, see the following link -

    https://docs.oracle.com/en/database/oracle/oracle-database/19/jjdbc/JDBC-diagnosability.html

    SQL Server 

    SQL Server JDBC driver logging is based on java.util.logging. To enable additional logging, set the property java.util.logging.config.file to the location of the logging properties file in designer.tra/application .tra file.

    java.extended.properties=-Djava.util.logging.config.file=/tmp/MSSQLJDBCLog.properties

    For information on the logging properties and SQL Server JDBC driver logging in general, see the following link -

    https://learn.microsoft.com/en-us/sql/connect/jdbc/tracing-driver-operation?view=sql-server-ver15

    IBM DB2

    To enable additional logging, set the property db2.jcc.propertiesFile to the location of the logging properties file in designer.tra/application .tra file.

    java.extended.properties=-Ddb2.jcc.propertiesFile=jcc.properties

    Sample properties -

    db2.jcc.traceDirectory=/tmp/jcctrace
    db2.jcc.traceFile=trace
    db2.jcc.traceFileAppend=false
    db2.jcc.traceLevel=-1

    For information on the logging properties and IBM DB2 JDBC driver logging in general, see the following link -

    https://www.ibm.com/support/pages/collecting-data-tracing-ibm-data-server-driver-jdbc-and-sqlj

    PostgreSQL

    PostgreSQL JDBC driver logging is based on java.util.logging. To enable additional logging, set the property java.util.logging.config.file to the location of the logging properties file in designer.tra/application .tra file.

    java.extended.properties=-Djava.util.logging.config.file=/tmp/postgresql-logging.properties

    For information on the logging properties and PostgreSQL JDBC driver logging in general, see the following link -

    https://jdbc.postgresql.org/documentation/logging/

    MariaDB

    To enable additional logging for MariaDB JDBC driver, set the logger org.mariadb.jdbc to trace in log4j.xml or log4j2.xml under BW_HOME/lib.

    <logger name="org.mariadb.jdbc" level="trace" additivity="false">
    <AppenderRef ref="tibco_bw_log"/> 
    </logger>

    For information on MariaDB JDBC driver logging, see the following link -

    https://mariadb.com/kb/en/about-mariadb-connector-j/#easy-to-use-logging

    TIBCO Database Driver Supplement Software (TDDS)

    TDDS drivers provide DataDirect Spy feature that can be used for enabling additional logging. The SpyAttributes connection property can be used to specify DataDirect Spy options. To direct logging to a file, specify the property as follows -

    jdbc:tibcosoftwareinc:oracle://host:port;SID=sid;SpyAttributes=(log=(file)filename)
    
    For example, jdbc:tibcosoftwareinc:oracle://dbserver:1521;SID=orcl19;SpyAttributes=(log=(file)/tmp/SpyLog.log)

    For information on the DataDirect Spy feature, see the following link -

    https://docs.progress.com/bundle/datadirect-jdbc-reference/page/Tracking-JDBC-calls-with-DataDirect-Spy.html

    JMS

    TIBCO EMS

    In the case of JMS activities connecting to TIBCO EMS, EMS client tracing can be enabled for additional information about JMS operations.

    Add the following property to designer.tra/application .tra file

    java.property.com.tibco.tibjms.trace.file=/tmp/client_trace.log

    Run the following command to enable client tracing

    set server client_trace=enabled

    IBM MQ

    In the case of JMS activities connecting to IBM MQ, see the following link for tracing options.

    https://www.ibm.com/docs/en/ibm-mq/9.2?topic=applications-tracing-mq-classes-jms

    Mail

    To enable additional logging for Mail palette activities, add the following property to designer.tra/application .tra file

    java.property.mail.debug=true

    Security Policy

    For instructions on enabling additional logging for security policy operations (encryption, signing etc.), see the following link -

    https://support.tibco.com/s/article/How-to-collect-additional-information-for-troubleshooting-WS-Security-issues


    User Feedback

    Recommended Comments

    There are no comments to display.



    Create an account or sign in to comment

    You need to be a member in order to leave a comment

    Create an account

    Sign up for a new account in our community. It's easy!

    Register a new account

    Sign in

    Already have an account? Sign in here.

    Sign In Now

×
×
  • Create New...