Difference between revisions of "Support tools"

From help.aarenet.com
Jump to: navigation, search
Line 1: Line 1:
−
{{DISPLAYTITLE: Aarenet VoIP Switch Support Tools }}
+
{{DISPLAYTITLE: Manual of the Aarenet VoIP Switch Support Tools }}
 
{{PAGE_HEADER}}
 
{{PAGE_HEADER}}
 
{{Page_Menu_List_Help_Support}}
 
{{Page_Menu_List_Help_Support}}
Line 261: Line 261:
  
 
{{Note|
 
{{Note|
−
The "Call Data" is tenant sensitive. This means a supporter of tenant A is not able to see events of tenant B!
+
The "Call Data" is tenant sensitive. This means a supporter/operator of tenant A is not able to see events of tenant B!
 
}}
 
}}
  
Line 283: Line 283:
 
[[file:support_tool_call_data_dialog.png |500px|left|frameless|link=| Dialog: "Call Data" ]]
 
[[file:support_tool_call_data_dialog.png |500px|left|frameless|link=| Dialog: "Call Data" ]]
 
<br clear=all>
 
<br clear=all>
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 289: Line 313:
  
 
{{ToTop | SupportToolConfigCenterRegistration }} <!------------------------------------------------>
 
{{ToTop | SupportToolConfigCenterRegistration }} <!------------------------------------------------>
−
== The ConfigCenter '''Address Registration''' {{Help_Status | | ComingSoon }} ==
+
== The ConfigCenter '''Address Registration''' ==
 +
 
 +
The ConfigCenter "Address Registration" displays if a SIP device or MGCP MTA has registered the telephone number.
 +
The supporter finds the following information of the registering devices:
 +
:* Type of registration, SIP, notifications, presence, etc
 +
:* IP address
 +
:* SIP user agent
 +
:* Registration time left.
 +
 
 +
Registrations can be de-registrated on the VoIP Switch by force.
 +
 
 +
Hint:<br>
 +
The device cannot be informed that it was de-registerd on the VoIP Switch. That means you have to wait until it re-registers automatically or force the device manually to re-register.
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!--------------------------------------------------------------------------------------->
 +
=== Navigate to "Registrations" ===
 +
 
 +
ConfigCenter:
 +
{{Navigation_List | 1 | Menu "Addresses" }}
 +
 
 +
or
 +
{{Navigation_List | 1 | Menu "Accounts" }}
 +
{{Navigation_List | 2 | Click on the line of the desired account }}
 +
{{Navigation_List | 3 | Click on the right arrow at "Addresses" }}
 +
 
 +
 
 +
For details:
 +
{{Navigation_List | 2 | Click on the line of the desired address }}
 +
{{Navigation_List | 3 | Click on the right arrow at "Registration" }}
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!--------------------------------------------------------------------------------------->
 +
=== Interpretation of "Registrations" Information ===
  
−
The ConfigCenter "Address Registration" displays if a SIP device or MGCP MTA has registered the telephone number. The supporter finds information about IP address, SIP User Agent, registration time left.
+
Display of "Addresses" and registration overview:
 +
[[file:support_configcenter_registration_e.png |750px|left|frameless|link=| Dialog: "Addresses & Registration" ]]
 +
<br clear=all>
 +
 
 +
 
 +
By clicking on the line of an address and then the right arrow at "Registration" a dialog pops up, which provides informations of all registrations of the address:
 +
[[file:support_configcenter_registration_details_e.png |750px|left|frameless|link=| Dialog: "Registration Details" ]]
 +
<br clear=all>
  
  
Line 297: Line 365:
  
 
{{ToTop | SupportToolConfigCenterComponent }} <!--------------------------------------------------->
 
{{ToTop | SupportToolConfigCenterComponent }} <!--------------------------------------------------->
−
== The ConfigCenter '''System Components''' {{Help_Status |  | ComingSoon }} ==
+
== The ConfigCenter '''Components''' ==
  
−
The "System Components" displays the state and activity of the VoIP Switch components.
+
The "Components" displays the state and activity of the VoIP Switch components. The components are the entities of the VoIP Switch that provide all functionality and features.
 +
The display is automatically updated every few seconds and shows the actual state and load of every component.
  
 +
{{Note|
 +
On most VoIP Switches the "Components" display is not available for the supporters and operators.
 +
}}
  
  
  
−
{{ToTop | SupportToolConfigCenterChannel }} <!----------------------------------------------------->
 
−
== The ConfigCenter '''Channels''' {{Help_Status |  | ComingSoon }} ==
 
  
−
The ConfigCenter "Channels" displays the state of connections.
+
{{ToTop}} <!--------------------------------------------------------------------------------------->
 +
=== Navigate to "Components" ===
 +
 
 +
ConfigCenter:
 +
{{Navigation_List | 1 | Menu "System" }}
 +
{{Navigation_List | 2 | Menu "Components" }}
 +
 
 +
 
 +
 
 +
 
 +
{{ToTop}} <!--------------------------------------------------------------------------------------->
 +
=== Interpretation of "Components" Information ===
 +
 
 +
Display of "Components":
 +
[[file:support_configcenter_components_general_e.png |500px|left|frameless|link=| Dialog: "Components" ]]
 +
<br clear=all>
 +
 
 +
 
 +
By clicking on the line of a component a dialog pops up, which provides more informations or enables to send messages or handle the work load of the component:
 +
[[file:support_configcenter_components_component_detail_e.png |750px|left|frameless|link=| Dialog: "Component Details" ]]
 +
<br clear=all>
 +
 
 +
 
  
  
 +
{{ToTop | SupportToolConfigCenterChannel }} <!----------------------------------------------------->
 +
== The ConfigCenter '''Channels''' ==
  
 +
The ConfigCenter "Channels" is a live display of the current active connections and connection build-up. The administrator can filter an search the connections. If needed a connection can be forced to be released.
 +
 +
{{Note|
 +
On most VoIP Switches the "Channels" display is not available for the supporters and operators.
 +
}}
  
  
Line 316: Line 415:
  
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
−
=== Navigate to the "Channels" ===
+
=== Navigate to "Channels" ===
  
 
ConfigCenter:
 
ConfigCenter:
 
{{Navigation_List | 1 | Menu "Channels" }}
 
{{Navigation_List | 1 | Menu "Channels" }}
−
 
  
  
Line 326: Line 424:
  
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
−
=== Get the "Channels" ===
+
=== Interpretation of "Channels" Information ===
  
−
Dialog: "System Utilization":
+
Display of "Channels":
−
[[file:support_configcenter_channels_e.png |500px|left|frameless|link=| Dialog: "Channles" ]]
+
[[file:support_configcenter_channels_e.png |750px|left|frameless|link=| Dialog: "Channles" ]]
 
<br clear=all>
 
<br clear=all>
−
 
−
 
  
  
Line 340: Line 436:
 
== The ConfigCenter '''System Utilization'''  ==
 
== The ConfigCenter '''System Utilization'''  ==
  
−
The "System Utilization" gives a statistical overview of the VoIP Switch resource utilization.
+
The "System Utilization" gives a statistical overview of the VoIP Switch resource utilization:
 +
:* Number of accounts
 +
:* Number of addresses (telephone numbers)
 +
:* Number of registrations
 +
:* etc
  
  
 
{{Note|
 
{{Note|
−
On most VoIP Switches the "System Utilization" is not available for the supporters and operators.
+
On most VoIP Switches the "System Utilization" display is not available for the supporters and operators.
 
}}
 
}}
  
Line 351: Line 451:
  
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
−
=== Navigate to the "System Utilization" ===
+
=== Navigate to "System Utilization" ===
  
 
ConfigCenter:
 
ConfigCenter:
Line 361: Line 461:
  
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
 
{{ToTop}} <!--------------------------------------------------------------------------------------->
−
=== Get the "System Utilization" ===
+
=== Interpretation of the "System Utilization" Information ===
  
−
Dialog: "System Utilization":
+
The "System Utilization" provides the numbers of used resources:
 
[[file:support_configcenter_system_utilization_e.png |500px|left|frameless|link=| Dialog: "System Utilization" ]]
 
[[file:support_configcenter_system_utilization_e.png |500px|left|frameless|link=| Dialog: "System Utilization" ]]
 
<br clear=all>
 
<br clear=all>

Revision as of 12:58, 1 September 2017


Note The features and/or parameters listed in this article may not be available from your telephone service provider.



Home Support

 

 

Download PDF

 



Introduction

The VoIP Switch Administrators, Operators, Supporters find here information about the Aarenet VoIP Switch "On Board" tools for analyzing and supporting general VoIP Switch issues and customer problems:

  • The ConfigCenter "Support Log" displays the VoIP Switch internal activities
  • The ConfigCenter "Traces" displays the signaling between the VoIP Switch an external devices
  • The ConfigCenter "Call Data" lists the CDR of all incoming or outgoing connections or connection attempts. The "Call Data" provide shortcuts to SIP, SDP trace and RTP statistic information of a single call.
  • The ConfigCenter "Address Registration" displays if a SIP device or MGCP MTA has registered a telephone number
  • The ConfigCenter "System Components" displays the state and activity of the VoIP Switch components
  • The ConfigCenter "Channels" displays the state of connections
  • The ConfigCenter "System Utilization" displays a statistical overview of the VoIP Switch resource utilization




→ Top

VoIP Switch ConfigCenter Support Tools


→ Top

The ConfigCenter Support Log

The "Support Log" provides the supporter with information from the internal processes of the ServiceCenter:

  • Registration
  • Connection setup, release and exceptions
  • Call Routing
  • Used Ruleset
  • Emergency calls
  • etc


The "Support Log" provides filters for:

  • Time based selection: From – Until, From – Duration
  • Text filter
  • Registration events
  • Call events
  • etc.


The "Support Log" has a limited history. The history may last from a few hours up to some days. The length of the history may be different from VoIP switch to VoIP switch and depends on the length of log files and amount of logging events.


Note

The "Support Log" is tenant sensitive. This means a supporter of tenant A is not able to see events of tenant B!





→ Top

Navigate to the "Support Log"

ConfigCenter:

nav Menu "Support"
nav Menu "Support Log"




→ Top

Get a "Support Log"

Dialog: "Support Log":

Dialog: Support Log



When the dialog "Support Log" opens it contains by default in "From" the actual date/time (-5min) and in "Duration" a duration of 5min:

  1. Click the Button [ Download ]
  2. Via HTTP an ASCII formatted file with the last 5 minutes will be downloaded


Retrieving a "Support Log" in the past:

  1. Insert the in "From" the desired start date/time
  2. Insert in "Duration" the needed length
  3. Press on the PC keyboard the 'Enter' key : The "Until" date/time will be computed
  4. Click the Button [ Download ]

or

  1. Insert the in "From" the desired start date/time
  2. Insert the in "Until" the desired stop date/time
  3. Press on the PC keyboard the 'Enter' key: The "Duration" will be computed
  4. Click the Button [ Download ]


Best Practice

Get the events of a connection in the past:

  1. Search the Call ID of the connection in the "Call Data"
  2. Use the Call ID in the "Text" filter of the Support Log dialog
  3. Make sure that the connection date/time match "From"- "Until"
  4. Download the Support Log


Get the events of a just finished connection:

  1. Set the "Duration" to 5min (or shorter)
  2. Download the Support Log
  3. Search for the connection





→ Top

Interpretation of a "Support Log"

The interpretation of a "Support Log" is quite easy and straight forward. With a little experience one will be soon familiar with the interpretation.

Interpretation and example of a call setup and release:

Example Support Log





→ Top

ConfigCenter Trace

The "Trace" provides the supporter with information from the message traffic between the VoIP switch and external VoIP devices, such as PSTN gateway, SIP CPE, SIP or MGCP telephones.

The "Trace" contains:

  • Session Initiation Protocol SIP registration and connection signaling messages
  • Media Gateway Control Protocol MGCP audit and endpoint control messages
  • Session Description Protocol SDP streaming media initialization parameters


The "Trace" provides filters for:

  • Time based selection: From – Until, From – Duration
  • Text filter


The "Trace" has a limited history. The history may last from a few hours up to some days. The length of the history may be different from VoIP switch to VoIP switch and depends on the length of log files and amount of logging events.


The interpretation of a "Trace" (PCAP formatted file) has to be done in an external application like Wireshark network protocol analyzer. Wireshark offers deep and rich VoIP analysis .


Note

The "Trace" is not tenant sensitive. This means a supporter of tenant A is able to see signaling messages of tenant B!

Due to this open display of information it may be possible that the "Trace" is not available for the supporters and operators on a multi tenant VoIP Switch.





→ Top

Navigate to the "Trace"

ConfigCenter:

nav Menu "Support"
nav Menu "Trace"




→ Top

Get a "Trace"

Dialog: "Trace":

Dialog: Trace



When the dialog "Trace" opens it contains by default in "From" the actual date/time (-5min) and in "Duration" a duration of 5min:

  1. Click the Button [ Download ]
  2. Via HTTP an PCAP formatted file with the last 5 minutes will be downloaded


Retrieving a "Trace" in the past:

  1. Insert the in "From" the desired start date/time
  2. Insert in "Duration" the needed length
  3. Press on the PC keyboard the 'Enter' key: The "Until" date/time will be computed
  4. Click the Button [ Download ]

or

  1. Insert the in "From" the desired start date/time
  2. Insert the in "Until" the desired stop date/time
  3. Press on the PC keyboard the 'Enter' key: The "Duration" will be computed
  4. Click the Button [ Download ]


Best Practice

Get the events of a connection in the past:

  1. Search the connection in the "Call Data"
  2. Click the Button [ Trace ]


Get the events of a just finished connection:

  1. Set the "Duration" to 5min (or shorter)
  2. Download the Trace
  3. Search for the connection





→ Top

Interpretation of a "Trace"

The interpretation of a "Trace" needs experience!

For more information:


Example of a Wireshark call capture, SIP setup and release:

Example "Trace"



Example of a Wireshark call list:

Navigate in Wireshark:

nav Menu "Statistics"
nav Menu "VoIP Calls"


Wireshark dialog where all calls are listed of the actual trace:

Example Trace VoIP Call List



Example of a Wireshark call flow:


Navigate in Wireshark:

nav Menu "Statistics"
nav Menu "VoIP Calls"
nav Select the call of interest
nav Click Button [ Graph ]


Wireshark dialog where the message flow is shown of the selected call:

Example Trace VoIP Call Flow





→ Top

The ConfigCenter Call Data

The "Call Data" lists the CDR of all incoming or outgoing connections or connection attempts. Extended filters enable the supporter to search for specific calls.


The "Call Data" has a limited history. The length of the history may be different from VoIP switch to VoIP switch and depends on the CDR storage length in the date base.


Note

The "Call Data" is tenant sensitive. This means a supporter/operator of tenant A is not able to see events of tenant B!





→ Top

Navigate to the "Call Data"

ConfigCenter:

nav Menu "Rating"
nav Menu "Call Data"




→ Top

Get a "Call Data"

Dialog: "Call Data":

Dialog: "Call Data"

















→ Top

The ConfigCenter Address Registration

The ConfigCenter "Address Registration" displays if a SIP device or MGCP MTA has registered the telephone number. The supporter finds the following information of the registering devices:

  • Type of registration, SIP, notifications, presence, etc
  • IP address
  • SIP user agent
  • Registration time left.

Registrations can be de-registrated on the VoIP Switch by force.

Hint:
The device cannot be informed that it was de-registerd on the VoIP Switch. That means you have to wait until it re-registers automatically or force the device manually to re-register.




→ Top

Navigate to "Registrations"

ConfigCenter:

nav Menu "Addresses"

or

nav Menu "Accounts"
nav Click on the line of the desired account
nav Click on the right arrow at "Addresses"


For details:

nav Click on the line of the desired address
nav Click on the right arrow at "Registration"




→ Top

Interpretation of "Registrations" Information

Display of "Addresses" and registration overview:

Dialog: "Addresses & Registration"



By clicking on the line of an address and then the right arrow at "Registration" a dialog pops up, which provides informations of all registrations of the address:

Dialog: "Registration Details"





→ Top

The ConfigCenter Components

The "Components" displays the state and activity of the VoIP Switch components. The components are the entities of the VoIP Switch that provide all functionality and features. The display is automatically updated every few seconds and shows the actual state and load of every component.


Note

On most VoIP Switches the "Components" display is not available for the supporters and operators.





→ Top

Navigate to "Components"

ConfigCenter:

nav Menu "System"
nav Menu "Components"




→ Top

Interpretation of "Components" Information

Display of "Components":

Dialog: "Components"



By clicking on the line of a component a dialog pops up, which provides more informations or enables to send messages or handle the work load of the component:

Dialog: "Component Details"





→ Top

The ConfigCenter Channels

The ConfigCenter "Channels" is a live display of the current active connections and connection build-up. The administrator can filter an search the connections. If needed a connection can be forced to be released.


Note

On most VoIP Switches the "Channels" display is not available for the supporters and operators.





→ Top

Navigate to "Channels"

ConfigCenter:

nav Menu "Channels"




→ Top

Interpretation of "Channels" Information

Display of "Channels":

Dialog: "Channles"





→ Top

The ConfigCenter System Utilization

The "System Utilization" gives a statistical overview of the VoIP Switch resource utilization:

  • Number of accounts
  • Number of addresses (telephone numbers)
  • Number of registrations
  • etc


Note

On most VoIP Switches the "System Utilization" display is not available for the supporters and operators.





→ Top

Navigate to "System Utilization"

ConfigCenter:

nav Menu "System"
nav Menu "Utilization"




→ Top

Interpretation of the "System Utilization" Information

The "System Utilization" provides the numbers of used resources:

Dialog: "System Utilization"




→ Top

© Aarenet Inc 2018

Version: 3.0     Author:  Aarenet     Date: May 2017

Retrieved from "http://help.aarenet.com/mediawiki/index.php?title=Support_tools&oldid=1083"