Logging and tracing for Process Federation Server

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Process Federation Server has a unified logging component that handles messages that are written by Process Federation Server and provides First Failure Data Capture (FFDC) services. Additionally, the logging component captures messages that are written to the System.out, System.err, java.util.logging, and OSGi logging files.

About this task

You can configure the trace information that is written to the log files through properties in the server.xml configuration file for Process Federation Server. The <logging> element contains the trace specifications for the Process Federation Server components:
<logging consoleLogLevel="INFO" traceFormat="ENHANCED" traceSpecification="*=info" />

Procedure

  1. Open the server.xml configuration file for editing.
    By default, the configuration file is in the pfs_install_root/usr/servers/server_name directory on Process Federation Server.
  2. Extend the traceSpecification property for each component that you want to trace, for example, traceSpecification="*=info:com.ibm.bpm.federated.*=all" ".
    The following table shows the available trace specifications for Process Federation Server components:
    Table 1. Trace specifications for Process Federation Server components
    Trace specification Description
    com.ibm.bpm.federated.*=all Traces all the Process Federation Server components.
    com.ibm.bpm.federated.query.rest.*=all Traces requests from the Process Federation Server REST APIs.
    com.ibm.bpm.federated.indexer.bpd.*=all
    com.ibm.bpm.federated.indexer.bpel.*=all
    		 Traces the indexing service on federated systems. You can enable tracing for process systems, BPEL systems, or both.
    com.ibm.bpm.federated.retriever.bpd.*=all
    com.ibm.bpm.federated.retriever.bpel.*=all
    com.ibm.bpm.federated.retriever.casemgr.*=all
    		 Traces the retrieval service on federated systems. You can enable tracing for process systems, BPEL systems, Case systems or a combination of those.
    com.ibm.bpm.elasticsearch.receiver.*=all Traces the Elasticsearch and OpenSearch indexing methods.
    com.ibm.wbimonitor.partitioning.*=all Traces the indexer partitioning service. The service coordinates the indexing services across cluster members.
    com.ibm.bpm.elasticsearch.client.*=all com.ibm.bpm.elasticsearch.universalclient.*=all Traces the remote Federated Data Repository client.
    com.ibm.bpm.query.rest.SAVED_SEARCH_PERFORMANCE_LOGGER=all Traces performance of saved searches