Trace parameters

Cell tracing parameters

Parameter

Description

Type

Trace 1

Enables the generation of trace messages.

Boolean

TraceSrc

Includes the file and line number in the trace messages.

Boolean

TraceConfigFileName

Location of the file containing the configuration of the trace messages

Path

TraceDefaultFileName

Destination file to redirect trace messages from stderr to, in case the cell runs as a daemon or service.

Note

If you direct trace files to the temporary directory of the cell (for example, TraceDefaultFileName=%T/trace - %T=cell_tmp), the trace file is removed each time the cell starts because the cell always cleans up its tmp directory at startup.
To keep trace files across cell sessions, do not use the tmp directory as the default destination file location.

Path

TraceRuleLevel

Sets the level of rule execution tracing:

  • 0—no rule tracing and no cell error catch (not recommended)
  • 1—no rule tracing; cell errors are caught in the standard cell trace (default)
  • 2—rule tracing enabled

Number

TraceRulePhases

When rule tracing is enabled, lists the rule phases to be traced. The value ALL can be used to specify that all phases are to be traced. Each phase can be prefixed with a + or a - sign to indicate addition or removal from the list. The list is interpreted in sequential order.
For example, the following parameter setting:TraceRulePhases=ALL,-refine,-regulate
indicates that all rule phases are traced except for the refine and regulate phases.

Note

TraceRulePhases and TraceRuleName work together to determine which rules are traced. A rule is only traced if both the phase to which it belongs and the rule itself are configured for tracing.

String

TraceRuleNames

When rule tracing is enabled, lists module:rule combinations to be traced. The value ALL can be used to specify that all modules and/or rules are to be traced. Each module:rule combination can be prefixed with a + or a - sign to indicate addition or removal from the list. The list is interpreted in sequential order.
For example, the following parameter setting:TraceRuleNames=HelpDesk:ALL,-HelpDesk:rule1,SendMail:rule1
indicates that all rules in the HelpDesk module is traced except for rule1. Also, rule1 from the SendMail module is traced.

Note

TraceRulePhases and TraceRuleNames work together to determine which rules are traced. A rule is only traced if both the phase to which it belongs and the rule itself are configured for tracing.

String

TraceRuleHeader

Enables you to configure the header text of the trace messages. You can configure the header text to contain references to parameters, using the following designations to represent the associated parameters:

  • %I—message id
  • %F—source file name
  • %L—source line number
  • %M—KB module name
  • %R—rule name
  • %P—rule phase
  • %H—handle of the main event being processed (event_handle slot)
  • %C—class name of the main event being processedFor example, the default parameter setting: TraceRuleHeader=%F, %L: %P %R: %C #%H:
    results in a message similar to:

    mc_intevt.mrl, 42: new StbldStop:
    			 MC_CELL_STATBLD_STOP #118: Rule execution starting

Text

TraceRuleToXact

Indicates whether to include rule tracing in the transaction file, as well as in the standard cell trace, in module RULES.

Boolean

TraceFileSize

Limit on the size of a trace destination file, expressed in kilobytes.
When the trace file grows beyond the indicated size, it is renamed with a numerical suffix appended. A new trace file is started.
Special value 0 (the default) means no limitation on file size.

Number

TraceFileHistory

Number of trace files to be kept in history.
When this number is reached, a new, numbered trace file replaces the oldest one.

Number

TraceFileAppend

Indicates whether to append to existing trace files or empty existing trace files at startup.

Boolean

Note


1 Can also be used in the mclient.conf configuration file, which affects the behavior of all of the cell CLI commands. These parameters retain the same qualities and definitions in the mclient.conf file as they have in the mcell.conf file.

Was this page helpful? Yes No Submitting... Thank you

Comments