Syntax:
com.ibi.agents.XDTraceAgent
iIT Service Object:
operations: Trace Message Writer
Description:
This service writes a message to the trace log of the system. The trace log accumulates messages to record the progress of activity within the server. Usually the trace log is used for debugging purposes.
Parameters:
|
Parameter |
Description |
|---|---|
|
Trace Level |
The trace level at which the message is written to the trace log. Select one of the following trace levels from the drop-down list:
|
|
Category |
A category to be applied for this message. If omitted, then the message will be logged in the standard logger category. If specified, then the name provided will appear as the log message category. |
|
Isolate Category Logger |
Applies only for error messages with a category name. A trace to a named category logger is never deferred. By default, an error trace is considered a general error causing a reset of the defer mode of the standard logger. If isolated, then a category logger is considered independent and the defer mode of the standard logger is not affected. If the standard logger is not in defer mode, then this parameter has no effect.
The default is join, such that the category logger is not isolated. |
|
Message |
The message to be written to the trace log. |
|
Call at EOS? |
In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. |
The following table lists and describes the edges that are returned by the Trace Message Writer Service.
|
Edge |
Description |
|---|---|
|
success |
The line was successfully sent to the trace system. |
|
fail_parse |
iFL used in the parameters was invalid. |
The trace message is written to the trace log at the error or debug level. The trace system must be configured to accept the message on the issued level. Users must be made aware that the use of a trace log can adversely affect server performance.
Caution: The trace log is not the transaction log, which can hold messages regarding operations within the server. Messages can be written to the transaction log using the Activity Log Entry service (XDXALogEvent) and the Activity Log Business Error Message service (XDXALogBizErr). While trace messages are usually free format and designed to help debug a problem, the XALog (transaction log) is more structured and often has externally imposed security, event code, and format constraints.