Logging

Modified on Wed, 19 Jul, 2023 at 5:00 PM

This sections allows you to configure how and when events should be logged.

The logging settings can be modified even while the application is running, it does not need to be restarted.

When you want to run an error analysis, you can change the logging level or logging files temporarily

Contents

Log messages let you trace processes and analyse errors. Each Java class has got its own logger. This makes it possible to freely configure which log messages should be logged and which should be suppressed.

A logging configuration always consists of a logging configuration and a logging target.

For each logging configuration, you can set the desired logging level and which log messages you want to be included.

Setup a logging target to define where you want the log message to be written to (file or console). A logging targets also lets you change or configure how the log messages are formatted.

Setup

Add new logger: Adds a new logging configuration to the available logging configurations.
Add new logging target configuration: Adds a new logging target to the available logging targets.
Edit: Open the screen for editing the configuration of loggers or logging targets.
Delete: Deletes the selected logging configuration or target.

The root logging configuration cannot be deleted. Logging targets cannot be deleted while they are still in use by some logging configuration.

Logging configuration

A logger is responsible for collection log messages. To restrict which log messages should be included, you can set both a log level as well as the package path.

Name or path of package: Defines the name of a class or Java package path whose output should be logged.
Level: The logging level. Available levels are, in order of increasing severity: ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF. When you select a certain severity level, all log messages with a higher severity are logged as well.
Log output: The logging target that should be used for this logger.
Pass on log scope to root logger: This allows you to pass on the log scope to the root logger. That is, the log messages will be logged by both this logger as well as the root logger.

Logging target

Writing log messages to the console. This uses the same console that was used to start the application server.

Writing log messages to a file. You may choose any arbitrary path on the file system. Also, you may want to set a limit for the log file size, or you risk exceeding the available disk space of the server.

Type: The type of output. Available types are console (writes log messages to the console) and rolling file (writes log messages to a file).
Name: Unique name for this logging target. Two logging target cannot have the same name.
Log level limit: Sets a limit for the logging level of this logging target. Available limits are: No limit, DEBUG, INFO/, WARN, ERROR, FATAL
Layout type: Sets the format of the log output. Currently, only the so-called pattern layout is supported. The pattern currently in use is shown in the input field.

The following settings apply only to logging target of type rolling file.

The path must exists on the file system and the user running the FORMCYCLE application (or application server) must have write appropriate rights for that path.

File: Path to the log file.
Maximum file size: The maximum file size for an individual log file. When that size has been reached, a new log file will be created.
Maximal number of backup files: The maximum number of backup files that will be created. When this limit has been reached, the oldest backup file will be deleted.

Download log files

You can find two icons next to each logging target that writes to a file. These icons lets you download the log file directly via your browser.This can be helpful when you need to access the log files but do not have immediate access to the server. The left icon lets you download the most recent log file, the right icon lets you download all log files as a ZIP file.