Monitor and Trace

The Monitor and Trace tab displays the results of filtered SIP session data from the Oracle Enterprise Communications Broker in categorical lists. Each of the lists displays the results in a common log format for local viewing, which you can export as HTML and text files.

When you click the Monitor and Trace tab, the Web GUI displays links to the available lists in the navigation pane and defaults to Sessions. In the white space below the list, the GUI displays the total number of entries in the list and the numbers of the entries currently in view. The counter is dynamic and changes the enumeration as you scroll through the list. The following screen capture shows the Monitor and Trace default display.

This screen capture shows the Monitor and Trace page with its links to the Sessions, Registrations, Subscriptions, and Notable Event summary lists. The Sessions list displays by default.

Each summary provides sorting, searching, paging, and exporting functionality, as well as a ladder diagram view where you can see a session summary, session details, and QoS statistics. You can choose which columns that you want each summary list to display by right clicking any column header and selecting column names from the pop-up list. The available column names vary according to the list type.

This screen capture shows an example of the pop-up list that displays when you right click any column header in a Monitor and Trace list. The list shows all of the column headers available. Each header has a check box where you can select or deselect the header.

Monitor and Trace can store messages per session and it can store cumulative sessions across all report types. When the sessions maximum is reached, the system removes the oldest call and adds the newest call.
  • On systems with less than 4GB of RAM, the system can store:
    • 50 messages
    • 2,000 sessions
  • On systems with more than 4GB of RAM, the system can store:
    • 50 messages
    • 4,000 sessions
The call database does not persist when you change the number of rows in a Ladder Diagram and Save and Activate the change.

The system can perform live paging from Monitor and Trace tables.

Note:

Only one user at a time can view Monitor and Trace information. Monitor and Trace does not support multiple, simultaneous viewers.

SIP Notable Events Summary

The SIP Notable Events Summary contains all logged sessions that have a notable event on the Oracle Enterprise Communications Broker (OECB) associated with the session. The columns that display on the Notable Events Summary page depend on the columns that you selected in the "Customizing the Page Display" procedure.

The following table describes the columns that Notable Events Summary page can display.

Display a Notable Events Report

  1. Access Notable Events: , Monitor and Trace tan, Notable Events.
  2. Use the controls on the page to view information about the records in this report.

SIP Registrations Summary

The SIP Registrations Summary displays a summary of all logged SIP registrations sessions on the Oracle Enterprise Communications Broker (OECB). The columns that display on the Registrations Summary page depend on the columns you selected in the "Customizing the Page Display" procedure.

The following table describes the columns available on the Registrations Summary page.

Display a Registrations Report

  1. Access Registrations: Monitor and Trace tab, Registrations.
  2. Use the controls on the page to view information about the records in this report.

SIP Sessions Summary

The SIP Sessions Summary is a SIP session summary of all logged call sessions on the Oracle Enterprise Communications Broker (OECB). When you enable Lightweight Directory Access Protocol (LDAP) on the Active Directory, LDAP session messages may also display. The columns that display on the Sessions Summary page depend on the columns that you specified in the "Customizing the Page Display" procedure.

The following table describes the columns on the SIP Session Summary page.

Display a Sessions Report

  1. Access SIP Session Summary: Monitor and Trace tab, Sessions.
    The system displays the SIP Sessions Summary page.
  2. Use the controls on the page to manage the records in the report.
SIP Message Details

The SIP Message Detail window displays detailed information and data flow (ingress and egress) about the call or media event.

This image is a screen capture of a session summary report.

When a session is routed using the a Lightweight Directory Access Protocol (LDAP) configuration (Active Directory) for the local policy, the LDAP information displays in the Session Summary window. The next hop value containing "enum:…" or "dns:…" displays. Similarly, the next hop value "ldap:…" displays for LDAP queries.

This image is a screen capture of a session summary report when a session is routed using LDAP.

SIP Subscriptions Summary

The SIP Subscriptions Report displays a summary of all logged SIP subscription sessions on the Oracle Enterprise Communications Broker (OECB). The columns that display on the Subscription Report page depend on the columns you selected in the "Customizing the Page Display" procedure.

The following table describes the columns on the Subscriptions Report page.

Display a Subscriptions Report

  1. Access Subscriptions: Monitor and Trace tab, Subscriptions.
  2. Use the controls on the page to view information about the records in this report.

Ladder Diagrams and Display Controls

A ladder diagram is a graphical representation of the flow of call and media packets on ingress and egress routes through the Oracle Enterprise Communications Broker (OECB). Viewing ladder diagrams can help you with troubleshooting and system monitoring. The Web GUI can display ladder diagrams for each of the summary reports available through Monitor and Trace.

The OECB can store up to 4,000 calls on a system with more than 4GB of memory and up to 2,000 calls on a system with less than 4GB of memory. A ladder diagram can display an unlimited number of rows, but the relationship of calls to rows is inverse. The more rows you see per call, the fewer calls the OECB can display. You cannot set the number of rows displayed.

To display one or more ladder diagrams, select one or more rows in the Session, Registrations, Subscriptions, or Notable Events lists and click Ladder Diagram. The Web GUI adds a tab to the top of the page for each ladder diagram. Click the tabs to see the ladder diagrams.

Note:

You can also right-click a row and click Ladder Diagram on the pop-up menu or click the ellipses at the beginning of a row and click Ladder Diagram on the pop-up menu.

The following illustration shows a sample ladder diagram with notations about the controls for viewing and exporting.

This screen capture shows the pop-up menu that displays when you right click a row in a summary table. Ladder Diagram is the first item on the list.

Ladder diagrams contain the following sections.

Session Summary—Displays session data. Use the [+] and [-] controls to toggle between show and hide. The default is hide.

Ladder Diagram—Displays SIP message and call flow information. Hover over a line in the ladder diagram to see more information about the highlighted flow.

QoS Stats—Displays Quality of Service (QoS) information. Use the [+] and [-] controls to toggle between show and hide. The default is hide. You must enable Quality of Service (QoS) on your system to see the QoS Statistics information.

The following screen capture shows an example of a ladder diagram as initially displayed with the Session Summary and QoS Stats sections hidden.

This screen capture shows the ladder diagram as it displays initially with the ladder diagram shown and the Session Summary and the QoS Stats sections hidden.

The following screen capture shows an example of an OECB ladder diagram with the Session Summary and QoS sections expanded. This screen capture also shows an example of the pop-up that displays detailed SIP Message Details when you hover over a row in the diagram.

This screen capture shows the controls you can use on a ladder diagram to view session, call flow, and Quality of Service information.

Note:

The OECB captures SIP messages, applies the Header Manipulation Rules (HMR) that you configured on the OECB, and applies the Session Plug-in Language (SPL) to that message. When the OECB sends the message, it applies the SPL, the HMR, and sends the captured SIP message. When viewing the session detail on a Ladder Diagram, the HMR and SPL information may be present.

Ladder Diagram Controls

Ladder diagrams display the following controls at the bottom of the page.

Refresh—Use to refresh the data in the ladder diagram.

Export diagram—Use to export the ladder diagram to an HTML file.

Export session details—Use to export the session details to a text file.

Close and Remove Ladder Diagram Tabs

To remove an individual tab you can either click the X on the tab or right-click and click Remove on the pop-up menu.

To remove all tabs, right-click a tab and click Close All on the pop-up menu.

Display a Ladder Diagram

You can display a ladder diagram of call and media flow data from the Sessions, Registrations, Subscriptions, and Notable events lists in Monitor and Trace. Each list page displays a table, where each row represents one session. You can view a ladder diagram for each session with the following procedure.

The Monitor and Trace tab can display multiple ladder diagrams in separate tabs. You can either select multiple rows from the list initially or repeat the procedure later to display more ladder diagram tabs.
  1. Access the Monitor and Trace tab.
  2. On the Monitor and Trace tab, select one of the following lists:
    • Sessions
    • Registrations
    • Subscriptions
    • Notable Events
  3. On the list page, do one of the following :
    • Double click a row.
    • Select one or more rows and click Ladder Diagram.
    The Web GUI adds one or more tabs above the list that you can click to view the contents.
  4. (Optional)—On the ladder diagram, click the [+] to expand the Session Summary and QoS Stats sections.
  5. (Optional)—Refresh the diagram, export the diagram, or export the session details, using the buttons at the bottom of the page.

Session Summary

To see a Session Summary, open a ladder diagram from a record in a Summary report and click the [+] control that precedes "Session Summary" at the top of the page. Monitor and Trace displays the session data and statistics.

The following screen capture shows a sample Session Summary page generated from a selected item on a ladder diagram.
This iscreen capture shows a sample Session Summary.
The following table describes each field in the Session Summary report.
Display a Session Summary

You can view data and statistics about a call or media session by displaying the Session Summary from a ladder diagram.

  1. Under the Monitor and Trace tab, select one of the following summaries:
    • Sessions
    • Registrations
    • Subscriptions
    • Notable Events
  2. On the Summary page, select a row in the table and right-click.
  3. On the pop-up menu, click Ladder Diagram.
  4. (Optional)—On the ladder diagram, click the [+] to expand the Session Summary section.

QoS Statistics

The Quality of Service (QoS) Stats section of the Session Summary displays information about the quality of the service for a selected call session or media event. To see the QoS statistics, open a ladder diagram from a record in a Summary report and click the [+] control that precedes "QoS Statistics" at the bottom of the page.

Expand QoS Stats section with the [+} control.

This image is a screen capture of a session summary report that shows Quality of Service statistics. The report displays a ladder diagram of a call flow for a session. Below the ladder diagram. the SBC displays Q O S statistics such as flow id, direction, total packets received, total octets received, RTCP packets lost, RTCP average jitter, RTCP maximum jitter, RTCP average latency, RTCP maximum latency, RTP packets lost, RTP average jitter, RTP maximum jitter, Q O E r factor and Q O E M O S.

The following table describes each column in the QoS Stats report.

Display QoS Statistics
When you want to view QoS statistics for a call or media flow session, you can do so from a ladder diagram in Monitor and Trace.
  1. Under the Monitor and Trace tab, select one of the following summaries:
    • Sessions
    • Registrations
    • Subscriptions
    • Notable Events
  2. On the Summary page, select a row in the table and right-click.
  3. On the pop-up menu, click Ladder Diagram.
  4. On the ladder diagram, click the [+] to expand the QoS Stats section.

SIP Monitor and Trace Filter Configuration

The SIP Monitor and Trace function allows you to monitor SIP sessions for notable events and display the results in the Oracle Enterprise Communications Broker (OECB) SIP Notable Events summary. Such information may help you perform troubleshooting. For more targeted monitoring, you can configure filters on particular users and addresses on the OECB, and on a specific agent.

The OECB Configuration page, located on the Configuration tab, System Administration section, SIP Interface, Monitoring Filters, includes the following objects for configuring SIP Monitoring filters:
  • The SIP Interface configuration page displays the Monitoring Filters object in the navigation pane, which you use to configure individual filters.

    This screen capture shows the navigation pane of the Configuration tab, with the Monitoring Filters object highlighted, and displaying the filter config dialog.

  • The Monitoring object on the SIP interface configuration page displays the Monitoring Filters element in the dialog. Use it to apply filters to the OECB.

    This screen capture shows the navigation pane on the Configuration tab with the Monitoring object selected, and the SIP monitoring configuration dialog.

  • The Add Agents configuration page displays the Monitoring Filters configuration element to the Advanced section. Use it to apply filters to an agent.

    Figure 16-1 Monitoring Filters

    This screen capture shows the Monitoring Filters dialog that the system displays after you click Add in the SIP monitoring dialog.
  • Note:

    After the P-CZ2.0.0m4 release, the system does not support the former "Enable SIP Monitor and Trace" setting. You must re-configure SNMP event traps through the dialogs described in this topic.
Use the following filter configuration process for both new installations and upgrades.
  1. Create one or more filters in the Monitoring Filters object. You may use an asterisk character as a filter, if you want to monitor all session data.
  2. Add one or more filters to the Monitoring object.
  3. (Optional) Add one or more monitoring filters to an agent that you want to monitor.

Search for a Record

The Search button at the top of the report page allows you to find a specific record within a Monitor and Trace report. It also allows you to specify criteria on which to perform the search.

After defining a search criteria in the Search Filter dialog box, clicking Search automatically populates the report page with the records that match the specified criteria specified. The search performs the filtering process of criteria dependent on the report page from which you are running the search.

For example, performing a search from the Sessions report page displays only the reports pertaining to call sessions. If you perform a search on the Registration report page, only the reports pertaining to call registrations displays on the report page. The search string containing the criteria on which you performed the search, displays in the top left corner of the page.

Note:

A SIP Monitor and Trace global search can find items in the SIP headers, as well.

The system saves the search criteria until you click Reset in the dialog box, or until you log out of the HTTP session.

Search for a Report Record

Use the Search button at the top of the report page to help you find a specific record in an Oracle Enterprise Communications Broker (OECB) Monitor and Trace report. Search allows you to specify criteria for the search.

You can specify a value for any or all of the fields in the Search field. The search process searches for records with all of the values you specify and displays only the records with those values. When you perform a Global Search and specify values in other fields, the search process searches the other specified fields first and then filters on the Global Search field.
  • If you specify the “*” character in a search string, the search is performed on that exact string. For example, if you search for “123*45”, the search shows results for all strings containing “123*45”.
  • You can use quotes (“ “) to specify a search. For example, you can enter Smith and the search finds all of the records that match Smith, such as: John Smith field<sip:sipp@192.168.1.70:5070>;tag=12260SIPpTag001.
  • When you enter a space before or after a quotation mark, (for example, “Smith “), the search returns no data.
  1. On any reports page, click Search and do the following in the Search Filter dialog.
  2. Click Search.

Specify Additional Identifiers

To specify additional identifiers:

  1. In the Session Id field, enter the ID of the call session you want to search. Valid values are alpha-numeric characters. For example, 22-3412@172.16.34.1.
  2. In the In Call ID field, enter the ID of the incoming call (phone number and source IP address). Valid values are alpha-numeric characters. For example, 25-3412@172.16.34.10.
  3. In the Out Call ID field, enter the ID of the outgoing call (phone number and IP address). Valid values are alpha-numeric characters. For example, 14-3412@172.14.54.6.
  4. In the State (with result code) field, enter the status of the call session with the result code for which you want to search. Valid values are (case-sensitive):
    • INITIAL-<result code>

    • EARLY-<result code>

    • ESTABLISHED-<result code>

    • TERMINATED-<result code>

    • FAILED-<result code>

      Result codes can range from 1xx to 5xx. For example, terminated-200, or failed-400.

  5. In the Notable Event field, select the notable event for which you want to search. Valid values are:
    • any-event - search displays any notable event that was stored in memory.

    • short-session - search displays only records that indicate a short-session duration has occurred.

    • local-rejection - search displays only records that indicate a local-rejection has occurred.

  6. To search on additional parameters, click on the Additional Search Options down arrow to expand the dialog box.

Specify Additional Search Options

To specify additional search options:

  1. In the “In Realm” field, enter the name of the realm for which the incoming call belongs. Valid values are alpha-numeric characters. For example, access.
  2. In the “Out Realm” field, enter the name of the realm for which the outgoing call belongs. Valid values are alpha-numeric characters. For example, backbone.
  3. In the “In SA” field, enter the name of the session agent (SA) on the incoming call session. Valid values are alpha-numeric characters. For example, SA1.
  4. In the “Out SA” field, enter the name of the session agent (SA) on the outgoing call session. Valid values are alpha-numeric characters. For example, SA2.
  5. In the “In Source Addr” field, enter the source IP address of the SA that accepted the incoming call session. IP Address must be entered in dotted decimal format (0.0.0.0). For example, 172.45.6.7.
  6. In the “Out Dest Addr” field, enter the destination IP address of the SA that accepted the outgoing call session. IP Address must be entered in dotted decimal format (0.0.0.0). For example, 172.64.56.7.
  7. In the In Network Interface field, enter the incoming core network interface that connects the Net-Net ECB to your network. IP Address must be entered in dotted decimal format (0.0.0.0). For example, 192.45.6.7.
  8. In the Out Network Interface field, enter the outgoing network interface that connects your Net-Net ECB to the outside network. IP Address must be entered in dotted decimal format (0.0.0.0). For example, 192.45.6.8.
  9. Click <Search> to perform the search with the values you specified. A list of the records that the search process filtered, display in the window. The GUI saves the search specifications until you click <Reset> in the search dialog box, OR until you log out of the GUI.

Export Monitor and Trace Information to a Text File

Monitor and Trace allows you to export Monitor and Trace information to a text file from the Sessions, Registrations, Subscriptions, and Notable Events Reports.

To export report information, do one of the following:
  • Select a row and click one of the export buttons displayed above the report list.
  • Select a row, right click, and click an export operation on the menu.
  • Click the ellipses on a row and click an export operation on the menu.

The following list describes the export commands.

Export Report Information to a Text File

To export information from a Monitor and Trace report to a text file:

Note:

The GUI exports Ladder Diagrams as HTML files.
  1. Access the Monitor and Trace tab.
  2. On the Monitor and Trace page, select a report type.
  3. On the report Summary page for the selected report type, select a report from the list, right-click, and click one of the following:
    • Click Export diagram.
    • Click Export session details.
    • Click Export summary.
    The system downloads the report in a file at the bottom of your screen.