NAME

tkadmin trace component - turns on tracing of a Toolkit server component

SYNOPSIS

tkadmin trace component -server servername componentname {options...}

ARGUMENTS

-server servername Specifies the server affected by the command. The server name is the name that is registered with the DCE Directory Service. If the server name is not specified in the command line, it is retrieved from an environment variable, ENCINA_TK_SERVER. 

componentname Specifies the component for which tracing should be enabled, for example, tran, rec, lock.  A list of all components in the server can be obtained using the tkadmin list components command. 

{options...} Lists one or more options that designate the type of tracing to turn on in addition to the current tracing. The valid options are event, param, internal_param, entry, internal_entry. Another valid option is any 32-bit hex value, for example: 0x000000FF. If no options are specified, all standard tracing is turned on. 

DESCRIPTION

The tkadmin trace component command adds the specified options to the trace mask of the component. A component, in Encina software, is a module within a software product.  For instance, one Encina product is the Encina Executive. The Encina Executive includes three components: the Distributed Transaction Service, the Thread-to-Tid Mapping Service, and the Transactional RPC Service. Each component has a trace mask, a 32-bit unsigned integer, associated with it. The component’s trace mask determines what, within the component, gets traced. 

Bits in the trace mask enable various types of tracing in components. The first eight bits (0 through 7) represent the standard trace bits that apply to all components. The remaining 24 bits in a component’s trace mask represent events specific to the component.  Contact your product support representative for information regarding component-specific event bits. 

Encina defines the following standard options for the tkadmin trace component command:

event - (0x00000001) events in all functions

entry - (0x00000002) entry/exit of all exported functions

param - (0x00000004) parameters of all exported functions

internal_entry - (0x00000008) entry/exit of non-exported functions

internal_param - (0x00000010) parameters of non-exported functions

NOTES

The tkadmin trace component command is obsolete and will be discontinued in future versions of Encina. The tkadmin trace specification command should be used instead of the tkadmin trace component command. 

EXAMPLES

The following command sets the trace mask of the server’s rec (Recovery Service) component to 0x00100003. This results in turning on entry and param tracing in the Recovery Service.  Additionally, tracing of media recovery debug events in the Recovery Service (governed by the trace mask 0x00100000) is enabled. 

% tkadmin trace component rec entry param 0x00100000

PRIVILEGE REQUIRED

Encina Monitor administer (a) permission to the server

Encina RQS administer (a) permission to the RQS server

Encina SFS administer (A) permission to the SFS server

RELATED INFORMATION

tkadmin trace product

tkadmin trace specification

tkadmin untrace component

tkadmin untrace product

  —  March 1997