Howto long-term debug with beroNet's tool "PowerDebug"

From berofix - professional SIP gateway
Jump to: navigation, search
(Starting and stopping a trace)
(What is it ?)
 
Line 1: Line 1:
 
=What is it ?=
 
=What is it ?=
<p>In many cases problems are not reproducable immediately because they are happening not every time. Or, sometimes audio would be needed inside the trace, and therefore the capacity doesn't reach, or, or, or. Like maybe some of you know, beroNet gateways have not much capacity to store traces, that's why often traces are not complete or overwritten with other data, and the sitiuation which was want to be investigated is not included. For all these cases we made "PowerDebug". This tool consists of a server and a client application. The server is written in Java and can run anywhere where a Java VM (JRE) is installed. The client is an App which can be installed on a beroNet gateway. The trace data will be sent from client to server over TCP/IP, and can be stored onto the server which has normally much more storing capacity as the gateway. Long-term debugging is now possible without big efforts.</p><br>
+
<p>In many cases problems are not reproducable immediately because they are happening not every time. Or, sometimes audio would be needed inside the trace, and therefore the capacity doesn't reach, or, or, or. Like maybe some of you know, beroNet gateways have not much capacity to store traces, that's why often traces are not complete or overwritten with other data, and the sitiuation which should be examined is not included. For all these cases we made "PowerDebug". This tool consists of a server and a client application. The server is written in Java and can run anywhere where a Java VM (JRE) is installed. The client is an App which can be installed on a beroNet gateway. The trace data will be sent from client to server over TCP/IP, and can be stored onto the server which has normally much more storing capacity as the gateway. Long-term debugging is now possible without big efforts.</p><br>
  
 
=Prerequisites=
 
=Prerequisites=
Line 24: Line 24:
 
# Enter '''echo %JAVA_HOME%''' to proove if JAVA_HOME variable is set to the directory of your Java VM.
 
# Enter '''echo %JAVA_HOME%''' to proove if JAVA_HOME variable is set to the directory of your Java VM.
 
# If the output is not like the installation directory of your Java VM, open install-service.bat with a text editor and change the "JH" variable to the Java home path.
 
# If the output is not like the installation directory of your Java VM, open install-service.bat with a text editor and change the "JH" variable to the Java home path.
 +
# Change to installation directory:
 +
#: '''cd \path\to\pwerdebug'''
 
# Now execute "install-service.bat" in the command line window (which is running as administrator)
 
# Now execute "install-service.bat" in the command line window (which is running as administrator)
#: '''.\install-service.bat''' <enter>
+
#:''C:\path\powerdebug>'' '''.\install-service.bat''' <enter>
 
# If everything gone well, you should now have a new entry in the windows "Services" manager named "PowerDebug". If you want to remove the service, just execute "uninstall.bat", as administrator too.
 
# If everything gone well, you should now have a new entry in the windows "Services" manager named "PowerDebug". If you want to remove the service, just execute "uninstall.bat", as administrator too.
 
# Select this new entry and start the service
 
# Select this new entry and start the service
Line 34: Line 36:
 
# Last step is to install the client application onto the gateway. For this, you have to login to the gateway first. Go to the menu "Apps->Market", press "upload file" and choose the app-file which is in the directory "apps" which can be found in the installation dirctory of the server application. There must be a file named "powerdebug-<version>-app.tar.gz". Choose this file. After upload you will be asked if you really want to install, choose "yes". After installing the app you should find a new menu entry under "Apps"-menu named "powerdebug". Click this new item and you should be redirected to the powerdebug client gui:  
 
# Last step is to install the client application onto the gateway. For this, you have to login to the gateway first. Go to the menu "Apps->Market", press "upload file" and choose the app-file which is in the directory "apps" which can be found in the installation dirctory of the server application. There must be a file named "powerdebug-<version>-app.tar.gz". Choose this file. After upload you will be asked if you really want to install, choose "yes". After installing the app you should find a new menu entry under "Apps"-menu named "powerdebug". Click this new item and you should be redirected to the powerdebug client gui:  
 
#:[[File:client_gui.png|frameless|300px| ]]
 
#:[[File:client_gui.png|frameless|300px| ]]
Now everything seems to be ready to run.
+
Now everything seems to be ready to run.<br>
 +
<span style="color:#FF0000">'''IMPORTANT:'''</span> '''If you've enabled the Windows Firewall, you have to take care to allow incoming request on TCP ports 2221 and 8888, or, better, just disable firwall as long you make a trace. Otherwise client may not able to connect to server,'''
  
 
=Install PowerDebug as Linux daemon=
 
=Install PowerDebug as Linux daemon=
Line 55: Line 58:
 
=Starting and stopping a trace=
 
=Starting and stopping a trace=
 
To start a trace, follow these steps:
 
To start a trace, follow these steps:
# Log in to the gateway where you've installed the powerdebug app and choos menue item "Apps->powerdebug"
+
# Log in to the gateway where you've installed the powerdebug app and choose menu item "Apps->powerdebug"
 
# Enter the IP address of the machine where you've installed the server application into the field "Server"
 
# Enter the IP address of the machine where you've installed the server application into the field "Server"
 
# Choose technologies which has to be traced with check button group "Protocols to trace", ISDN, Analog, GSM, SIP
 
# Choose technologies which has to be traced with check button group "Protocols to trace", ISDN, Analog, GSM, SIP
Line 66: Line 69:
 
# If you want to stop the trace, just press "Stop" and after a short while, the "ready to start" gui will be appear again with message "STOPPED"
 
# If you want to stop the trace, just press "Stop" and after a short while, the "ready to start" gui will be appear again with message "STOPPED"
 
#:[[File:pd_stopped.png|frameless|300px| ]]
 
#:[[File:pd_stopped.png|frameless|300px| ]]
 
+
<span style="color:#FF0000">'''IMPORTANT:'''</span> '''Please don't start a regular fulltrace while powerdebug is also running a trace. This willl cause more load and incomplete trace on powerdebug-server'''
 
=Where to find the traces=
 
=Where to find the traces=
 
To get a trace file just open the server gui in your prefered browser:
 
To get a trace file just open the server gui in your prefered browser:
Line 98: Line 101:
 
#:Propable port 8888 was already allocated by another app
 
#:Propable port 8888 was already allocated by another app
 
#'''You try to start a trace at the client gui, but get message "Server not responding":'''
 
#'''You try to start a trace at the client gui, but get message "Server not responding":'''
#:Either server is not strated, or problem # 2 perevents reachability, or server is not reachable from the network of the gateway
+
#:Either server is not strated, or Windows Firewall blocks traffic, or problem # 2 prevents reachability, or server is not reachable from the network of the gateway.
 
If you can't solve problems with powerdebug by yourself, just leave a message to support@beronet.com with a sufficient description of your problem.
 
If you can't solve problems with powerdebug by yourself, just leave a message to support@beronet.com with a sufficient description of your problem.

Latest revision as of 16:49, 13 April 2016

Personal tools