fteSetAgentTraceLevel (set WebSphere MQ File Transfer Edition agent trace level V7.0.3 or later)

Use the fteSetAgentTraceLevel command to modify the current trace level for an agent dynamically. The command syntax described in this topic is valid for WebSphere® MQ File Transfer Edition V7.0.3 or later.

Purpose

Use this command to switch agent trace on and off or change the level of agent trace that is set. When you use the fteSetAgentTraceLevel command, you do not have to shut down and restart an agent to modify the trace level. The trace files produced are located in configuration_directory/coordination_qmgr_name/agents/agent_name/logs .

Because running trace can affect your performance significantly and can produce a large amount of trace data, run trace with care and only when necessary. Typically, enable trace only when asked to do so by your IBM® service representative.

You can set further trace properties, for example trace file size and the number of trace files to keep, in the agent.properties file. These properties are described in Advanced agent properties.

Specify the optional -p parameter for this command only if you want to use a set of configuration options different from your default set. See Properties files for WebSphere MQ File Transfer Edition for more information.

Syntax

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
fteSetAgentTraceLevel

>>-fteSetAgentTraceLevel-- -traceAgent--(classes=level)--------->

>--+---------------------------------------+-------------------->
   +- -disableOnAnyFFDC--------------------+   
   '- -disableOnFFDC--(FFDC_specification)-'   

>--+------------------------------+--agent_name----------------><
   '- -p--(configuration_options)-'               

Parameters

-traceAgent (classes=level)
Required. Level to set the agent trace and which classes to apply the trace to. Specify the following format:
classes=level
For example:
com.ibm.wmqfte=all

Specify a comma-separated list of class specifications that you want the level of trace to apply to. If you do not specify this parameter, the trace level is applied to all agent classes.

If (classes) start with a plus sign (+), the list of trace classes following the plus sign are added to any existing trace classes currently being traced.

The valid trace level options are as follows and are listed in ascending order of trace file size and detail:
off
Switches the agent trace off but continues to write information to the log files. This is the default option.
flow
Captures data for trace points associated with processing flow in the agent.
moderate
Captures a moderate amount of diagnostic information in the trace.
verbose
Captures a verbose amount of diagnostic information in the trace.
all
Sets agent trace to run on all agent classes.
-disableOnAnyFFDC
Optional. If this parameter is specified, trace is disabled on the agent when it generates a First Failure Data Capture (FFDC) file.

You can specify only one of the -disableOnAnyFFDC and -disableOnFFDC parameters.

-disableOnFFDC (FFDC_specification)
Optional. If this parameter is specified, trace is disabled on the agent when it generates a First Failure Data Capture (FFDC) file that matches the FFDC_specification. FFDC_specification is a comma-separated list of values. The format of the values can be either:
class_name
The name of the class where the FFDC originated. For example, com.ibm.wmqfte.classA.
class_name:probe_ID
The name of the class and the probe ID of the location in the class that the FFDC originated from. For example, com.ibm.wmqfte.classB:1.

You can specify only one of the -disableOnAnyFFDC and -disableOnFFDC parameters.

-p (configuration_options)
Optional. This parameter determines the set of configuration options that is used to set the agent trace level. Use the name of a non-default coordination queue manager as the input for this parameter. The command then uses the set of properties files associated with this non-default coordination queue manager.

If you do not specify this parameter, the set of configuration options based on the default coordination queue manager is used.

agent_name
Required. The name of the WebSphere MQ File Transfer Edition agent that you want to set the trace level for.

-? or -h
Optional. Displays command syntax.

Deprecated parameters

The -traceLevel and -traceClasses parameters are not used by V7.0.3 and later. For information about using these parameters with V7.0.2 and earlier, see fteSetAgentTraceLevel (set WebSphere MQ File Transfer Edition agent trace level V7.0.2 or earlier).

Example

In this example, the trace level is set to all for all classes for AGENT1:
fteSetAgentTraceLevel -traceAgent com.ibm.wmqfte=all AGENT1  

In this example, the trace level is set to all for the classes com.ibm.wmqfte.agent.Agent and com.ibm.wmqfte.cmdhandler for AGENT1:

fteSetAgentTraceLevel -traceAgent com.ibm.wmqfte.agent.Agent,com.ibm.wmqfte.cmdhandler=moderate
AGENT1 
In this example, subclasses are excluded from the trace because the -traceLevel parameter is set to off. All classes starting with com.ibm.outer are traced at verbose level except classes starting with com.ibm.outer.inner:
fteSetAgentTraceLevel -traceAgent com.ibm.outer=verbose AGENT1
fteSetAgentTraceLevel -traceAgent +com.ibm.outer.inner=off AGENT1

Return codes

0
Command completed successfully.
1
Command ended unsuccessfully.

Reference Reference

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/agent_trace_cmd.htm