Logging

On this dialogue, logging levels for several application topics can be defined.

The log level corresponds to the grade of detail as follows:

  • ERROR:
    Only real application errors (Exceptions) will be logged.
    Example: The text that shall be saved into a database column, is too long for the column.
  • WARN:
    Everything that could lead to program errors and thus is handled by fallback settings.
    Example: The select case does not handle the given value and switches to the default behavior.
  • INFO
    All the information about the system that could be of any interest.
    Example: Information about used JDK version on service start
  • DEBUG
    Brings out information about debug information to debug some specific issues. Usually this logs more than needed in usual conditions.
    Example: Values of several variables on specific moments
  • TRACE
    Lays a trace of breadcrumbs – when has a method been entered, when was it left, which direction did the program take…
    Generates tons of logfiles.
  • ALL
    Everything that can be logged in any way.
    Generates tons of logfiles.
  • OFF

So the level of logging will increase from the top to the bottom.

The loglevels derive the settings from all entries above -> INFO contains WARN and ERROR but no DEBUG information

Runtime configuration Log Level tab

The loglevels of several Java classes can be defined on this tab.

The settings are only transient (in the memory) and will be lost on the next service restart!

List

The list shows the following columns that also can be used for filtering – when the filter mode is activated (button on the right-hand side):

  • Logger:
    Name of the logger that gives information about its origin. Usually it represents a Java classnamme whose properties and events will be logged correspondingly
  • Log-Level:
    The detail grade of the entries that will be logged (see previous section).
  • Process:
    iAGENT processes that use this logger.

After selecting or entering a search criterion, the search will be started immediately. The list may be re-sorted through a click on the header, afterwards. A following click on the currently sorted header switches the sorting direction of this column.

The changed loglevels will be saved after clicking the Save button on top of the dialogue.

Permanent configuration of keys tab

The loglevels of several application topics and the database loglevel can be defined on this tab. The settings of this loggers will permanently be saved in the system and will be applied even after a system restart!

The database loglevel is the first setting above the list.

List

The list shows the following columns that also can be used for filtering – when the filter mode is activated (button on the right-hand side):

  • Key:
    Name of the key that gives information about its origin process / program part. Usually, keys are built featurebased – so their name contains the feature like chat, routing, channels…
  • Log-Level:
    The detail grade of the entries that will be logged (see previous section).

After selecting or entering a search criterion, the search will be started immediately. The list may be re-sorted through a click on the header, afterwards. A following click on the currently sorted header switches the sorting direction of this column.

The changed loglevels will be saved after clicking the Save button on top of the dialogue.

Logfiles tab

The tomcat (tomcat/logs), mail (mail/logs) and other log files configured in the the tab Permanent configuration of keys can be displayed and downloaded through this tab. All available log files (corresponding to the permanently configured loggers) appear in the dropdown list. Their names correspond to a part of the logger names (Logfile: chat.routing.log and corresponding logger log.level.routing.chat).

A click on the Download log file button opens a file save dialogue.

A click on the Show log file button shows the last 500 lines of the selected logfile in the big text field below the button. If you need more than 500 Lines, please download the complete logfile through the tab Download Log-File instead.

Archive tab (as of version 12.17)

Older log files, resulting of the settings on the tab Permanent configuration of keys, can be downloaded here from the past in compressed form (*.zip).

In the first selection list the name of the logfile is selected. Their names correspond to a part of the logger names (Logfile: chat.routing.log and corresponding logger log.level.routing.chat).

The second dropdown opens a dialog to select any time window from which the log files should be downloaded. Under the Interval tab, a dynamic interval which always refers to the current date is entered via the suggestions or the slider. In this case, an icon appears next to the time entry (), indicating the dynamic. Under Calendar, a time frame with fixed dates can be defined.

After selecting a logfile and a time frame, a list with the compressed log files in the selected time fram (one file per day) appears after clicking the Search button. These can then be saved individually via the Download button.