Debugging in Yate

Revision as of 10:12, 16 May 2013

In Yate there are several ways to debug issues and check status of the various modules.

The first step for debugging yate is to log output in a file. Yate also offers modules like rmanager to see debug output in telnet client or msgsniff to dump the Yate messages to output console or log into file.

Debug logged in file

At startup Yate can be started with logging in a file so that you can see the errors in the specified file.

To increase the visible debug level you have to add -v option more than once to the command line or to service start script:

yate -vvvvv -l logfile -d -s -r 

To see what all the other options are please run

yate --help

Debug using rmanager module

This module allows controlling Yate using a simple telnet client.

Debug modules in Yate

• enable debugging and increase the level of debugging:

telnet localhost 5038
debug on 
debug level 10
debug sip level 10

• to colorize the output in console:

color on

• use status to display the state of a module and his parameters:

status

• view logs in console:

logview

Debug external scripts

• see output for scripts in PHP script:

Yate::Output(true);

• stop/start a script, useful when changes are done in a script to reload the code in Yate:

external stop scriptname.php
external start scriptname.php

Debug using msgsniff module

The module will dump the Yate messages to output console or log into file.

By default this module should be loaded but not started. To start this module use the telnet command or configure when yate starts.

Load module msgsniff

Enable module in yate.conf:

[general]
msgsniff=no
modload=no
;Don't forget to load the sniffer module if modload parameter value is 'no'.
[modules]
;for debugging yate
rmanager.yate=yes
msgsniff.yate=yes

Start msgsniff

• Start Yate with logging:

./run -vvvvv -l logfile

• Enable / Disable sniffer in telnet:

The module must be loaded so that you can use this commands from telnet:

telnet 0 5038
;enable sniffer: 
sniffer on
;and disabled with:
sniffer off

Use filters with msgsniff

• Filters can be applied by specifying regex to match in telnet:

sniffer filter ^\(chan\.\|engine\.halt$\)

• or in yate.conf:

[default]
; filtersniff: regexp: Default filter to apply to message sniffer at initialization
; If empty it will match all messages except engine.timer which is never displayed
; Example for a filter matching all chan.Anything messages and engine.halt:
filtersniff=^\(chan\.\|engine\.halt$\)

Compiling Yate with xdebug, ddebug or debug

This is used by developers to test their code, to see information about creating specific objects or if some specific functions are called.

To compile with debug messages when compiling Yate you have to specify:

make xdebug
make ddebug
make debug

When compiling with xdebug, the ddebug messages are included but if ddebug is compiled, xdebug messages are not included.

When compiling with debug symbols of functions are added.

See also

• Starting Yate
• Rmanager
• msgsniff
• Debug Output