Message Tracing


In addition to other server activity, you can trace messages as they are processed. Trace entries for messages are only generated for destinations or messages that specify tracing should be performed. For destinations, you specify the trace property to enable the generation of trace messages. For individual messages, the JMS_TIBCO_MSG_TRACE property specifies that tracing should be performed for this message, regardless of the destination settings. The sections below describe the tracing properties for destinations and messages.

Message trace entries can be output to either the console or the log. The MSG trace option specifies that message trace entries should be displayed, and the DEFAULT trace option includes the MSG option. SeeTracing on the Server for more information about specifying trace options.

You must set the tracing property on either destinations or messages and also set the MSG or DEFAULT trace option on the console or the log before you can view trace entries for messages.

EMS tracing features do not filter unprintable characters from trace output. If your application uses unprintable characters within messages (whether in data or headers), the results of message tracing are unpredictable.

Enabling Message Tracing for a Destination

The trace property on a destination specifies that trace entries are generated for that destination. This property can optionally be specified as trace=body. Setting trace=body includes the message body in trace messages. Setting trace without the body option specifies that only the message sequence and message ID are included in the trace message.

When message tracing is enabled for a destination, a trace entry is output for each of the following events that occur in message processing:

Also, any reply messages are traced when the request message is sent to a destination that has the trace property. In the case of exported messages, when a message is sent to a destination that has a trace property, the reply message automatically generates a trace entry when JMSReplyTo is set to a temporary destination. If the reply to an exported message is sent to a static destination, to generate a trace entry, the reply destination must have the trace property set.

Enabling Message Tracing on a Message

You can enable tracing on individual messages by setting the JMS_TIBCO_MSG_TRACE property on the message. The value of the property can be null or body. Setting the property to null specifies only the message ID and message sequence will be included in the trace entries for the message. Setting the property to body specifies the message body will be included in the trace entries for the message.

When the JMS_TIBCO_MSG_TRACE property is set for a message, trace entries are generated for the message as it is processed, regardless of whether the trace property is set for any destinations the message passes through. Trace messages are generated for the message when it is sent by the producer and when it is received by the consumer.


TIBCO Enterprise Message Service™ User’s Guide
Software Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com