Logging konfigurieren

Logging-Datenbank-Verbindung in der Datei logsDBConfig.xml konfigurieren

Konfigurationsdatei (<connection>-Block)

<?xml version="1.0" encoding="ISO-8859-1"?>
<LogsDatabaseConfig>
    <connection>
    <driver>org.h2.Driver</driver>
    <url>jdbc:h2:${ibis.root.directory}/log/dbh2/logs;MVCC=TRUE</url>
    <!-- Encrypted password and/or user name
        To get your encrypted password and/or user name use the CLI client.
        Example:
        cd path/to/inubit_installation/server/process_engine/bin
        ./startcli.sh -\-encryptString myPassword
        Insert the encrypted password and/or user name as values into the corresponding tags and set the
        attribute encrypted="false" to encrypted="true".
        Example:
        <user encrypted="true">AES-ZKEFCtfXeLAmklzd2zomyA==</user>
        <password encrypted="true">AES-ZKEFCtfXeLAmGUdQ2zomyA==</password>
    -->
    <user encrypted="false">sa</user>
    <password encrypted="false"></password>
    <shutdownCommand>SHUTDOWN</shutdownCommand>
    <checkValidConnection>true</checkValidConnection>
    <minPoolSize>1</minPoolSize>
    <maxPoolSize>100</maxPoolSize>
    <checkoutTimeoutInMillisecs>120000</checkoutTimeoutInMillisecs>
    <maxAgeInMillisecs>3600000</maxAgeInMillisecs>
    <noOfRetries>3</noOfRetries>
    <retryInterval>2000</retryInterval>
    <removeAbandoned>false</removeAbandoned>
    <removeAbandonedTimeout>60</removeAbandonedTimeout>
  </connection>
  <blockInsertSize>2000</blockInsertSize>
  <maxQueueLogSize>200000</maxQueueLogSize>
...
</LogsDatabaseConfig>

Ort der Konfigurationsdatei

Die Konfigurationsdatei logsDBConfig.xml befindet sich in folgendem Ordner: <inubit-installdir>/inubit/server/ibis_root/conf

Properties

Sie können die folgenden Verbindungs-Properties in der Datei logsDBConfig.xml konfigurieren:

Property Beschreibung

<driver>

Datenbank-Treiberklasse

<url>

URL der Datenbank

Für MySQL vor der Version 5.7 ist es nur möglich, über TLS 1.2 zu kommunizieren, wenn Sie die Property enabledTLSProtocols=TLSv1.2 der Datenbank-URL hinzufügen.

<user encrypted="{true|false}">

Benutzername

Attribut encrypted="true":
Der angegebene Benutzername ist verschlüsselt.

Attribut encrypted="false":
Der angegebene Benutzername ist nicht verschlüsselt und wird beim ersten Start des Servers durch den verschlüsselten Benutzernamen ersetzt.
Das Attribut encrypted="true" wird automatisch gesetzt.

Siehe Benutzernamen und Passwörter über das CLI verschlüsseln

<password encrypted="{true|false}">

Passwort

Attribut encrypted="true":
Das angegebene Passwort ist verschlüsselt.

Attribut encrypted="false":
Das angegebene Passwort ist nicht verschlüsselt und wird beim ersten Start des Servers durch das verschlüsselte Passwort ersetzt.

Das Attribut encrypted="true" wird automatisch gesetzt.
Siehe Benutzernamen und Passwörter über das CLI verschlüsseln

<checkValidConnection>

Wenn diese Property auf true gesetzt ist, wird im Falle einer ungültigen Verbindung die nächste Verbindung aus dem Pool automatisch ausgewählt. Standardmäßig ist diese Property auf true gesetzt. Zum Deaktivieren der Property setzen Sie sie auf false.

Das Setzen dieser Property auf true kann die Leistung leicht beeinträchtigen.

<minPoolSize>

Diese Property legt fest, wie viele Datenbankverbindungen mindestens verwendet werden müssen.

Der Standardwert ist 1.

<maxPoolSize>

Diese Property legt fest, wie viele Datenbankverbindungen maximal gleichzeitig verwendet werden können.

Der Standardwert ist 100.

<checkoutTimeoutInMillisecs>

Diese Property legt das Timeout für das Warten auf die Bereitstellung einer Datenbankverbindung für den Datenbankverbindungs-Pool fest.

Der Standardwert ist 120000 ms (2 Minuten).

<maxAgeInMillisecs>

Diese Property legt fest, wie lange der Pool maximal warten soll, bis eine Verbindung daraus bezogen wird.

Der Standardwert ist 3600000 ms (60 Minuten)

<retryInterval> <noOfRetries>

Im Falle eines Datenbankfehlers kann die Abfrageausführung für eine Anzahl <noOfRetries> erneut versucht werden. Jeder Wiederholungsversuch erfolgt nach einer Verzögerungszeit <retryInterval> (in Millisekunden).

Das Aktivieren dieser Property kann die Leistung leicht beeinträchtigen.

Für die Behandlung von Deadlock-Fehlern sind die Standardwerte wie folgt festgelegt:

<retryInterval>: 2000 (2 Sekunden)
<noOfRetries>: 3 Wiederholversuche

<removeAbandoned>

Zum Entfernen unbenutzter Datenbankverbindungen.

Mögliche Werte:

true
Eine Datenbankverbindung wird entfernt, wenn die in der Property removeAbandonedTimeout gesetzte Zeitspanne überschritten ist.
false (Standard)
Datenbankverbindungen werden nicht entfernt, auch wenn sie längere Zeit nicht benutzt wurden.

<removeAbandonedTimeout>

Zum Setzen der Zeitspanne, nach der unbenutzte Datenbankverbindungen entfernt werden.

Wenn die Property removeAbandoned auf true gesetzt ist, wird eine Datenbankverbindung entfernt, sobald die in der Property removeAbandonedTimeout gesetzte Zeitpanne in Sekunden überschritten ist.

Standardmäßig ist die Property removeAbandonedTimeout auf 21600 Sekunden (6 Stunden) gesetzt.

Der Wert sollte auf die Zeitspanne gesetzt werden, die die am längsten dauernde Anfrage benötigt.

<blockInsertSize>

Diese Property enthält die Konfiguration für die Anzahl der in einem Batch zu verarbeitenden Inserts in die Datenbank. Der Standardwert ist 2000. Sobald die Anzahl der Inserts der Blocking Queue den Wert von blockInsertSize erreicht, sendet das System ein Commit-Signal an die Datenbank und bestätigt alle Datensätze in der Datenbank.

<maxQueueLogSize>

Diese Property beschreibt die maximale Anzahl der Einträge in der Blocking Queue. Standardwert ist 200000.

Im Falle eines neuen Logging Ereignisses werden alle dazugehörigen Datensätze zuerst in die Blocking Queue geschrieben. Sobald die Anzahl der Datensätze in der Blocking Queue den Wert von blockInsertSize erreicht, werden die Datensätze nacheinander synchron aus der Blocking Queue zur Datenbank hinzugefügt.

Falls die Blocking Queue weniger als blockInsertSize Datensätze enthält, wird die tatsächliche Gesamtzahl der Datensätze (< blockInsertSize) synchron von der Blocking Queue zusammen mit dem Commit-Signal an die Datenbank gesendet. Auf diese Weise werden die Datensätze dauerhaft in die Datenbank übertragen.

nullCatalogMeansCurrent

Nur für MySQL 8: Wenn ein Datenbankbenutzer Zugriff auf mehrere Schemas hat: Fügen Sie den zusätzlichen Parameter nullCatalogMeansCurrent=true der Datenbank-URL hinzu (nicht empfohlen).

Audit Logs konfigurieren

Speicherort der Log-Datei

Die Log-Datei wird im Verzeichnis <inubit-installdir>/inubit/server/ibis_root/log gespeichert.

Verwendung

Siehe Audit Log: Benutzeraktionen überwachen.

Die Audit Logs werden sowohl in der Workbench als auch in einer Konfigurations-Datei konfiguriert.

Aufruf

INUBIT Workbench > Administration > Allgemeine Einstellungen > Monitoring > Audit

Option Erläuterung

Option	Erläuterung
Maximale Größe der Audit Log-Datei	Angabe in KB. Wird diese Größe erreicht, wird die aktuelle Audit Log-Datei `audit.log` geschlossen und archiviert. Dazu wird sie mit einer laufenden Nummer versehen, z.B. `audit.log.5`.
Anzahl Backups der Audit Log-Dateien	Angabe, wie viele Dateien maximal zur Archivierung der Datei `audit.log` angelegt werden sollen.

Maximale Größe der Audit Log-Datei

Angabe in KB.
Wird diese Größe erreicht, wird die aktuelle Audit Log-Datei audit.log geschlossen und archiviert. Dazu wird sie mit einer laufenden Nummer versehen, z.B. audit.log.5.

Anzahl Backups der Audit Log-Dateien

Angabe, wie viele Dateien maximal zur Archivierung der Datei audit.log angelegt werden sollen.

Konfiguration

In der Datei <inubit-installdir>/inubit/server/ibis_root/conf/logsDBConfig.xml können Sie

die Anzahl der Tage begrenzen für die Logeinträge gespeichert werden sollen.
die Anzahl der Audit-Log-Einträge mithilfe der Elemente <minimumLimitAuditLog> und <maximumLimitAuditLog> konfigurieren.

Siehe INUBIT-Monitoring-Datenbank austauschen.

Element Erläuterung

<maximumLimitDaysAuditLog>

Einträge werden für die angegebene Anzahl von Tagen gespeichert.

0

Einträge werden gespeichert, bis der im Parameter maximumLimitAuditLog konfigurierte Wert erreicht ist. Ist der Wert erreicht, werden die ältesten Einträge gelöscht bis die Anzahl der Einträge den im Parameter minimumLimitAuditLog konfigurierten Wert erreicht hat.
1

Während des mitternächtlichen Aufräumprozesses werden alle Einträge gelöscht, die älter als ein Tag sind. Die für die Parameter minimumLimitAuditLog und maximumLimitAuditLog gesetzten Werte werden ignoriert.
> 1

Während des mitternächtlichen Aufräumprozesses werden alle Einträge gelöscht, die älter als die konfigurierte Anzahl von Tagen sind. Die für die Parameter minimumLimitAuditLog und maximumLimitAuditLog gesetzten Werte werden ignoriert.

Die Startzeit für den mitternächtlichen Aufräumprozess können Sie ändern.

Siehe Startzeit für die mitternächtlichen Aufräumprozesse festlegen.

<minimumLimitAuditLog>

minimale Anzahl von Einträgen

Wenn der Parameter maximumLimitDaysAuditLog auf einen Wert > 0 gesetzt ist, wird der Parameter minimumLimitAuditLog ignoriert.

<maximumLimitAuditLog>

maximale Anzahl von Einträgen

Ist der Wert maximumLimitAuditLog erreicht, werden die ältesten Einträge gelöscht bis die Anzahl der Einträge den im Parameter minimumLimitAuditLog konfigurierten Wert erreicht hat.

Wenn der Parameter maximumLimitDaysAuditLog auf einen Wert > 0 gesetzt ist, wird der Parameter maximumLimitAuditLog ignoriert.

Setzen Sie <minimumLimitAuditLog> und <maximumLimitAuditLog> auf 0, um das Zähler-basierte Löschen auszuschalten.

System Log konfigurieren

Speicherort für Log-Einträge

Die Log-Einträge werden in der INUBIT-Datenbank gespeichert, siehe Datenbanken konfigurieren.

Verwendung

Siehe System Log.

Konfiguration

In der Datei <inubit-installdir>/inubit/server/ibis_root/conf/logsDBConfig.xml können Sie

die Anzahl der Tage begrenzen für die Logeinträge gespeichert werden sollen.
die Anzahl der System Log-Einträge mithilfe der Elemente <minimumLimit> und <maximumLimit> konfigurieren.

Siehe INUBIT-Monitoring-Datenbank austauschen.

Element Erläuterung

<maximumLimitDays>

Einträge werden für die angegebene Anzahl von Tagen gespeichert.

0

Einträge werden gespeichert, bis der im Parameter maximumLimit konfigurierte Wert erreicht ist. Ist der Wert erreicht, werden die ältesten Einträge gelöscht bis die Anzahl der Einträge den im Parameter minimumLimit konfigurierten Wert erreicht hat.
1

Während des mitternächtlichen Aufräumprozesses werden alle Einträge gelöscht, die älter als ein Tag sind. Die für die Parameter minimumLimit und maximumLimit gesetzten Werte werden ignoriert.
> 1

Während des mitternächtlichen Aufräumprozesses werden alle Einträge gelöscht, die älter als die konfigurierte Anzahl von Tagen sind. Die für die Parameter minimumLimit und maximumLimit gesetzten Werte werden ignoriert.

Die Startzeit für den mitternächtlichen Aufräumprozess können Sie ändern. Siehe Startzeit für die mitternächtlichen Aufräumprozesse festlegen.

<minimumLimit>

minimale Anzahl von Einträgen

Wenn der Parameter maximumLimitDays auf einen Wert > 0 gesetzt ist, wird der Parameter minimumLimit ignoriert.

<maximumLimit>

maximale Anzahl von Einträgen

Ist der Wert maximumLimit erreicht, werden die ältesten Einträge gelöscht bis die Anzahl der Einträge den im Parameter minimumLimit konfigurierten Wert erreicht hat.

Wenn der Parameter maximumLimitDays auf einen Wert > 0 gesetzt ist, wird der Parameter maximumLimit ignoriert.

Setzen Sie <minimumLimit> und <maximumLimit> auf 0, um das Zähler-basierte Löschen auszuschalten.

Server Trace Log aktivieren und konfigurieren

Speicherort der Log-Datei

Die Log-Datei trace.log wird im Verzeichnis <inubit-installdir>/inubit/server/ibis_root/log gespeichert.

Verwendung

Siehe Server Trace Log: Server Traces anzeigen.

Aufruf

INUBIT Workbench > Administration > Allgemeine Einstellungen > Monitoring >Trace

Option Erläuterung

Server Trace

Zum Aktivieren/Deaktivieren der Server Traces.

Aktivieren Sie diese Option nur für eine Fehleranalyse, um Performance-Probleme zu vermeiden.

Trace Level

DEBUG: Allgemeines Debugging mit Meldungen, die für den Softwareentwickler interessant sind (Methode DiesUndDas wurde mit Parameter SoUndSo aufgerufen).
INFO: Hinweise, z.B. Programm gestartet, Programm beendet, Verbindung zu Host Foo aufgebaut, Verarbeitung dauerte x Sekunden).
WARN: Auftreten einer unerwarteten Situation, die den Betrieb wahrscheinlich nicht beeinträchtigt.
ERROR: Fehlermeldungen, wie z.B. Exception wurde gefangen. Bearbeitung wurde alternativ fortgesetzt, auf die ein Administrator reagieren muss.
FATAL: Schwerwiegender Fehler, die zum Programmabbruch führen.

Maximale Größe der Trace Log-Dateien

Wenn die angegebene Größe erreicht ist, dann wird die aktuelle Datei trace.log mit einer laufenden Nummer versehen und gespeichert.

Anzahl Backups der Trace Log-Dateien

Angabe, wie viele Dateien maximal zur Archivierung der Datei trace.log angelegt werden sollen.

Individuelles Server-Trace

Zum Erstellen individueller Logger, z.B. von selbst entwickelten Plug-ins. Der administration guide 177 0 -Button öffnet einen Dialog, in dem über das Kontextmenü ein neuer Logger hinzugefügt werden kann. Nach dem Anlegen können Sie in demselben Dialog über den -Button das Log Level, das Layout, den Pfad und den Namen der Ausgabedatei sowie deren maximale Größe definieren.

Wenn die Datei die maximale Größe erreicht hat, wird diese umbenannt und als Backup gespeichert. Sie können auch die Anzahl der Backup-Dateien festlegen.

Außerdem können Sie entscheiden, ob die Kunden-Logs zusätzlich in das Trace-Log geschrieben werden sollen.

Siehe https://logging.apache.org/log4j/log4j-2.4/index.html

Web Service Logs

Verwendung

Protokollieren von Eingabe- und Rückgabenachrichten sowie Fehlerrückgaben von Web Services Connectoren, für die das Logging aktiviert ist

Siehe Register Erweitert im Web Services Connector.

Aufruf

INUBIT Workbench > Administration > Allgemeine Einstellungen > Monitoring > Web Service

Option Erläuterung

Option	Erläuterung
Individuelle Log-Ausgabe verwenden	Wenn aktiviert, können Sie die Log-Ausgaben über den Parameter `Individuelle Log-Ausgabe` konfigurieren.
Maximale Größe der Web Service-Log-Dateien (nur wenn die Checkbox `Individuelle Log-Ausgabe verwenden` deaktiviert ist)	Wenn die angegebene Größe erreicht ist, dann wird die jeweilige Web Service-Log-Datei `webservice.log` im Workflow-Verzeichnis eines bestimmten Benutzers geschlossen und archiviert, d.h. mit einer laufenden Nummer versehen (z.B. `workflow.log.5`).
Anzahl Backups der Web Service-Log-Dateien (nur wenn die Checkbox `Individuelle Log-Ausgabe verwenden` deaktiviert ist)	Angabe, wie viele Dateien maximal zur Archivierung von einzelnen Web Service-Log-Dateien (`webservice.log`) angelegt werden sollen.
Individuelle Log-Ausgabe	Zum Konfigurieren eines Log4J2-Appenders. Voraussetzung: Die Option `Individuelle Log-Ausgabe verwenden` ist aktiviert. Der -Button öffnet einen Dialog, in dem Sie einen Appenders hinzufügen und anpassen können.

Individuelle Log-Ausgabe verwenden

Wenn aktiviert, können Sie die Log-Ausgaben über den Parameter Individuelle Log-Ausgabe konfigurieren.

Maximale Größe der Web Service-Log-Dateien
(nur wenn die Checkbox Individuelle Log-Ausgabe verwenden deaktiviert ist)

Wenn die angegebene Größe erreicht ist, dann wird die jeweilige Web Service-Log-Datei webservice.log im Workflow-Verzeichnis eines bestimmten Benutzers geschlossen und archiviert, d.h. mit einer laufenden Nummer versehen (z.B. workflow.log.5).

Anzahl Backups der Web Service-Log-Dateien
(nur wenn die Checkbox Individuelle Log-Ausgabe verwenden deaktiviert ist)

Angabe, wie viele Dateien maximal zur Archivierung von einzelnen Web Service-Log-Dateien (webservice.log) angelegt werden sollen.

Individuelle Log-Ausgabe

Zum Konfigurieren eines Log4J2-Appenders.
Voraussetzung: Die Option Individuelle Log-Ausgabe verwenden ist aktiviert. Der administration guide 178 0 -Button öffnet einen Dialog, in dem Sie einen Appenders hinzufügen und anpassen können.

Speicherort der Log-Datei

Die Log-Datei webservice.log wird in das Verzeichnis <inubit‑installdir>/server/ibis_root/log gespeichert.

Individuelle Log-Ausgabe konfigurieren

So gehen Sie vor

Klicken Sie in der Zeile Individuelle Log-Ausgabe auf den Button .
Ein Dialog öffnet sich.
Wählen Sie aus der Auswahlliste Level das Log-Level.
Klicken Sie auf den Button und fügen Sie die Konfiguration ein. Alternativ dazu können Sie über das Pulldown-Menü Ausgabe-definition (log4j2-Appender) > Beispiel einfügen einen mitgelieferten Beispiel-Appender einfügen
Passen Sie ggf. die Konfiguration an.
Prüfen Sie die Konfiguration über das Pulldown-Menü Ausgabe-definition (log4j2-Appender) > Konfiguration prüfen (lokal).
Klicken Sie auf OK, um die Appender-Konfiguration zu speichern.
Speichern Sie die Web Service-Log-Konfiguration.

Benutzerdefinierte Spalten zu Queue Manager oder System Log hinzufügen

Verwendung

Zum Anzeigen von INUBIT-Systemvariablen und/oder benutzerdefinierten Variablen im Queue Manager und/oder System Log

So gehen Sie vor

In der Workbench öffnen Sie die Seite Administration > Allgemeine Einstellungen > Monitoring > Benutzerdefinierte Spalten.
In der Spalte Wert einer der benutzerdefinierten Spalten für das System Log oder den Queue Manager geben Sie einen Variablennamen ein, z.B. ISErrorKey.
Speichern Sie die Änderungen.
Öffnen Sie das Register Monitoring.
Abhängig von der Logging-Tabelle, für die Sie die Spalte konfiguriert haben, öffnen Sie das Register System Log oder Queue Manager.
Zum Anzeigen der benutzerdefinierten Spalte klicken Sie mit der rechten Maustaste auf den Tabellenkopf und wählen Sie den Eintrag is_userdefined aus, den Sie überwachen wollen.
Die nach dem Variablennamen benannte Spalte ist der Tabelle hinzugefügt.
Sobald Sie einen Workflow ausgeführt haben, können Sie die Tabelle automatisch oder manuell aktualisieren.
Der Variablenwert wird in der Spalte angezeigt.

Um eine benutzerdefinierte Variable anzulegen und als Spalte anzuzeigen, siehe Benutzerdefinierte Variable anlegen und als Spalte im Queue Manager/System Log anzeigen.