Content Platform Engine, Version 5.2            

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
Parameters Description
Application space Trace application space changes such as configuration changes or API calls from client applications.
Asynchronous tools Trace the tools that use asynchronous communication to the workflow system such as PELog.
Case Analyzer publishing Trace the Case Analyzer event publishing process.
Case Analyzer collection Trace the event collection process which queries the event logs.
Case Analyzer database Trace the database query statements that are run by Case Analyzer.
Case Analyzer RPC Trace the remote procedure calls from the Administration Console for Content Platform Engine.
Case Analyzer upgrade Trace the Case Analyzer upgrade operation.
Case Analyzer OLAP Trace the interaction with the OLAP database that is conducted through the OLAP connector.
Database access Trace 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.

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

This prompt appears only if you answer no to the database access prompt.

Database transaction Trace an entire database transaction from beginning to end.
Environment cache Trace workflow system interactions with its environment record cache where it keeps track of workflow system user and group membership information.
Event exporter Trace the core framework for Case Analyzer, which drives the Case Analyzer publishing and collection processes.
External RPCs Trace external remote procedure calls (RPCs).

The extRPC and intRPC options reflect the number of RPCs going across the network.

Farming Trace activities that are related to a farmed system.
Internal RPCs Trace internal remote procedure calls (RPCs).

The extRPC and intRPC options reflect the number of RPCs going across the network.

Instruction Sheet Interpreter Trace Instruction Sheet Interpreter (ISI) process.
Log Manager Trace log manager process.
Network Connections Trace network connections.
Email Notification Trace email notifications.
Object Service RPCs Trace Object Service usage.
API RPC Trace communication RPCs between the API client and workflow server.
API RPC input Trace API input parameters to workflow system RPCs.
API RPC output Trace API output parameters to workflow system RPCs.
Rules Trace workflow system interactions with the Rules Engine and rules processing.
Security calls Trace security calls.
Stored Procedure Calls Trace the execution of database instruction stored procedure calls.
Workflow Termination Trace calls made to the workflow termination process (vwdone).
Transfer Trace all transfer processes.
Web Services Trace workflow system interactions with applications using the Web Services protocol.


Feedback

Last updated: October 2013
bpfvl049.htm

© Copyright IBM Corporation 2014.
This information center is powered by Eclipse technology. (http://www.eclipse.org)