NAME

tkadmin trace specification - enables or disables tracing for a component

SYNOPSIS

tkadmin trace specification -server servername specification

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. 

specification Specifies tracing for a component. The basic form of this argument is name={trace_options...}.  The name is any valid component name and {trace_options...} consists of one or more trace options that are assigned to the trace mask of the named component. If no trace options are specified, all standard tracing is enabled for the named component. Trace options can be combined by bitwise addition or subtraction as in trace_option+trace_option or trace_option-trace_option.  This argument cannot contain any whitespace. 

DESCRIPTION

The tkadmin trace specification command can be used to enable or disable tracing of various events for one or more components in a server. The syntax of the specification argument allows the use of assignment operators similar to those defined in the C language. The name={trace_options...} form sets or replaces the named component’s current trace mask with the trace options specified. Alternately, the form name+={trace_options...} adds the trace options specified to the current trace mask, and the form name-={trace_options...} subtracts the trace options specified from the current trace mask. The form name1=name2={trace_options...} assigns the same value to multiple names. Multiple assignments can be separated by a, (comma) as in name=trace_option,name=trace_option, and are processed left to right. 

Any valid component name can be specified as the name. The following aliases cause the trace masks for more than one component to be updated: all, client, exec, server, tpm, ts, sfs, rqs, ppc, and private. For example, exec causes all components, such as threadTid, trdce, and trpc, within the Encina Executive product to be updated. The tkadmin list trace command can be used to obtain a list of components in a server. 

Trace options are identified by string values or their associated hexadecimal values. Encina defines the following standard trace options for all components:

trace_event - (0x00000001) events in all functions

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

trace_param - (0x00000004) parameters of all exported functions

trace_export - (0x00000006) entry/exit and parameters of all exported functions

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

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

trace_global - (0x0000001F) entry/exit and parameters of all functions

trace_all, or all - (0xFFFFFFFF) includes all bits in the trace mask

Tracing can be disabled for the named component by specifying a value of 0 (zero) or none as a trace option. The default trace option causes the default tracing to be restored for the named component. The tkadmin query trace command can be used to look up component-specific trace options. 

NOTES

The trace options described above are not valid for use with the tkadmin trace component, tkadmin trace product, tkadmin untrace component, or tkadmin untrace product commands.  Refer to their respective manual reference pages for a list of valid options. 

EXAMPLES

The following example sets the trace mask of the trpc component to trace entry and exit of exported functions:

% tkadmin trace specification trpc=trace_entry

The following example adds parameter tracing to the current trace mask for the trpc component:

% tkadmin trace specification trpc+=trace_param

The following example sets the trace masks of all components in the Encina Executive to trace entry, exit and parameters of exported functions using the exec alias:

% tkadmin trace specification exec=trace_entry+trace_param

The following examples illustrate how multiple assignments can be chained or combined. Both examples set the trace masks of the trpc and tmxa components to trace entry and exit of exported functions:

% tkadmin trace specification trpc=tmxa=trace_entry

% tkadmin trace specification trpc=trace_entry,tmxa=trace_entry

The following example disables tracing for all components:

% tkadmin trace specification all=0

The following example disables event tracing only for the trpc component:

% tkadmin trace specification trpc-=trace_event

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 list trace

tkadmin query trace

tkadmin trace component

tkadmin trace product

tkadmin untrace component

tkadmin untrace product

  —  March 1997