fteSetAgentTraceLevel (set WebSphere MQ File Transfer Edition agent trace level V7.0.2 or earlier)
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.2 or earlier.
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
fteSetAgentTraceLevel >>-fteSetAgentTraceLevel-- -traceLevel--(trace_level)-----------> >--+---------------------------------+--------------------------> '- -traceClasses--(trace_classes)-' >--+--------------------------------+---------------------------> '- -agentQMgr--(agent_qmgr_name)-' >--+------------------------------+--agent_name---------------->< '- -p--(configuration_options)-'
Parameters
- -traceLevel (trace_level)
- Required. Level to set the agent trace to. The valid trace 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.
- -traceClasses (trace_classes)
- Optional. The classes to apply the agent trace to. Specify a comma-separated
list of class specifications. If you do not specify this parameter,
the trace level is applied to all agent classes.
If (trace_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.
- -agentQMgr (agent_qmgr_name)
- Optional. The name of the agent queue manager. If you do not specify this parameter, the value is determined from the set of configuration options in use.
- -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.
Example
In this example, the trace level is set to all for all classes for AGENT1:fteSetAgentTraceLevel -traceLevel 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 -traceLevel moderate
-traceClasses com.ibm.wmqfte.agent.Agent,com.ibm.wmqfte.cmdhandler AGENT1
fteSetAgentTraceLevel -traceClasses com.ibm.outer -traceLevel verbose AGENT1
fteSetAgentTraceLevel -traceClasses +com.ibm.outer.inner -traceLevel off AGENT1
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.