Versions Compared

Old Version 12

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 13

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated images and added the "Also save CLI call details and statistics for traced calls..." option is not supported to partially address SBX-50802.
Panel

In this section:

Table of Contents
maxLevel2

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

Call Trace

Multiexcerpt include
MultiExcerptNameCall Trace Filtering
PageWithExcerptMedia Capture and Call Trace

When a call trace filter is created, call trace is started, and a call fulfills the filter criteria, the trace information is written to a tracing file (.TRC). Call trace can be started and stopped from the Call Trace > Configure Trace and Media Packet Capture screen. The trace continues running until the specified duration or number of call filter matches is reached.

The EMA Call Trace feature supports the following functionality:

  • 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.

window opens. 

Caption
0Figure
1Configure Trace and Media Packet Capture Window
Anchor
Configure Trace and Media Packet Capture
Configure Trace and Media Packet Capture
 Image Added
 

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: 

  • Service group configuration
  • DSP T.38 event information, if applicable
  • DSP channel statistics
  • DEBUG/SYS log information  
Call Trace Filters
Warning
titleWarning

Do not turn on the 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 

Spacevars
0product
system. 
Spacevars
0company
strongly recommends configuring Call Filters which result in small quantities of 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.

Call Trace Filters

note
Info
titleNote:

Only the Administrators, Field Service, Guests and Operators have the ability to access the Call Trace Configuration configuration screen.

You must create Call Trace Filters before you can start a call trace.

 The 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 added to the system trace data event log (which uses the .TRC file extension).

Info
titleNote
As a general rule, set Call Trace to ingress mode unless egress mode is mandatory

.

 

 

Navigation Path:

On the SBC main screen, navigate to Troubleshooting > Call Trace/Logs/Monitors > Call Trace and Packet Capture > Call Trace. The Configure Trace and Media Packet Capture window appears.

Caption
0Figure
1Call Trace Logs and Monitors - Call Trace Main Window
Image Removed 

 

There are two panels for this window: Call Trace Status and Setting panel and Call Trace Filters panel.

Info

You need to create Filters first or use the created Filters to start a Call Trace on it.

To View Call Filter

On the SBC main screen, navigate 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.

Caption
0Figure
1Call Trace Logs and Monitors - Call Trace Filters
Image Removed 

 

Anchor
To Create Call Filter
To Create Call Filter
To Create a Call Trace Filter

To create a new Call Trace Filter, click New Call Filter tab on the Call Trace Filters panel.

Caption
0Figure
1Call Trace Logs and Monitors - Call Trace Filters Fields
Image Removed 

 

The Create New Call Trace Filter window is displayedopens.

Caption
0Figure
1Create New Call Trace Logs and Monitors - Call Trace Filters CreateFilter Window
Image Modified 

 The following fields are displayed:

Enter values for the Call Trace Filter object using the following table and click Save.

Caption
0Table
1Call Trace Filter parameters
 
You can save the CLI call details and statistics by selecting this additional option,

The option "Also save CLI call details and statistics for traced calls (Call Detail Status, Call Media Status, Call Resource Detail

Status). These files are saved as .out files.

Status)" is not supported.  

For the above parameters, use

    • symbol 

    • Wildcard matching is also supported. Use "X" or "x" wildcard

    characters

    character 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

    using "978xxx1212" returns all calls between 9780001212 and 9789991212, and using "978%" returns all calls with a 978 prefix.

    Field Length is up to 30 characters.

     

  • CDDN number: Specifies the Called Directory Number to trace. Field Length is up to 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 Video - Calls with ITC Video are traced. The default setting is disabled.

    Trunk Group: The name of a trunk group to filter the calls to trace. This string must match the trunk group name exactly. You cannot use wildcard characters for this argument. Field

    Length

    length is up to 23 characters.

    Peer IP

    Address

    address: Specifies the peer IpV4 or IpV6

    Address

    address for call tracing.

    stop match

    Parameter

    Description

    NameSpecifies the name of the Call Trace filter that you are about to createFilter of up to 23 characters.
    State

    Specifies the state of this filter. The options are:

    • Enabled: If enabled, this filter can be used for a Call Trace.
    • Disabled (default): If disabled, it is not used for Call a Call Trace.
    Capture type

    Specifies the type of logs that need to be captured logs to capture while running the a 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).
    Note
    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.events 
    note
    Info
    titleNote:

    The Level 4 log is implemented to capture SIP Ladder diagrams for the interpretation of calls.

     Level 4
    Note
    Level 4 Call Trace Filter conditions/behavior:
    • Level 4 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.
    • The Level 4 filters are based only on Peer IP Addressand it address and this must be specified to trace calls. This call trace method does not trace/filter based on trunk group, called number, calling number, and so on.
    • Configure a Level 4 filter with a wildcard Peer IP Addressaddress  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, and so on).
    • No other trace filters can be running at the same time as the level 4 trace (that is, do not run a level 1, 2, or 3 trace at the same time as the level 4 trace.)

    The Level 4 log is implemented to capture SIP Ladder diagrams for the interpretation of calls.


    Capture calls that match these filters

    Specifies the criteria that need to be captured the criteria to use determine which calls to capture in the logs in a Call Trace (these are optional). The options are:

    Called

    Number

    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

     Field length is up to 30 characters.

    Calling number: Specifies the calling party number to trace. Field length is up to 30 characters.

    Contractor number: Specifies the contractor number to trace. Field length is up to 30 characters.

    Calling Number

    Redirecting number:

    Specifies

     Specifies the

    calling party

    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

    Field length is up to 30 characters.

    CDDN number: Specifies the Called Directory Number to trace. Field length is up to 30 characters. 

    NOTE:

    The

    For the preceding options, the following characters are accepted by the SBC when specifying

    the

    Call Trace Filter

    search

    criteria: 

      • Digits 0-9

      • Plus (+)

      • symbol

    • Wilcard characters (“x” or “X”) to match any single digit within the search string

    • Wilcard symbol (%) to match any digits from that point forward

      • 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 up to 30 characters.

    Note
    Stop Match

    Specifies the criteria condition to stop the Call Tracematching filters. 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)
    Info
    titleNote

    As a general rule, set the Call Trace Filter for the ingress side except for the Called number. 

    To Edit a Call Trace Filter

    To edit any of the Call Filter entries in the list, click

    1. Select an existing Call Trace Filter object by clicking the radio button

    next to the specific Call Filter entry.
    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Highlighted
    Image Removed 

     

    The Edit

    1. adjacent to it in the Call Trace Filters window. The Edit Call Trace Filter window is displayed

    below

    1. .

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Edit
    Image Removed 

     

    1. Make
    the required
    1. changes and
    click Save at the right hand bottom of the panel to save the changes made
    1. click Save.

    To Copy a Call Trace Filter

    To copy any of the created Call Filter entry and to make any minor changes, click
    1. Select an existing Call Trace Filter object by clicking the radio button
    next to the specific Call Filter to highlight the row.
    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Highlighted
    Image Removed 
     
    1. adjacent to it in the Call Trace Filters window.
    2. Click Copy Call Filter
    tab on the Call Trace Filters panel
    1. .
    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Fields
    Image Removed 

     

    1. The Copy Call Trace Filter window is displayed
    along with the field details which can be edited
    1. .
    caption

     

    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Copy
    Image Removed 
    1. Make
    the required
    1. changes
    to the required fields
    1. and
    click
    1. click Save
    to save the changes
    1. . 

    To Delete a Call Trace

    To delete any of the created Call Trace filters, click

    Filter

    1. Select an existing Call Trace Filter object by clicking the radio button
    next to the specific Call Trace filter which you want to delete.
    1. adjacent to it in the Call Trace Filters window.
    2. Click the X on the right end of the selected row.

    3. Confirm the deletion when prompted

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Highlighted
    Image Removed 

     

    Click Delete at the end of the highlighted row. A delete confirmation message appears seeking your decision.

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Filters Delete Confirmation
    Image Removed 

     

    Click Yes to remove the entry from the list

    1. .

    Anchor
    Call Trace Status and Settings
    Call Trace Status and Settings
    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 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 appears. The First panel reflects the area to perform a Call Trace.

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Main Window
    Image Removed 

     

    . 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.

    Info
    titleNote:

    When you start a trace, by default, the first three enabled filters in the table are used for the trace.

    To Run a Call Trace

     In 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, choose the required conditions for the trace using the following table.

    Caption
    0Table
    1Call Trace Status and Settings parameters
    3Call Trace Error Types
     

    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 is 180 minutes.
    Number of Matches (optional)Specifies the maximum number of times the Call Filter criteria should calls to match before stopping the trace. The value ranges from 1 to 64 times.
    Trace Calls with errors of the type

    Use Check this object to specify the enable specifying  a system-wide call trace error filter trigger criteria.

    none (default)—No

    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:  

    • 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).

    Include Page
    Call_Trace_ErrorFilter_Note
    Call_Trace_ErrorFilter_Note

    For further details on error logs, see the section Call Trace Log Messages.

    Call Trace Status

    Displays the current status of the Call Trace.

    • When there are is no trace running, the application states status is Call trace stopped with a red dot.
    • when a trace is running, the application states status is 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.

      

    Note

    When you start the trace, by default, the first three enabled filters in the table are used for the trace.

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Running
    Image Modified 

    The trace stops automatically if

    the condition is enabled else you have to

    a time limit is specified, otherwise you must stop the trace manually by clicking Stop Trace.

    Caption
    0Figure
    1Call Trace Logs and Monitors - Call Trace Stop
    Image Modified
     

    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.

    Anchor
    Log Message Facts
    Log Message Facts
    Call Trace Log Messages

    Include Page
    Notes_and_Examples_on_Call_Trace_Log_Message
    Notes_and_Examples_on_Call_Trace_Log_Message

    Offline Call Trace Analysis Using LX Utility

    Multiexcerpt include
    MultiExcerptNameLX
    PageWithExcerptMedia Capture and Call Trace

    Pagebreak