Skip to main content

Logger in Xentral

Written by Adrian Berger

Loggers are responsible for automatically logging events and status information during the operation of Xentral. The logged events and information are for example system messages, error messages, or status messages. In this article, you will get a brief overview of the loggers in Xentral.

The following sections describe the different loggers available.

​

Log File

This is the system log. The log file is stored as a file on the server and can be used by engineers for debugging purposes, if necessary. The Log File module (Logviewer) reads the log file and makes the information visible to the user in Xentral. The logger is always active and does not need to be activated. In the settings (Log File > Settings) you can choose which types of log levels should be displayed.

Here is a short overview of the log levels

Log level

Description

Warning

Exceptional events that are not errors.

  • Things that do not yet exist but may become problems in the future

  • Use fallback scenario due to incomplete configuration

  • Poor performance

  • In addition to a warning message on the screen, a warning log message could appear

It works like this, but it’s not ideal - you should change that.

Notice

Notable events that allow you to understand a user’s intent.

  • No technical details or dumps!

  • Max. one per user action

  • A cronjob started/finished

  • e.g. "User XY has created a new lead."

What the user tried to do before the application crashed.

Info

Frequent events that describe a user’s intent in more detail.

  • More detailed form of NOTICE.

Can be useful to reproduce the exact actions of the user.

Error

Catchable error that does not interrupt the application.

Error log messages should give the developer an indication of where to look for a problem.

  • Temporary problem

  • Error response from another API

  • Error that could be fixed by the user

  • An error log message could appear on the screen together with an "error" message

  • Can be fixed after reloading the page

This information should at least appear in the log when an error is reported.

Emergency

An emergency error should result in the customer calling support for "emergency issue".

  • Immediate action required

  • Threat of data loss

  • Software is no longer executable

  • Only an experienced system administrator or our support can solve the problem

The last call for help before the application dies.

Debug

Detailed debug information.

  • Trace the code line by line if necessary

  • Variable dumps

  • Technical information

I don’t want to debug their production system, so I tell them to turn on the DEBUG level and send me the log.

Critical

Unhandled/unknown errors and bugs that cause software to stop working.

Ideally, all CRITICALs should be converted to ERRORs over time.

  • Component or dependency missing

  • Unhandled exception (exception error page)

  • Single page/module/cronjob cannot work permanently

Something about this module is permanently broken - developer’s attention required.

Alert

Use notification in cases where an administrator wants to be notified by email or SMS.

  • Less serious than an emergency

  • Problem is persistent

  • The system administrator can fix the problem

  • e.g. database cannot be connected

  • e.g. userdata has no more memory

Hey DevOps, you need to fix this! Otherwise, some/many people will not be able to work.

​

Protocol

This is a list of actions performed by the logged-in user in Xentral. It can be viewed via the Log module.

​

Outgoing Mail Log

The outgoing mail log is a logger for all sent mails and errors. You can get more information here.

​

System log

The system’s log file contains various relevant information.

​

System Health

The System Health logger displays the "health status" of the system. If the system detects inconsistencies at various points, such as duplicate numbers, errors when executing process starters, a full memory, etc., a warning or error message is generated in the System Health overview. More information about the module can be found here.

Did this answer your question?