In this section:
Use the Configure Trace and Media Packet Capture window to both configure Call Trace Filters and to initiate call traces to use in debugging policy and call routing issues.
On the SBC main screen, go to Troubleshooting → Call Trace/Logs/Monitors → Call Trace and Packet Capture → Call Trace. The Configure Trace and Media Packet Capture window opens.
Configure Trace and Media Packet Capture Window:
There are two panels in this window: the Call Trace Status and Setting panel and the Call Trace Filters panel. The Call Trace Filters panel lists any existing Call Trace Filters.
Call Trace Filters define conditions that determine which call events trigger logging PES call trace messages to the system trace data event log. When a call meets the criteria, the trace information is written to a tracing file (.TRC
). The following default information is collected during a call trace:
Do not configure a Call Trace Filter to trace all calls. Use of the Call Trace feature can have significant impact on the network performance of the SBC system. Ribbon strongly recommends configuring Call Filters which result in a small number of calls being traced to avoid heavy loads. Also, be sure to delete Call Trace Filters once you have obtained the necessary information.
Enter values for the Call Trace Status and Settings using the following table.
Parameter | Description |
---|---|
Call Trace Duration | Duration in minutes that call trace is enabled. (default = 180) |
Call Trace Status | Displays the current status of the Call Trace.
|
Sage Fingerprint | Enable this flag to generate an audio fingerprint for the incoming calls that can aid in robocalling campaign identification. The back-end systems (such as Identity Hub) use this feature to identify robocalling campaigns and classify individual calls that belong to a robocalling campaign. Audio fingerprinting is enabled by default. A global configuration option is provided to disable the fingerprinting on the SBC.
|
Sage Tracing | Use this flag to allow a sampling of the call flows in the network using the L4 call trace. When the Sage Tracing feature is enabled, the SBC captures a small set of level 4 SIP PDU trace logs automatically in order to help debug field issues. This logging utilizes a small amount of CPU, for example, 1%. This functionality is not utilized if Level 4 SIP PDU tracing is already enabled to capture allMessages for all IPs, or the trace files are disabled in the eventLog configuration.
Note: You might need to disable the Sage Tracing to reduce the TRC output and the speed of log rotation if you are trying to collect a specific call trace filter. |
Only Administrators, Field Service, Guests and Operators have the ability to access the Call Trace configuration screen.
You must create Call Trace Filters before you can start a call trace.
The maximum number of call trace filters allowed is 100.
The Call Trace Filter object allows you to create and configure Call Trace Filters that specify criteria that the SBC uses to determine which call events to trace.
To create a new Call Trace Filter, click New Call Filter on the Call Trace Filters panel. The Create New Call Trace Filter window opens.
Create New Call Trace Filter Window
Enter values for the Call Trace Filter object using the following table and click Save.
Call Trace Filter parameters:
Parameter | Description |
---|---|
Capture calls that match these filters | Specifies the criteria to use determine which calls to capture in the logs in a Call Trace (these are optional). The options are:
|
Capture type | Specifies the type of logs to capture while running a Call Trace. The options are:
|
Detail level to log | Specifies the level of details that need to be capture in the log file when the trace is complete. The options are:
Note: The Level 4 log is implemented to capture SIP Ladder diagrams for the interpretation of calls. Level 4 Call Trace Filter conditions/behavior:
For more information on the effect of different levels with respect to the flag |
Name | Specifies the name of the Call Trace Filter of up to 23 characters. |
SIPRec Legs Capture | Enable this flag to trace and capture packets for SIPREC legs.
For more information on this flag, refer to Call Trace to Capture SIPRec Legs. |
State | Specifies the state of this filter. The options are:
|
Stop Match | Specifies the condition to stop matching filters. The options are:
|
As a general rule, set the Call Trace Filter for the ingress side except for the Called number.
Select an existing Call Trace Filter object by clicking the radio button adjacent to it in the Call Trace Filters window. The Edit Call Trace Filter window is displayed.
Confirm the deletion when prompted.
Once you have one or more Call Trace Filters created, call traces can be started and stopped from the top panel of the Configure Trace and Media Packet Capture window. See the earlier figure of the Configure Trace and Media Packet Capture window. There you can start, save and stop traces using the enabled filters. The trace continues running until a specified duration elapses or the specified number of call filter matches is reached.
When you start a trace, by default, the first three enabled filters in the table are used for the trace.
In the Call Trace Status and Settings panel, choose the required conditions for the trace using the following table.
Call Trace Status and Settings parameters:
Parameter | Description |
---|---|
Call Trace Duration | Specifies the duration for the Call Trace to run. The options are:
If you configure a specific value for Call Trace Duration and the SBC experiences a failover or restart, the call trace starts again automatically and runs for the specified duration. |
Call Trace Status | Displays the current status of the Call Trace.
|
Number of Matches (optional) | Specifies the maximum number of calls to match before stopping the trace. The value ranges from 1 to 64 times. |
Sage Fingerprint | Enable this flag to generate an audio fingerprint for the incoming calls that can aid in robocalling campaign identification. The back-end systems (such as Identity Hub) use this feature to identify robocalling campaigns and classify individual calls that belong to a robocalling campaign. Audio fingerprinting is enabled by default. A global configuration option is provided to disable the fingerprinting on the SBC.
|
Trace Calls with errors of the type | Check this object to enable specifying a system-wide call trace error filter trigger criteria. By default the option is unchecked which means there is no SIP PDU logging for this error filter. After checking the option the following options are available:
Note
The system-wide error filter triggers a call trace based on the selected type of error. If you select to trace calls with errors as well as define call filters to trace, the error filter runs in parallel with the call filters. Both may trigger producing a double-PDU output, one for the conditions matched in the call filter, and one for the detected error. For further details on error logs, see the section Call Trace Log Messages. |
Click Save & Start Trace to start the trace. The trace status is displayed in the same panel.
Call Trace Logs and Monitors - Call Trace Running
The trace stops automatically if a time limit is specified, otherwise you must stop the trace manually by clicking Stop Trace.
Figure 3: Call Trace Logs and Monitors - Call Trace Stop
Once the trace is complete, the logs are generated and stored at Log Management. Look for TRC and PKT log files (.trc and .pkt log files). For more details on log messages, see the section Call Trace Log Messages.
A sample log entry with memory footprint of more than 1800 bytes is illustrated below (observe the comments within /* */):
Messages like INVITE
, in combination with SIP Headers like P-Asserted-Identity
, P-Location
, etc. often tends to produce log entries with memory footprint of more than 1800 bytes per entry.
Additional information about a call is indicated by the EXTRA INFO
delimiter (see the example above). Currently, it comprises of the following:
Ingress
/Egress
indication in textCallId
Global Call ID (gcid)
from IP/Port
, to indicate the source IP and port of the messageLOCAL IP/Port
, to indicate the recipient IP and port of the messageRAW PDU
, which is the raw PDU in ascii text but not encrypted. The RAW PDU
section is the largest in a log entry, and often wraps between log entries. Sometimes, it even spans over multiple files.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: