Trace Properties
Trace properties control which trace messages are sent and where they are sent to. Tracing is controlled either by roles, by activities, or by process definitions. For roles, you can configure system role tracing (Error, Warn, Info, Debug), or you can configure tracing for user-defined roles. The Write to Log activity allows you to specify a user-defined role for the message to write.
Specifying Location of Trace Messages
The following properties control where trace messages are sent. Messages can be sent to the log file, to the console, or published as TIBCO Rendezvous messages.
Trace.Role.<userRoleName>.Term or Trace.<systemRoleName>.Term
Trace.Role.<
userRoleName
>.Term
controls whether or not messages for the specified user-defined role are sent to the console; use Trace.Role.*.Term
to control console output for all user-defined roles.
Trace.<
systemRoleName
>.Term
controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are sent to the console.
Trace.Role.<userRoleName>.Log or Trace.<systemRoleName>.Log
Trace.Role.<
userRoleName
>.Log
controls whether or not messages for the specified user-defined role are sent to the log file; use Trace.Role.*.Log
to control log output for all user-defined roles.
Trace.<
systemRoleName
>.Log
controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are sent to the log file.
Trace.Role.<systemRoleName>.Publish
Trace.Role.<systemRoleName>.Publish controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are published as a TIBCO Rendezvous message. By default, the messages are sent on TIBCO ActiveMatrix BusinessWorks default transport. You can specify a different transport for published trace messages with the following properties:
• | Trace.< systemRoleName >.Publish.Subject |
• | Trace.< systemRoleName >.Publish.Service |
• | Trace.< systemRoleName >.Publish.Network |
• | Trace.< systemRoleName >.Publish.Daemon |
See the TIBCO Rendezvous
documentation for the correct syntax for specifying transport parameters.
Specifying Rolling Log Files for UserRole
You can specify that entries for the role named UserRole are sent to a set of rolling log files. To accomplish this, you specify the location of the log files, log file name, the number of log files, and the maximum size of each log file. Entries will be written to the first log file until it reaches its maximum size, and then entries are then directed to the second log file until it reaches its maximum size, and so on. Once the maximum number of log files is reached, entries are then directed back to the first log file again. The following engine properties allow you to configure rolling log files:
• | Trace.Role.UserRole.Log.Dir — Location for the set of rolling log files. |
• | Trace.Role.UserRole.Log.File — Filename for the log files. A number is appended to each new log file created up to the specified maximum number of log files. |
• | Trace.Role.UserRole.Log.MaxSize — Maximum size of a log file before entries are directed to the next log file in the sequence. |
• | Trace.Role.UserRole.Log.Maximum — Maximum number of log files to create. Entries are directed back to the first log file when the maximum number of log files have been created. |
Tracing by Role
The following properties enable or disable all tracing for user-defined and system roles.
Trace.Role.<userRoleName> or Trace.<systemRoleName>.*
Enables or disables the specified role. Trace.Role.<
userRoleName
>
enables or disables the specified user-defined role; specify Trace.Role.* to enable or disable all user-defined roles. Trace.<
systemRoleName
>.*
enables or disables the specified system role (Error, Warn, Info, or Debug).
Tracing by Resource
The following properties enable or disable tracing for activities and process starters.
Trace.Task.*
Controls whether or not trace messages for all activities are output.
Trace.Task.<processDefinition>.<activityName>
Controls whether or not trace messages for a given activity in a process definition are output. Specifying a wildcard for the process definition name indicates you would like to control trace messages for all activities with a given name. Specifying a wildcard for the activity name indicates you would like to control trace messages for all activities in the specified process definition.
Trace.JC.<processStarterName>
Controls whether or not trace messages for a given process starter are output. Specify Trace.JC.*
to control trace messages for all process starters.
Including Activity Input/Output in Trace Messages
When resource tracing is enabled, you can optionally include the resource input or output XML in the trace messages. The following properties determine whether input or output are included.
bw.engine.showInput
When set to true
, resources that have input will include the input XML in the trace messages for that resource.
bw.engine.showOutput
When set to true
, resources that have output will include the output XML in the trace messages for that resource.