Call Trace - CLI

Call Trace Filtering

The SBC supports configuring Call Trace Filters using the Signaling Packet Capture command to establish criteria to determine call events and logging PES call trace messages (using the ".TRC" file extension) to the system trace data event log. This information is used for debugging policy and call routing issues.

The following default information is collected during a call trace:

• Service group configuration
• DSP T.38 event information, if applicable
• DSP channel statistics
• DEBUG/SYS log information

The first three Call Trace filters are automatically logged unless the stopMatch flag in enabled, whereby the number of filters logged may be less than three. The stopMatch flag will halt filter profile matching once a match is found.

When call trace filter criteria is provisioned and a call meets the criteria, trace information is written to a tracing file. Call trace is enabled using the provisioning interface.A callTraceTimer configuration is provided along with the maxTriggerCount configuration to limit the logging of call/error filter events in the TRC file. The SBC may be configured to stop call tracing if either of following criteria is met:

• Configured maxTriggerCount is reached or,
• Configured callTraceTimer expires

The maxTriggerCount parameter is used to set/reset the Trigger Count, a mechanism used to limit the logging of call/error filter events in the .TRC file.

To rectify this, disable and then reenable the applicable filters using the following CLI command syntax: 

% set global callTrace signalingPacketCapture state disable 
% set global callTrace signalingPacketCapture state enable
% set global callTrace callFilter <filterName> state disabled
% set global callTrace callFilter <filterName> state enabled
% set global callTrace callFilter <filterName> mediaPacketCapture disable
% set global callTrace callFilter <filterName> mediaPacketCapture enable

Use the following criteria to establish a Call Trace Filter:

• Called Party Number
• Calling Party Number
• Contractor Number
• Peer IP Address
• Redirecting Number
• Transfer Capability
• Trunk Group

Use the match keyword to specify criteria to use to capture call data upon a match. Use the key keyword to specify criteria on which to filter call data.
Call events captured are:

• Call attempt
• Lookup request sent
• Lookup request received
• Alerting received
• Cut-through received
• Call Answer received
• Cut-through complete
• Service established
• Disconnect Request received
• Call terminated
• Wait for more digits
• Extra digits received
• Initiating new attempt
• Signal messages received or sent
• Egress call setup message
• Route lookup failure
• Call blocked
• Policy Request
• Policy Response
• Policy processing of calls in different layers like pre-processor, services, pre-router, router, and post-router.
• SIP signaling events for a single call incoming/outgoing to a particular source/destination IP endpoint
• SIP Protocol Data Units (PDUs) for a single call incoming/outgoing from/to a particular source/destination IP endpoint
• SIP out-of-dialog PDUs such as 18X, BYE, and INFO, regardless of whether they are successfully parsed

The TRC event log level must be info for this facility to operate properly.

Use the maxTriggerCount parameter to limit the logging of call/error filter events in the .TRC file. After configuring and enabling the callFilter, an ingress/egress call that matches the filter criteria causes the corresponding events to be logged to the .TRC file, as long as the Trigger Count has not been reached. Once the configured Trigger Count has been reached, the matching callFilter will not be triggered and events associated with the call trace filter will not be logged in the .TRC file. To reenable triggering, you must configure the Trigger Count to a non-zero value less than 65.

Once the maxTriggerCount is reached or callTraceTimer expires, the call trace stops. To restart the call trace without changing the callTrace configuration, use following CLI command:

% request global callTrace action command start 

Command Syntax

Use following CLI syntax to configure call trace filters:

Global Call Trace Syntax

% set global callTrace 
	callFilter <callFilter_name> 
	callTraceTimer <1-360>
	errorFilter errorType <any | earlyAttempt | none | outOfDialog | parseError>
	maxTriggerCount <0-64>	
	signalingPacketCapture
		devices <mgmt0 | mgmt1 | pkt0 | pkt1 | pkt2 | pkt3> <VLAN tag>
		filter <signaling trace filter name>
		signalingPacketCaptureTimer <0-360 minutes>
		state <disable | enable>

Call Filter Syntax

% set global callTrace callFilter <callFilter_name> 
	key <called | calling | cddn | contractor | peerIpAddress | redirecting | transferCapability | trunkGroup>
	level <level1 | level2 | level3 | level4>
	match
		called <string>
		calling <string>
		cddn <string>
		contractor <string>
		peerIpAddress <IP address>
		redirecting <string>
		transferCapability <audio31Khz | speech | unrestricted | unrestrictedWithTones | video>
		trunkGroup <trunkGroup_name>
	mediaPacketCapture <disable|enable>
	state <disabled|enabled>
	stopMatch <supported | unsupported>

To configure signaling state:

% set global callTrace signalingPacketCapture state <enable | disable> 

Command Parameters

Global Call Trace Parameters

Call Filter Parameters

Command Examples

To enable call tracing based on the called number:

% set global callTrace callFilter CF-1 level level1 state enabled key called,calling match called 978%  
% set global callTrace callFilter CF-1 mediaPacketCapture enable  

To view the recently-enabled call trace filter:

% show table global callTrace callFilter  
   callFilter CF-1 {  
	state enabled;  
	level level1;  
	key called,calling; 
	match {  
		called 978%;  
	}  
	mediaPacketCapture enable;  

To enable signaling packet capture:

% Set global callTrace signalingPacketCapture state enable

Offline Call Trace Analysis Using LX Utility

The TRC files can be analyzed offline using the LX tool, which generates a SIP ladder diagram from the TRC or DBG files. The LX tool is a Windows PC application available free of charge to all customers and partners with a license agreement, and can be downloaded as part of your software download request. For details, refer to LXDOC.

LX Main User Interface