Toolpack:Configuring Call Trace A

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(put comment in bold)
 
(12 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
{{DISPLAYTITLE:Configuring Call Trace}}
 
{{DISPLAYTITLE:Configuring Call Trace}}
  
Unique call trace (uct) is designed to trace the path that a call takes through a Tmedia system. It allows an incoming call to be traced and provides information about various aspects of the call path, such as:
+
Call Trace is a diagnostic tool that is designed to trace the path a call takes through a Tmedia system, and to provide information about numerous aspects of the call path, such as:
  
 
* The routing decision
 
* The routing decision
Line 12: Line 12:
 
* The termination result code, and more.  
 
* The termination result code, and more.  
  
A call path is shown as separate call legs to distinguish the incoming portion with other portions of a call. Call trace enables a default of 10,000 call legs to be stored on the system and be directly with the Web Portal.
+
A call path is shown as separate call legs, distinguishing the incoming portion with other portions of a call. Call trace enables a default of 10,000 call legs to be stored on the system and be viewed using the Web Portal.  
 
+
NOTE
+
Older logs can be loaded and viewed on the same system, or exported to other systems. Once a specific call has been consulted, it will remain in memory for a longer period of time, so that it can be consulted later on.
+
  
 
Calls may be filtered by called number, calling number, Network Access Point (NAP), time of day range, protocol and direction.  
 
Calls may be filtered by called number, calling number, Network Access Point (NAP), time of day range, protocol and direction.  
  
'''To Start Call Trace:'''
+
<div class="mw-collapsible mw-collapsed" data-collapsetext="Enabling Call Trace" data-expandtext="Enabling Call Trace" style="width: 400px;">
  
1- Click '''Call Trace''' in the navigation panel
+
'''This section only needs to be done once per system.'''
  
 +
1- Go to the call trace application status
  
[[Image:CreateProfile_0_A.png]]
+
[[Image:ConfigureCallTrace_3_A.png]]
  
 +
[[Image:ConfigureCallTrace_4_A.png]]
  
 +
[[Image:ConfigureCallTrace_5_A.png]]
  
 +
2- Select '''Run''' then press '''Apply States'''
  
 +
[[Image:ConfigureCallTrace_6_A.png]]
  
 +
</div>
  
  
 +
'''Retrieving calls:'''
  
 +
1- Click '''Call Trace''' in the navigation panel
  
  
 +
[[Image:ConfigureCallTrace_0_A.png]]
  
== To start Unique Call Trace<br>  ==
 
 
From the web interface:<br>
 
<pre>Applications -&gt; Instances -&gt; Status tab -&gt; tbuctwriter -&gt; Oam target state [Run]</pre>
 
To modify application configuration (like trace level and memory size):<br>
 
<pre>Applications -&gt; Configurations -&gt; tbuctwriter [Edit]
 
Systems -&gt; Activate Configuration</pre>
 
== To see logs<br>  ==
 
 
From the web interface:
 
<pre>Call Trace</pre>
 
<br>
 
 
== Call Filters<br>  ==
 
 
Calls can be filtered using the following information:<br>
 
  
 +
2- Set various parameters for the call trace, such as
 
*Time and date range  
 
*Time and date range  
 
*Called or calling number  
 
*Called or calling number  
Line 59: Line 50:
 
*Call Duration, Reason Code
 
*Call Duration, Reason Code
  
[[Image:Sample call trace filter.jpg|787x192px]]<br>
 
  
You can then select the call to see and it will display information about the calls.  
+
[[Image:ConfigureCallTrace_1_A.png]]
  
[[Image:Sample Call Trace.jpg|785x515px]]<br>
+
Once you are satisfied with the filter criteria, click '''Apply'''
  
<br>
+
The filter results are displayed.
  
== How to search for calls no longer in Memory  ==
+
3-Select a call in the results window to display further information about the call.
  
The system will store a number of calls in memory and the search can be done directly from the web interface using Call Trace.  
+
[[Image:ConfigureCallTrace_1_A.png]]
  
If the call is no longer in memory you can retrieve the information from the uctdata log files.
 
  
The default file location is here:
 
<pre>/lib/tb/toolpack/setup/12358/2.6/apps/tbuctwriter/uctdata*</pre>
 
First, start [[How_to_use_tbx_cli_tools_remote_program|tbx_cli_tools_remote]], select tbuctwriter
 
  
To know which files are available and the start and end time of each file:  
+
<div class="mw-collapsible mw-collapsed" data-collapsetext="To search for calls that are no longer in memory, do the following:" data-expandtext="Searching for calls that are no longer in memory" style="width: 400px;">
  
*Option 'p' to print all uctdata files on disk
+
By default, the system stores up to 10,000 call legs in memory. If the call is no longer in memory, it may be retrieved by using information from the uctdata log files.
  
To load a file in memory to be seen from Web (live calls continue to be captured to files): <br>  
+
By default the file is located in the following path:  
 +
<pre>/lib/tb/toolpack/setup/12358/2.6/apps/tbuctwriter/uctdata*</pre>  
  
*Option 'o' with the data filename (uctdata*)
+
1- Start [[How_to_use_tbx_cli_tools_remote_program|tbx_cli_tools_remote]]
 +
2- Select tbuctwriter
 +
3- To know which files are available, as well as the start and end time of each file, use the following options:
 +
* 'p' to print all uctdata files on disk
  
Once done, you can go back in the Web portal and select Call Trace from the menu on the left. You can search for calls using the filters. The memory will not be overwritten until you restore normal process.  
+
To load a file into memory for viewing with the Web Portal: <br>
 +
* Option 'o' followed by the data filename (uctdata*)
 +
 
 +
Use the Web Portal to search for calls using the appropriate filter criteria. The memory will not be overwritten until you restore normal process.  
  
 
To restore normal process:<br>  
 
To restore normal process:<br>  
Line 92: Line 85:
 
*Option ‘l’ to have calls put in memory again
 
*Option ‘l’ to have calls put in memory again
  
<br>
+
<br>
 
+
''Note: Unique Call Trace (UCT) is available starting with release 2.6''<br><br>
+

Latest revision as of 15:46, 10 December 2012

Applies to version v2.6

Call Trace is a diagnostic tool that is designed to trace the path a call takes through a Tmedia system, and to provide information about numerous aspects of the call path, such as:

  • The routing decision
  • The outgoing call
  • Subsequent outgoing calls, in the case of a route retry
  • Parameters selected for a SIP SDP
  • The SIP Call-id
  • The trunk and timeslot chosen for TDM protocols
  • The termination result code, and more.

A call path is shown as separate call legs, distinguishing the incoming portion with other portions of a call. Call trace enables a default of 10,000 call legs to be stored on the system and be viewed using the Web Portal.

Calls may be filtered by called number, calling number, Network Access Point (NAP), time of day range, protocol and direction.

This section only needs to be done once per system.

1- Go to the call trace application status

ConfigureCallTrace 3 A.png

ConfigureCallTrace 4 A.png

ConfigureCallTrace 5 A.png

2- Select Run then press Apply States

ConfigureCallTrace 6 A.png


Retrieving calls:

1- Click Call Trace in the navigation panel


ConfigureCallTrace 0 A.png


2- Set various parameters for the call trace, such as

  • Time and date range
  • Called or calling number
  • Network Access Point (NAP)
  • Incoming or outgoing calls
  • Call Duration, Reason Code


ConfigureCallTrace 1 A.png

Once you are satisfied with the filter criteria, click Apply

The filter results are displayed.

3-Select a call in the results window to display further information about the call.

ConfigureCallTrace 1 A.png


By default, the system stores up to 10,000 call legs in memory. If the call is no longer in memory, it may be retrieved by using information from the uctdata log files.

By default the file is located in the following path:

/lib/tb/toolpack/setup/12358/2.6/apps/tbuctwriter/uctdata*

1- Start tbx_cli_tools_remote 2- Select tbuctwriter 3- To know which files are available, as well as the start and end time of each file, use the following options:

  • 'p' to print all uctdata files on disk

To load a file into memory for viewing with the Web Portal:

  • Option 'o' followed by the data filename (uctdata*)

Use the Web Portal to search for calls using the appropriate filter criteria. The memory will not be overwritten until you restore normal process.

To restore normal process:

  • Option ‘c’ to clear memory
  • Option ‘l’ to have calls put in memory again

Personal tools