Agent trace request message format

Tracing of an agent is initiated by the arrival of an XML message on the agent command queue, typically as a result of issuing an fteSetAgentTraceLevel command. The agent trace request XML must conform to the AgentTrace.xsd schema. After you have installed WebSphere® MQ File Transfer Edition, you can find the AgentTrace.xsd schema file in the following directory: install_directory/samples/schema.

Schema

The following schema describes which elements are valid in an agent trace request XML message.

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns="http://wmqfte.ibm.com/trace"
            targetNamespace="http://wmqfte.ibm.com/trace">

    <xsd:element name="trace"></xsd:element>

    <xsd:element name="agent" type="agentType"/>
    <xsd:element name="traceLevel" type="traceLevelType"/>
    <xsd:element name="traceClasses" type="traceClassType"/>
    <xsd:element name="stopOnFFDC" type="stopOnFFDCType"/>
    <xsd:simpleType name="traceLevelType">
        <xsd:restriction base="xsd:token">
            <xsd:enumeration value="all"/>
            <xsd:enumeration value="verbose"/>
            <xsd:enumeration value="flow"/>
            <xsd:enumeration value="moderate"/>
            <xsd:enumeration value="off"/>
        </xsd:restriction>
    </xsd:simpleType>

    <xsd:simpleType name="traceClassType">
        <xsd:restriction base="xsd:string"/>
    </xsd:simpleType>

    <xsd:complexType name="agentType">
        <xsd:attribute name="agent" type="xsd:string" use="required" />
        <xsd:attribute name="QMgr"  type="xsd:string" use="optional" />
    </xsd:complexType>

    <xsd:complexType name="stopOnFFDCType">
        <xsd:attribute name="class" type="xsd:string" use="optional" />
        <xsd:attribute name="probe" type="probeType"  use="optional" />
    </xsd:complexType>

    <xsd:simpleType name="probeType">
        <xsd:restriction base="xsd:string">
            <xsd:pattern value="(FFDC_\d{3})|\d+"/>
        </xsd:restriction>
    </xsd:simpleType>

 </xsd:schema>

Understanding the agent trace request message

The elements and attributes used in the agent trace request messages are described in the following list:
<trace>
Group element containing all the elements required to specify an agent trace request.
<agent>
The agent to enable trace on.
Attribute Description
agent Required. The name of the agent.
QMgr Optional. The queue manager that the agent connects to.
<traceLevel>
The level of trace to enable on the agent. The contents of this element must be one of the following values:
  • all
  • verbose
  • flow
  • moderate
  • off
<traceClasses>
The specific agent classes to trace.
<stopOnFFDC>
Optional. If this element is included in the trace request the agent stops tracing when an FFDC occurs.
Attribute Description
class Optional. The name of an agent class. If an FFDC occurs in this class, the agent stops tracing.

If this optional attribute is not included the agent will stop tracing when an FFDC occurs in any class.

probe Optional. The probe ID of the FFDC. If an FFDC occurs with this probe ID, the agent stops tracing.

The value of this attribute can be in the format FFDC_003 or 3.

Examples

Examples of XML messages that conform to this schema are provided for the following trace requests:

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_xsd.htm