| Destination |
Yes |
No |
User
Trace |
The destination of the trace record
that is written by the node. The Destination refers to the computer
that hosts the broker on which the Trace node is deployed: - To write the trace record to the local system error log, select Local Error Log.
The
information that you include in the trace record is written to one
of the following locations:
 On Windows systems,
data is written to the Event log (Application View)  On Linux and UNIX systems, data is written to
the syslog On z/OS® systems,
data is written to the operator console
On UNIX systems,
syslog entries are restricted in length and messages are truncated
by the newline character. To record a large amount of data in a log,
set the destination to File or User Trace instead.
If
you select Local Error Log,
indicate the number of the trace message that is to be written, and
the message catalog in which the message is defined.
- If you leave Message Catalog blank,
the default message catalog is used as the source of the message that
is to be written.
You must also enter the error number of the record
in Message Number. Numbers 3051 to 3099 are reserved in the default
catalog for this use. The text of each of these messages in the default
message catalog is identical, but if you use a different number in
this range for each situation that you trace, you can identify the
exact cause of the error. The default message number is 3051.
- If you create your own message catalog, enter the fully qualified
file name for your catalog in Message
Catalog.
You must also enter the appropriate number for
the message in the catalog that you want to write to the local error
log in Message Number. On
some systems, message numbers that end 00 are reserved
for system use; do not include messages with numbers such as 3100 in your message catalog.
|
|
|---|
| |
|
|
|
- To write the trace record to the system-generated user trace log,
select User Trace.
These
records are written regardless of the setting of the User Trace property
for the deployed message flow.
The file name is made up of the broker name,
the broker UUID, and a suffix of userTrace.bin
(for example, broker.e51906cb-dd00-0000-0080-b10e69a5d551.userTrace.bin.0).
Use the mqsireadlog and mqsiformatlog commands before
you view the user trace log.
|
|
|---|
| |
|
|
|
- To write the trace record to a file of your choice, select File.
If you select this
option, you must also set File Path to
the fully qualified path name for the trace. If you do not set the
path, the location of the file depends on the system; for example,
on z/OS, the file is created
in the home directory of the broker service ID.
You can use
any name for the trace file; for example, c:\user\trace\trace.log
If
you specify a file that does not exist already, the file is created.
However, directories are not created by this process, so the full
path must exist.
The file is written as text, in the
format specified by the Pattern property.
You do not need to run the mqsireadlog or mqsiformatlog commands against
the file.
If
a file write error occurs during processing (because of an out of
space condition, for example), a single warning message, BIP4065,
is written to the local system error log, and the message flow continues
to process messages without logging further errors. Check the error
log carefully for such a message.
- If you do not want to write trace records, select None. You can also
switch off Trace nodes.
|
|
|---|
| File Path |
No |
Yes |
|
The fully qualified file name of the file to
which to write records. This property is valid only if Destination is set to File. |
filePath |
|---|
| Pattern |
No |
No |
|
The data that is to be included in the trace
record. Create an ESQL pattern to specify what information to write.
If you write the trace record to the local error log, the pattern
governs the information that is written in the text of the message
number that is selected. If you use the default message catalog, and
a number between 3051 and 3099, the pattern information
is inserted as &1 in the message text. - You can write plain text, which is copied into the trace record
exactly as you have entered it.
- You can identify parts of the message to write to the trace record,
specifying the full field identifiers enclosed between the characters ${ and }.
To record the entire message, specify ${Root}.
Other common patterns are ${LocalEnvironment}
${Environment} and ${ExceptionList}.
For more information, see Viewing the logical message tree in trace output.
- Use the ESQL functions to provide additional information; for
example, use the ESQL function CURRENT_DATE to record the date, time,
or both, at which the trace record is written.
The pattern shown here includes some of the options that are
available. The pattern writes an initial line of text, records two
elements of the current message, and adds a simple timestamp: Message passed through with the following fields:
Store name is ${Body.storedetailselement.storename}
Total sales are ${Body.totalselement.totalsales}
Time is: ${EXTRACT(HOUR FROM CURRENT_TIMESTAMP)}
:${EXTRACT(MINUTE FROM CURRENT_TIMESTAMP)}
The
resulting trace record is: Message passed through with the following fields:
Store name is 'SRUCorporation'
Total sales are '34.98'
Time is: 11:19
A pattern that contains syntax errors
does not prevent a message flow that contains the Trace node from deploying,
but the node writes no trace records.
|
|
|---|
| Message Catalog |
No |
No |
|
The name of the message catalog from which the
error text for the error number of the exception is extracted. The
default value (blank) indicates that the message is taken from the
message catalog that is supplied with IBM Integration Bus. See Creating message catalogs for more information. |
|
|---|
| Message Number |
No |
No |
3051 |
The error number of the message that is written. |
|
|---|
Last updated Friday, 21 July 2017