Content Platform Engine, Version 5.2.1            

trace

The trace command displays and sets tracing options for all servers in a farm or specified servers. You can trace various server activity, such as remote procedure calls or log manager processes. You can route this trace information to a trace file.

You can set tracing options interactively or through a trace file that is accessed at server startup. To start tracing at system startup, set tracing options in the TraceOptions file. To create the TraceOptions file, do the following steps:
  1. Make a copy of the TraceOptions.sample file.

    The TraceOptions.sample file can be found in ..\tools\PE\samples relative to the Content Platform Engine installation directory.

  2. Save the copy of the TraceOptions.sample file without the file extension .sample to the folder specified by the application server user.dir system property. For example, 
    C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\traceOptions
  3. Uncomment the trace options in the TraceOptions file that you want applied and save the file.

    The TraceOptions file is accessed when the server is restarted or reloaded through vwtool trace.

When the trace command is run on a single server, the current trace settings are listed and the trace options that were selected for the server are marked with a double asterisk (**).

The destination of the trace information is the pesvr_trace.log file. To find the location of this log file, access the Content Platform Engine Startup Context (Ping Page):
http://server:port/FileNet/Engine

Where:

server is the host name of the server where Content Platform Engine is deployed. In a load-balanced environment, server is the name of one of the servers in the farm, not the virtual address of a load balancer.

port is the HTTP port that is used by the application server where Content Platform Engine is deployed.

The following table lists examples of addresses with default port numbers for supported application servers:

Table 1. Examples of Content Platform Engine Startup Context (Ping Page) addresses
Application server type Web page address
IBM® WebSphere® Application Server http://myserver:9080/FileNet/Engine
Oracle WebLogic Server http://myserver:7001/FileNet/Engine
JBoss Application Server http://myserver:8080/FileNet/Engine
For example, 
 c:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1\pesvr_trace.log
Important: In a server farm environment, each server in the farm can have different options that are set in memory. Because the vwtool request is sent to a random server in the farm, the settings for only that server is displayed.

Syntax

In interactive mode, you are required to set all of the trace options.

trace [server] [change_tracing_options] [from_traceOptions_file] [trace_destination] [trace_options]

Parameters

Table 2. Parameters and description for the trace command
Parameter Description
server Enter s for the trace to be performed on a single server. You are prompted for the name of the server.

Enter a for the trace to be performed on all of the servers.
change_tracing_options Enter yes to change any of the displayed settings, or no to leave them as they are currently set.
from_traceOptions_file Enter yes if you want the selected trace options from the traceOptions file. Enter no to leave them as they are currently set.
trace_destination Defines the file and location where you want the trace information to be stored.

Enter yes or no for the trace destination.

To turn tracing off, enter the trace command with no parameters, and enter no at the trace_destination prompts.

Remember: Disabling the trace destination effectively turns off tracing. However, there is some performance cost from leaving trace options enabled.
trace_options The trace activity that you can enable or disable.

Enter yes or no for each trace option parameter. The options appear in the order indicated in the trace options parameters table.

Trace_options parameters

Table 3. Table of trace_option parameters and description
Vwtool parameter traceOptions file flag Description
Application space TRACE_APP_SPACE Trace application space changes such as configuration changes or API calls from client applications.
Start of changeArchiverEnd of change Start of changeTRACE_ARCHIVEREnd of change Start of changeTrace archiving.End of change
Start of changeAsynchronous RPCEnd of change Start of changeTRACE_ASYNC_RPCEnd of change Start of changeTrace asynchronous RPCs. Used for long-running RPCs, such as configuration transfer, peverify, and pelog.End of change
Asynchronous tools TRACE_ASYNC_TOOLS Trace the tools that use asynchronous communication to the workflow system such as pelog.
Start of changeCase SynchronizationEnd of change Start of changeTRACE_CASE_SYNCEnd of change Start of changeTrace synchronization of case data. Used with IBM Case Manager. End of change
Case Analyzer publishing TRACE_CA_PUBLISHING Trace the Case Analyzer event publishing process.
Case Analyzer collection TRACE_CA_COLLECTION Trace the event collection process that queries the event logs.
Case Analyzer database TRACE_CA_DATABASE Trace the database query statements that are run by Case Analyzer.
Case Analyzer RPC TRACE_CA_RPC Trace the remote procedure calls from the Administration Console for Content Platform Engine.
Case Analyzer upgrade TRACE_CA_UPGRADE Trace the Case Analyzer upgrade operation.
Case Analyzer OLAP TRACE_CA_OLAP Trace the interaction with the OLAP database that is conducted through the OLAP connector.
Start of changeCase History PublishingEnd of change Start of changeTRACE_CH_PUBLISHINGEnd of change Start of changeTrace the Case History event publishing process.End of change
Start of changeCase History CollectEnd of change Start of changeTRACE_CH_COLLECTIONEnd of change Start of changeTrace the event collection process that queries the event logs for Case History.End of change
Start of changeCase History DatabaseEnd of change Start of changeTRACE_CH_DATABASEEnd of change Start of changeTrace the database query statements that are run by Case History.End of change
Start of changeCase History RPCEnd of change Start of changeTRACE_CH_RPCEnd of change Start of changeTrace the remote procedure calls from the Case History client.End of change
Start of changeCase History PerformanceEnd of change Start of changeTRACE_CH_PERFORMANCEEnd of change Start of changeTrace the Case History event processing performance.End of change
Start of changeCase History UpgradeEnd of change Start of changeTRACE_CH_UPGRADEEnd of change Start of changeTrace the Case History upgrade.End of change
Start of changeComponent ManagerEnd of change Start of changeTRACE_CMEnd of change Start of changeTrace Component Manager.

Returns detailed logging information about Component Manager.

End of change
Start of changeRDB ObjectsEnd of change Start of changeTRACE_RDBEnd of change Start of changeTrace RDB database access, which is related to isolated region tablespaces. End of change
Start of changeDatabase accessEnd of change Start of changeTRACE_DBI_MSGSEnd of change Start of changeTrace database access.

This option outputs the SQL statements that are used by workflow system, along with the values of the substitution variables. Setting this option automatically sets the database time option.

End of change
Database outputs TRACE_DBI_OUT Trace the field values and outputs of database statements, such as SELECT, UPDATE, and so on.
Database time TRACE_RDB_TIME Trace database timings.

This prompt appears only if you answer no to the database access prompt.
Database transaction TRACE_DBI_TRAN Trace an entire database transaction from beginning to end.
Environment cache TRACE_ENV Trace workflow system interactions with its environment record cache where it keeps track of workflow system user and group membership information.
Event exporter TRACE_EVENT_EXPORTER Trace the core framework for Case Analyzer and Case History, which drives the publishing and collection processes.
Start of changeExceptionsEnd of change Start of changeTRACE_EXCEPTIONEnd of change Start of changeTrace exceptions occurring within the server.End of change
Start of changeExpression ParsingEnd of change Start of changeTRACE_EXPREnd of change Start of changeTrace expression parsing.End of change
External RPCs TRACE_EXTERNAL Trace external remote procedure calls (RPCs). Traces calls within the Content Platform Engine server.
Farming TRACE_FARMING Trace activities that are related to a farmed system.
Start of changeHeartbeatEnd of change Start of changeTRACE_VWSVRTIMEEnd of change Start of changeTrace the heartbeat task activities.End of change
Instruction Sheet Interpreter TRACE_ISI Trace Instruction Sheet Interpreter (ISI) process.
Start of changeJ2EEEnd of change Start of changeTRACE_J2EEEnd of change Start of changeTrace calls that are related to Java Platform, Enterprise Edition.End of change
Log Manager TRACE_LOG Trace log manager process.
Email Notification TRACE_NOTIFY Trace email notifications.
Object Service RPCs TRACE_OBJSVC Trace Object Service usage.
API RPC TRACE_RPC Trace communication RPCs between the API client and workflow server.
API RPC input TRACE_RPC_IN_PARAMS Trace API input parameters to workflow system RPCs.
API RPC output TRACE_RPC_OUT_PARAMS Trace API output parameters to workflow system RPCs.
Rules TRACE_RULES Trace workflow system interactions with the Rules Engine and rules processing.
Security calls TRACE_SEC Trace security calls.
Stored Procedure Calls TRACE_STORED_PROC Trace the execution of database instruction stored procedure calls.
Workflow Termination TRACE_WFTERM Trace calls made to the workflow termination process (vwdone).
Transfer TRACE_TRANSFER Trace transfer processes.
Start of changeVwtimeEnd of change Start of changeTRACE_VWTIMEEnd of change Start of changeTrace the processing of the timer task.End of change
Web Services TRACE_WEBSERVICES Trace workflow system interactions with applications that use the Web Services protocol.
Start of changeXML ParserEnd of change Start of changeTRACE_XMLPARSEREnd of change Start of changeTrace parsing of XML.End of change
Start of changeDynamic TaskEnd of change Start of changeTRACE_DYN_TASKEnd of change Start of changeTrace dynamic tasks. (Dynamic tasks are synonymous with IBM Case Manager ad hoc tasks.)End of change

Last updated: October 2015
bpfvl049.htm

© Copyright IBM Corporation 2015.