Monitoring Ensemble
Enabling Tracing
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

This chapter describes how to enable tracing, view trace messages, and log trace messages. It contains the following sections:

About Tracing
Tracing is a tool for use primarily during development. Trace elements enable you to see the behavior of various elements in a production, for the purpose of debugging or diagnosis. You typically disable tracing before a production goes live.
The Ensemble trace mechanism works as follows:
You typically disable tracing before a production goes live.
Enabling Tracing
By default, all user trace elements are enabled. You can also enable tracing of various system events.
To do so, set values for some or all of the following nodes of the ^Ens.Debug global:
Node Purpose
^Ens.Debug("TraceCat") Controls tracing overall as follows:
  • If this node is not set, only user trace elements are enabled. In this case, you can enable specific kinds of system tracing by setting subnodes, as described in the rest of this table.
  • If the value of this node is 0, no tracing is enabled.
  • If the value of this node is 1, all tracing is enabled, apart from any explicitly disabled kinds of tracing.
^Ens.Debug("TraceCat","bproc") Enables or disables system traces from business processes.
For this node and all the rest of the nodes in this table, if the node value is 1, the specified traces are enabled. If the node value is 0, these traces are disabled. This node is ignored if the parent node value is 0.
^Ens.Debug("TraceCat","connwait") Enables or disables system traces from adapters waiting to connect.
^Ens.Debug("TraceCat","exterr") Enables or disables system traces showing errors from external systems.
^Ens.Debug("TraceCat","file") Enables or disables system traces from file read or write operations.
^Ens.Debug("TraceCat","ontask") Enables or disables system traces from business host framework events.
^Ens.Debug("TraceCat","parse") Enables or disables system traces from HL7 and other virtual document parsers.
^Ens.Debug("TraceCat","protocol") Enables or disables system traces of sequence numbers from the MSH segment in HL7 messages.
^Ens.Debug("TraceCat","queue") Enables or disables system traces related to message queue management.
^Ens.Debug("TraceCat","system") Enables or disables general system trace elements.
^Ens.Debug("TraceCat","timing") Enables or disables system traces providing information about duration of calls.
^Ens.Debug("TraceCat","transform") Enables or disables system traces about DTL data transformations, apart from errors.
^Ens.Debug("TraceCat","user") Enables or disables user traces.
^Ens.Debug("TraceCat","xform") Enables or disables system traces about errors in DTL data transformations.
For example, to enable tracing related to message queue management, enter the following command in the Terminal, in the appropriate namespace:
set ^Ens.Debug("TraceCat","queue")=1
Also see Enabling %ETN Logging in the chapter “Testing and Debugging” in Developing Ensemble Productions.
Enabling Logging for Trace Messages
Ensemble can also log trace messages (that is, write them to the Event Log). To enable or disable logging of trace messages, use the following settings:
There is no overlap or interaction between these settings; Log General Trace Events does not override or provide a default value for Log Trace Events.
See Settings in All Productions in Configuring Ensemble Productions.
Seeing Trace Messages in the Terminal
To see the trace messages in the Terminal, do the following:
  1. If you are using Windows Vista or Windows 7, enable the Interactive Services Detection Service, as follows:
    1. On the Windows Start menu, go to Administrative Tools > Services.
    2. Right click and select Start.
  2. Enable the Foreground setting for the business host or business hosts in which you are interested.
    When you run the production, Ensemble opens a Terminal window for each foreground business host. This Terminal window shows all enabled trace messages for that business host. It also shows all log items and alerts.
  3. On Windows Vista or Windows 7, the Interactive Services Detection Service displays a dialog box to indicate that a program is attempting to display a message. Click View the Message. The Interactive Services Detection Service then displays a window that contains one or more Terminal windows.