Call Trace Filters
Only the Administrators, Field Service, Guests and Operators have the ability to access the Call Trace Configuration screen.
This object allows you to create and configure Call Trace Filters that specify criteria that the SBC uses to determine call events added to the system trace data event log (which uses the ".TRC" file extension).
Limitation: Call Trace should be set to ingress mode and not egress unless, egress mode is called for.
Caution
Do not turn on the Filter to trace all calls. Doing so may cause poor system performance. Use this mechanism to trace specific calls.
The Call Trace feature traces all the SIP PDU events (without logging other trace messages) at line-rate without dropping any PDUs. These traces are used by SIP Ladder feature for further analysis. A new log level (level 4) is added to available Call Trace levels which is required by the SIP Ladder feature.
The Call Trace feature helps you to:
- Configure Call Trace, Call Filter, Match and Error Filter options from a single screen.
- View the status of a Call Trace.
- Stop a Call Trace with a single command.
- Run the Call Trace for unlimited duration.
- Restart the Call Trace with a single click when a call trace gets stopped once the call filters reaches the threshold limit.
- Delete any Call Filter.
- Create and Edit Call Filter and Filter Match Criteria from a Single Tool.
Navigation Path:
On 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 appears.
Call Trace Logs and Monitors - Call Trace Main Window
There are two panels for this window: Call Trace Status and Setting panel and Call Trace Filters panel.
To View Call Filter
On 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 appears.The second panel reflects the Filter entries in it.
Call Trace Logs and Monitors - Call Trace Filters
To Create Call Filter
To create a new Call Filter, click New Call Filter tab on the Call Trace Filters panel.
Call Trace Logs and Monitors - Call Trace Filters Fields
The Create New Call Trace Filter window is displayed.
Call Trace Logs and Monitors - Call Trace Filters Create
The following fields are displayed:
Call Trace Filter parameters
Parameter | Description |
---|
Name | Specifies the name of the Call Trace filter that you are about to create. |
State | Specifies the state of this filter. The options are: Enabled: If enabled, this filter can be used for Call Trace.
Disabled (default): If disabled, it is not used for Call Trace.
|
Capture type | Specifies the type of logs that need to be captured while running the Call Trace. The options are: TRC logs : Capture trace information (.trc logs) only.TRC and PKT logs : Capture trace information (.trc logs) and media information (.pkt logs).
You can even save the CLI call details and statistics by selecting this additional option, Also save CLI call details and statistics for traced calls (Call Detail Status, Call Media Status, Call Resource Detail Status).
|
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: Level 1 - Everything Level 2 - Everything but raw hex dump. Level 3 - Only external message information and errors. Level 4 - Only SIP PDU events.
Level 4 Call Trace Filter conditions/behavior: - Level 4 filters based ONLY on
Peer IP Address . This call trace method does not trace/filter based on trunk group, called number, calling number, etc. - Configure a Level 4 filter with a wildcard
Peer IP Address of 255.255.255.255 to match ALL packets to/from any IP address. - Level 4 filters identify GCID when possible. However, some messages do not contain GCIDs and may have 0xfffffffff as the GCID (registration, notify, options ping, etc.).
The Level 4 log is implemented to capture SIP Ladder diagrams (which is currently not supported) for the interpretation of calls.
|
Capture calls that match these filters | Specifies the criteria that need to be captured in the logs in a Call Trace (these are optional). The options are: Called Number: Specifies the called party number to trace. An X or x means accept anything in that digit position. For example, 617xxx1212 would filter for all numbers 6170001212 through 6179991212. The % symbol acts as a wildcard for all remaining digits. For example, use 978% to trace all calls with a 978 prefix. Field Length is upto 30 characters.Calling Number: Specifies the calling party number to trace. An X or x means accept anything in that digit position. For example, 617xxx1212 would filter for all numbers 6170001212 through 6179991212. The % symbol acts as a wildcard for all remaining digits. For example, use 978% to trace all calls with a 978 prefix. Field Length is upto 30 characters.Contractor Number: Specifies the contractor number to trace. An X or x means accept anything in that digit position. For example, 617xxx1212 would filter for all numbers 6170001212 through 6179991212. The % symbol acts as a wildcard for all remaining digits. For example, use 978% to trace all calls with a 978 prefix. Field Length is upto 30 characters.
For the above parameters, use "X" or "x" wildcard characters to match any single digit and "%" symbol to match any digits from that point forward.
Redirecting Number: Specifies the redirecting number to trace. An X or x means accept anything in that digit position. For example, 617xxx1212 would filter for all numbers 6170001212 through 6179991212. The % symbol acts as a wildcard for all remaining digits. For example, use 978% to trace all calls with a 978 prefix. Field Length is upto 30 characters.CDDN number: Specifies the Called Directory Number to trace. Field Length is upto 30 characters.
Transfer capability: Specifies the transfer capability of the call trace filter. Options are:
Audio31Khz - 3.1 kHz Audio - ITC 3.1 kHz audio calls are traced. The default setting is disabled.Speech - ITC Speech based calls are traced. The default setting is disabled.Unrestricted - Calls with ITC Unrestricted are traced. The default setting is disabled.Unrestricted With Tones - Unrestricted Digital Information With Tones Announcements - Calls with ITC Unrestricted Digital Information With Tones Announcements are traced. The default setting is disabled.video - Calls with ITC Video are traced. The default setting is disabled.
Trunk Group: The name of a trunk group to trace. This string must match the trunk group name exactly. You cannot use wildcard characters for this argument. Field Length is upto 23 characters.Peer IP Address: Specifies the peer IpV4 or IpV6 Address for call tracing.
|
stop match | Specifies the criteria to stop the Call Trace. The options are: When a match occurs in this filter, stop trying to match the other filters Continue to try to match up to two other filters after a match is found in this filter (default)
|
To Edit Call Filter
To edit any of the Call Filter entries in the list, click the radio button next to the specific Call Filter entry.
Call Trace Logs and Monitors - Call Trace Filters Highlighted
The Edit Call Trace Filter window is displayed below.
Call Trace Logs and Monitors - Call Trace Filters Edit
Make the required changes and click Save at the right hand bottom of the panel to save the changes made.
To Copy Call Filter
To copy any of the created Call Filter entry and to make any minor changes, click the radio button next to the specific Call Filter to highlight the row.
Call Trace Logs and Monitors - Call Trace Filters Highlighted
Click Copy Call Filter tab on the Call Trace Filters panel.
Call Trace Logs and Monitors - Call Trace Filters Fields
The Copy Call Trace Filter window is displayed along with the field details which can be edited.
Call Trace Logs and Monitors - Call Trace Filters Copy
Make the required changes to the required fields and click Save to save the changes.
To Delete Call Trace
To delete any of the created Call Trace filters, click the radio button next to the specific Call Trace filter which you want to delete.
Call Trace Logs and Monitors - Call Trace Filters Highlighted
Click Delete at the end of the highlighted row. A delete confirmation message appears seeking your decision.
Call Trace Logs and Monitors - Call Trace Filters Delete Confirmation
Click Yes to remove the entry from the list.
Call Trace Status and Settings
Call Trace Status and Settings panel allows you to perform a Call Trace. It allows you to Start, Save and Stop the traces on the selected filters.
On 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 appears. The First panel reflects the area to perform a Call Trace.
Call Trace Logs and Monitors - Call Trace Main Window
Before you start a Call Trace, let us examine the conditions and the required fields to execute a Call Trace. The following conditions appear on the Call Trace Status and Settings panel.
Call Trace Status and Settings parameters
Parameter | Description |
---|
Call Trace Duration | Specifies the duration for the Call Trace to run on the selected filter. The options are: Run trace until stopped (by clicking the Stop Trace button): If selected, the trace will keep running till it is stopped manually (by clicking the Stop Trace button).
Stop trace after __ minutes: If selected, add the number of minutes for the Call Trace to run. The value ranges from 1 to 360 minutes and the default value is 360 minutes.
|
Number of Matches (optional) | Specifies the number of times the Call Filter criteria should match before stopping the trace. The value ranges from 1 to 64 times. |
Trace Calls with errors of the type | Enable this option to trace the calls with error type as: none (default)— No SIP PDU logging, including validation/parsing errors.Any —Log all SIP PDUs that meet the requirement of the Parse Error, Out of Dialog, and Early Attempt options below.Parse Error —Log received SIP PDUs that fail parsing. If an error is detected by SIP signaling, the accompanying PDUs will not be associated with any dialog, including an existing dialog. Hence all in dialog and out of dialog PDUs are assigned to this category. If an error is detected at the front end pre-parser, the PDU is logged by this software and not forwarded to SIP signaling. This prevents an offending PDU from being logged by both the pre-parser and SIP signaling.Out of Dialog —Log incoming syntactically correct SIP PDUs (except INVITE) that do not belong to an existing dialog.Early Attempt —Logs incoming SIP PDUs that result in early termination of the call (by either the pre-parser or SIP signaling).
|
Call Trace Status | Displays the current status of the Call Trace. - When there are no trace running, the application states Call trace stopped with a red dot.
- when a trace is running, the application states Call trace running with a green dot.
|
To Run Call Trace
Follow these simple steps to run a Call Trace on a selected filter:
- Create a Call Trace Filter with the required parameters and conditions mentioned. Refer to To Create Call Filter section to activate the required parameters.
- The newly created filters are displayed in the Call Trace Filter panel.
- In the Call Trace Status and Settings panel, choose the required conditions to run the trace. Refer to Call Trace Status and Settings to know more on the conditions.
Click Save & Start Trace on the Call Trace Status and Settings panel to start the trace. The trace status is displayed in the same panel.
When you start the trace, by default, the first three enabled filters in the table are used for the trace.
Call Trace Logs and Monitors - Call Trace Running
The trace stops automatically if the condition is enabled else you have to stop the trace manually by clicking Stop Trace.
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).