Relution Signet Customer Hub

Loglevel einstellen

In manchen Fällen ist die Ursache eines Problems im Standard Loglevel nicht zu erkennen; hier kann das Loglevel entsprechend eingestellt und der Informationen-Output erhöht werden.

Das Loglevel kann über die application.yml, das Systemportal oder per API gesetzt werden.

Speicherort der Log-Dateien

Wo sich die Protokolldateien für Docker, Linux und Windows befinden, ist unter Relution Logs → beschrieben.

Aktivierung des System-Portals

Diesen Abschnitt in der application.yml im Relution-Verzeichnis hinzufügen:

relution:
  spring-boot-admin:
    enabled: true

Aktivierung des DEBUG Logs im System-Portal

  1. In Relution als System-Administrator anmelden. Der Standard-Benutzername ist admin.

  2. Im System-Menü auf System-Portal gehen.

    System-Portal im Relution Systemmenü öffnen

  3. Anschließend lässt sich die zugehörige Instanz aufrufen. Dazu auf den Kasten klicken und nicht direkt auf den grünen Link.

    Relution Instanz im System-Portal aufrufen

  4. In den Bereich Logger wechseln.

    Logger-Bereich im Relution System-Portal öffnen

  5. Die Suche nutzen, um die entsprechenden Logger auf DEBUG zu stellen. ROOT aktiviert sämtliche Logger und ist daher nur in Ausnahmefällen zu nutzen, da schnell viel Inhalt generiert wird. Im Beispiel ist die AppleMDMResource aktiviert worden.

    Logger auf DEBUG-Level im Relution System-Portal setzen

Die Einstellung ist direkt aktiv, ohne dass Dienste neu gestartet werden müssen. Beim Neustart des Relution-Dienstes oder des Docker-Containers wird das Log wieder zurück auf INFO gestellt.

DEBUG-Log auch über einen Neustart hinaus aktiv lassen

Da das DEBUG-Log nach einem Neustart der Instanz wieder auf INFO zurück gestellt wird, ist es auf dem oben beschrieben Weg nicht möglich, initiale Fehler beim Startvorgang, z.B. im Kontext einer LDAP-Anbindung, zu loggen. Hierfür gibt es die Möglichkeit, das Log in der application.yml zu definieren. Diese wird direkt beim Start geladen und aktiviert somit das DEBUG-Log.

Nachfolgenden Inhalt direkt in die erste Zeile an Position 1 einfügen.

ROOT auf DEBUG setzen

Es wird empfohlen, einen oder mehrere Logs individuell und zielgerichtet zu aktivieren. Dazu einfach die einzelnen Logger untereinander in die Datei einfügen:

logging.level.com.mwaysolutions: DEBUG

Mehrere individuelle Logs 

com.mwaysolutions.relution.platform.security.ldap: DEBUG
com.mwaysolutions.relution.mdm.apple.service.AppleMdmResource: DEBUG

Im Beispiel wäre jetzt die LDAP-Funktionalität und die IosResource im DEBUG-Log aktiviert. Die Bezeichnungen der Logger und wie sich diese aktivieren lassen, sind im System-Portal zu finden.

Setup Loglevel mit einem Logging User über die Web API

Ab Relution 5.18 besteht die Möglichkeit, auf der System-Organisation einen speziellen Logging-User zu erstellen, der das Loglevel über die Web API komfortabel ändern kann. Dies erspart das manuelle Bearbeiten der YAML-Konfigurationsdatei sowie einen Neustart des Servers.

1. Berechtigung und Benutzer erstellen

Um den Logging-User zu erstellen, muss zunächst auf der System-Organisation eine neue Berechtigung erstellt werden, bei der die Option “System > Logging configuration” aktiviert und gespeichert wird. Anschließend kann ein neuer Benutzer ausschließlich für den Logging-Access erstellt werden, dem die zuvor erstellte Berechtigung zugewiesen wird. Hinweis: Der System Administrator verfügt per default über diese Berechtigung.

Neue Berechtigung für Logging-Konfiguration in Relution System-Organisation erstellen

Logging-Benutzer mit Berechtigung in Relution System-Organisation anlegen

2. Access Token erstellen

Für diesen neuen Benutzer kann ein Access Token erstellt werden, um die Handhabung zu erleichtern. Hierzu muss sich der Benutzer zunächst anmelden und über das Benutzerprofil den Token erstellen. Der Access Token wird nur einmalig angezeigt, ein weiterer Token kann bei Bedarf erstellt werden.

Access Token für Logging-Benutzer in Relution Benutzerprofil erstellen

Generierten Access Token für Logging-Benutzer anzeigen und kopieren

3. Steuerung des Loglevels über die Web API

Um das Loglevel über die Web API zu steuern, kann der Logging-User in der System-Organisation über das ⚙️ Symbol > Web API > Authorize aufgerufen werden. Hier kann der Access Token des Logging-Users verwendet werden, um den Zugriff zu erleichtern und die Authentifizierung beim Curl automatisch hinzuzufügen. Im Punkt userAccessTokenAuth muss der Token eingefügt und autorisiert werden. Hinweis: Alternativ kann man sich mit System System Orga Admin anmelden und die Eingabe des Tokens überspringen.

Beim Punkt logging können die benötigten Logging-Punkte sowie das Loglevel definiert und ausgeführt werden. Eine erfolgreiche Ausführung wird mit dem Code 204 bestätigt, und der ausgeführte Curl-Befehl wird angezeigt.

Logging-User in Relution Web API autorisieren und Loglevel steuern

Logging-Konfiguration per Web API mit Access Token ausführen

Loglevel über Web API erfolgreich gesetzt und Curl-Befehl angezeigt

Logging-Punkt und Level im Relution Web API Formular definieren

Zusätzlich besteht die Möglichkeit, das Logging auf die Standard-Einstellungen zurückzusetzen, indem ein Reset oder Restore der Logging-Punkte ausgelöst wird.

Logging-Punkte in Relution Web API zurücksetzen oder wiederherstellen

4. Steuerung des Loglevels über den Curl Befehl

Es besteht auch die Möglichkeit, das Loglevel über den Curl-Befehl zu steuern, indem der über die Web API generierte Curl als Alias oder Skript für die zukünftige Verwendung gespeichert wird.

Loglevel per Curl-Befehl steuern und als Alias speichern

5. Verwendung für Support-Mitarbeiter oder andere Mitarbeiter

Um einem Benutzer, beispielsweise einem Relution-Support-Mitarbeiter, Zugriff zu gewähren, genügt es, entweder den Token weiterzugeben oder die E-Mail-Adresse des Logging-Benutzers, die mit einer gültigen Relution-Instanz verknüpft ist, dem Relution-Support-Team mitzuteilen.