Chapter 37. Debuging Tigase
Prev |  | Next

# Chapter 37. Debuging Tigase

Artur Hefczyc <artur.hefczyc@tigase.net> v2.0, June 2014: Reformatted for AsciiDoc. :toc: :numbered: :website: http://tigase.net :Date: 2010-04-06 21:18

If something goes wrong and you can’t find out why it is not working as you expect you might want more detailed debugging options switched on.

Tigase is a Java application and it uses Java logging library this gives you flexibility to switch logging on for selected java package or even for a single Java class.

Logs files are stored in logs/ directory. tigase-console.log keeps all the data but only basic logs. tigase.log.N files keep all the detailed logging entries. So this is the place where you should look in case of problems.

## The easy way - init.properties file

The easiest way to change logging for the Tigase package is modifying in init.properies following line:

    --debug=server

The line above says: "Switch on ALL debug messages for packet: tigase.server". The tigase.server packet keeps all component’s classes. So it allows you to monitor what is going on in each component. What packets it receives and what it is sending out.

Usually people want to see what is going on the network level. That is what has been sent and what has been received by the server - the actual character data. The class which would print all received and sent character data is: tigase.xmpp.XMPPIOService. To enable all debugging info for this class you have to modify the debug line:

    --debug=xmpp.XMPPIOService

Note, you skip the tigase. part.

You can also have debugging switched on for many packages/classes at the same time:

    --debug=server,xmpp.XMPPIOService

Other packages you might be interested in are:

- tiagse.io and tigase.net which can print out what is going on a very low level network level including TLS/SSL stuff.
- tigase.xml would print the XML parser debugging data.

- tigase.cluster would print all the clustering related stuff. So if you have clustered installation you might be interested in debug settings:

      --debug=server,cluster

- tigase.xmpp.impl would print logs from all plugins loaded to the Tigase server.

and so on…​

This method, however has 2 main disadvantages:

1. You have to remove your XML config file and regenerate it which might be inconvenient. (only applicable to versions before 5.0.0)
2. You can’t set logging this way for classes and packages other than tigase. package. And this might be a problem if you include your own code in and load it into the server.

To enable logging for your own packages from packages different than tigase. you have to use another option which has been made available for this:

    --debug-packages = your.com.package

You can also specify more parameters for the Tigase logging mechanisms like the file size, number of file rotated and location where all Tigase logs are stored. You have to include following lines in the init.properties file:

    basic-conf/logging/java.util.logging.FileHandler.limit=100000000
    basic-conf/logging/java.util.logging.FileHandler.count=20
    basic-conf/logging/java.util.logging.FileHandler.pattern=/var/log/tigase/tigase.log

Prev |  | Next
Configuration | Home | The more difficult but more powerful - tigase.xml file (only applicable to versions before 5.0.0)