← Back to plugin index

Log Viewer
Description

When configured, enables the Log Viewer, which allows viewing messages from log files.

The available log files as well as their order can be customized here. You may also define a set of filter rules, which can be selected by admins to view specific log messages.

In addition, color schemes can be defined, which highlight specific messages with the selected colors.

Type name
LogViewer
Class
com.airlock.iam.admin.application.configuration.logviewer.LogViewer
May be used by
Adminapp
Properties
Logfiles (logfiles)
Description

The list of log files that will appear in the log viewer.

The order of the log files in this property is used in the Log Viewer as well.

Attributes
Plugin-List
Mandatory
Assignable plugins
Log File
Color Scheme (colorScheme)
Description

Defines color schemes for the Log Viewer. Messages are matched using regular expressions.

If the log line matches more than one pattern, the first matching rule is used. The log level is matched first and then the message text. If no scheme is defined, the following default scheme is used:

  • Error messages (log level "ERROR") are marked red.
  • Warning messages (log level "WARN") are marked yellow.
  • Successful authentication lines are marked green.
Attributes
Plugin-List
Optional
Assignable plugins
Coloring Rule
Initially Selected Log File (initiallySelectedLogFile)
Description

This property serves two purposes:

Firstly, it defines the log file that is selected when the Log Viewer is first opened during a browser session. When reopening the Log Viewer during the same session, the last selected log file is remembered.

Secondly, it defines the log file that is opened when switching to the Log Viewer from the User Activity Tab. In this case, it will always open the file defined by this property.

If left undefined, the first log file in the list is used instead.

Attributes
Plugin-Link
Optional
Assignable plugins
Log File
Log Config Changes (logConfigChanges)
Description

If enabled, the difference between the previously activated configuration and the newly activated configuration gets logged to the Adminapp log file when a configuration is activated in the Config Editor.

For example, if the Radius service port gets changed, the following log message is logged:

<property name="port">1812</property>           <property name="port">1813</property>

Please be aware that enabling this setting has no effect for the current activation, but for future ones.

Attributes
Boolean
Optional
Default value
false
YAML Template (with default values) 

type: LogViewer
id: LogViewer-xxxxxx
displayName: 
comment: 
properties:
  colorScheme:
  initiallySelectedLogFile:
  logConfigChanges: false
  logfiles: