Unblu Server Logging

1.  Introduction

The unblu server uses logging for different purposes. The main log is a general purpose log file that is mostly used for status messages, warnings, errors and debug output (if enabled). The fatal log only contains fatal errors (if any). And the session log is a structured log file that logs information about all collaboration sessions that have taken place.

2. Log files

Unblu writes tree log files, the sections below describe the purpose and contents of each of them.

2.1. Main log file

The main unblu log file is a general purpose log file. All status messages, errors, warnings and debug messages are written to the main log file. By default the main log file is named unblu unblu.<date>.log.

2.2. Session log file

The session log is a structured log file that holds information about all collaboration sessions that have taken place in a JSON (http://en.wikipedia.org/wiki/JSON) based format. By default the session log file is named unblu-session.<date>.log.

For more details about the session log format please read Session Log Output Format.

2.3. Fatal log file

The fatal log is an extract of the general purpose log and only contains fatal errors. If anything is written to the fatal log, this means that the unblu server will most probably not work correctly. By default the fatal log file is named unblu-fatal.<date>.log.

3. Log file rotation

All log files are rotated on a daly basis. This means that in the logging output directory for every log type (main, session, fatal) you will get a file for each day.

By default unblu cleans out old log files for the main and the fatal log files after seven days. Session logs are not deleted automatically.

4. Configuration

The unblu logging system can be configured using configuration settings (see Unblu Server Configuration).

4.1. Output directory

The most important configuration setting regarding logging is "com.unblu.logging.outputDirectory". The "com.unblu.logging.outputDirectory" configuration setting specifies the file system directory unblu logfies should be written to. I no output directory is configured, unblu will write log messages to standard output.

We recommend always setting a logging output directory when installing an unblu server.

4.2. Enabling / disabling fatal or session log

The fatal log can be disabled / enabled using the "com.unblu.logging.fatalLogEnabled" configuration setting.

The session log can be disabled / enabled using the "com.unblu.logging.sessionLogEnabled" configuration setting.

4.3. Log file retention time

How many days log files should be kept can be configured using the following configuration settings:

"com.unblu.logging.mainLogMaxHistory" (com.unblu.logging.mainLogMaxHistory) for the main log.

"com.unblu.logging.fatalLogMaxHistory" (com.unblu.logging.fatalLogMaxHistory) for the fatal log.

"com.unblu.logging.sessionLogMaxHistory" (com.unblu.logging.sessionLogMaxHistory) for the session log.

4.4. Log levels

Unblu logging supports different log levels (ERROR, WARN, INFO and DEBUG). By default the log level for unblu is set to INFO and the log level for integrated third party libraries is set to WARN.

The root level for unblu can be changed using the "com.unblu.logging.rootLevel" configuration setting.

The root level for third party libraries can be changed using the "com.unblu.logging.rootLevelThirdparty" configuration setting.

Log levels for individual loggers (packages or classes can be set using the following notation)

com.unblu.logging.level.<loggerName>=<level>

If for instance the level of the unblu filter (logger name = "com.unblu.review.server.filter" is to be set to DEBUG, the following configuration setting is required:

com.unblu.logging.level.com.unblu.review.server.filter=DEBUG.

4.5. Advanced Configuration

All logging related configuration setting can be found in the logging configuration.

 

How can we help?

Chat with us and we will take you through our site!

Read about how we use cookies and how you can control them by clicking "Cookie Settings." If you continue to use this site, you consent to our use of cookies.