Aktivieren und Verwenden des Toolbox Debug Modes bei Kommunikationsproblemen zwischen dem ReqIF-Manager und DNG

Konfiguration der Debug Parameter ab Version 4.8 im Toolbox Adminbereich. Sowie finden und lesen der entsprechenden Logdatei.

Für diesen Guide benötigen Sie einen Nutzer mit Adminrechten, um die Toolbox Administration zu verwenden. Dazu muss sich der Nutzer der im Parameter auth.ldap.admin.dn hinterlegten Gruppe im verwendeten Authentifizierungssystem befinden.

Die hier gezeigten Parametereinstellungen sollten nur für die benötigte Zeitspanne verwendet werden, da die erzeugten Logdateien deutlich größer als üblich werden.


Mit diesem Guide wird erklärt, wie Sie Kommunikationsprobleme zwischen dem ReqIF-Manager und dem DNG Server dokumentieren. Sie werden Logdateien mit Debuginformationen erzeugen und mit dem Produktsupport teilen. Bevor mit der Reproduktion des Fehlers begonnen werden kann, müssen Sie noch ein paar Einstellungen vornehmen.

Falls es sich bei Ihnen um einen Fehler bei einem Job (Import oder Export) handelt, finden Sie den entsprechenden Guide hier.

Konfiguration des Debug Modes

  • Öffnen Sie den Tab Parameters in der Toolbox Administration und klicken Sie auf das Icon, um die Parameter auth.ldap.debug, logger.dng_communication_log.log_always und logger.level editieren zu können.
  • Die drei Parameter können hier im GUI geändert werden und sind dann nach dem Klick auf ohne einen Neustart der Container sofort aktiv. Möchten Sie keine Änderungen vornehmen, klicken Sie auf, ⁣das Icon, um den Editiermodus ohne Änderungen zu verlassen.
auth.ldap.debug
Wenn der Wert auf true gesetzt ist, werden der LDAP-Debug-Modus und das requisis_toolbox_login.log für detailliertere Fehlermeldungen aktiviert. Dies wird bei der Analyse von Problemen mit dem Login benötigt.
Standardwert: false/unchecked

logger.dng_communication_log.log_always

Wenn der Wert auf true gesetzt, wird das Schreiben des DNG_communication_log außerhalb von Jobs aktiviert. Dies wird bei der Analyse von Problemen beim Hinzufügen von Modulen, Synchronisieren von Modulen / Komponenten etc. benötigt.
Standardwert: false/unchecked

logger.level
Loglevel für das Logging. Legt fest, wann ein Ereignis im entsprechenden Log dokumentiert wird. Sofern nicht anders angegeben, stellen Sie diesen Parameter auf den Wert debug ein. Mögliche Werte sind: debug, error, warning, critical, info
Standardwert: error

  • Im Editiermodus sind die drei Parameter farblich hervorgehoben. Nachdem Sie entsprechende Anpassungen vorgenommen und gespeichert haben, wechseln Sie auf den Tab LogFile Viewer.



Vorbereiten der Fehlerreproduktion

Der Debug Modus ist nun konfiguriert. Als Nächstes wird die aktuell bestehenden log Datei entfernt, damit diese später zur Analyse nur Daten enthält, die mit dem Debug Mode erzeugt wurden.

  • Dazu wechseln Sie jetzt in den LogFile Viewer, indem Sie auf den entsprechenden Tab in der Administration klicken.
  • Im LogFile Viewer können Sie die Logdateien auf dem laufenden Container betrachten. Öffnen Sie dazu am rechten Bildschirmrand den Inhalt des Ordner app/var/logs und die Liste der Logdateien wird sichtbar.
    VorbFehlerRep
  • Klicken Sie auf das Log, das Sie im Debug Modus konfiguriert haben.
    requisis_toolbox_login.log bei Login Problemen
    DNG_communication_log bei Kommunikationsproblemen mit dem DNG Server
  • Die darin enthalten Einträge sind für die spätere Fehlanalyse irrelevant. Öffnen Sie mit einem Rechtsklick auf die Logdatei das Kontextmenü und wählen Sie den Eintrag Delete File, um die Datei zu löschen.

Keine Angst, wenn das System feststellt, dass eine bestimmte Logdatei fehlt, in die jetzt ein Eintrag geschrieben werden müsste, wird diese Datei automatisch neu angelegt.

 

Fehlerreproduktion und Daten bereitstellen

Es sind nun alle Vorbereitungen abgeschlossen. Reproduzieren Sie Ihren Fehlerfall und senden Sie uns das erzeugte Log.

Bei Loginproblemen kann es helfen, dass der betroffene Nutzer ein Inkognito-Fenster in seinem Browser verwendet.

Bei Kommunikationsproblemen achten Sie darauf, dass involvierte Nutzer über die entsprechenden Zugriffsrechte in DNG und auf das verwendete ReqIF Set haben. Lesen Sie dazu die Kapitel 1.2, 1.3 und 2.4 im Nutzerhandbuch.

  • Reproduzieren Sie oder der betroffene Nutzer jetzt den Fehlerfall.
  • Im LogFile Viewer finden Sie jetzt wieder das entsprechende Log mit den eben erzeugten Einträgen.
    requisis_toolbox_login.log bei Login Problemen
    DNG_communication_log bei Kommunikationsproblemen mit dem DNG Server
  • Optional: Möchten Sie Interesse halber einen Blick in das Log werfen, klicken Sie einfach auf das entsprechende Log. Mit den Filteroptionen und der Suche finden Sie schnell entsprechende Einträge.
    LogFileView
Im LogFile Viewer wird der letzte/aktuellste Eintrag ganz oben angezeigt.
Einige Logs können aufgrund ihres Formats hier nicht angezeigt werden.
  • Um die Logdateien herunterzuladen, machen Sie einen Rechtsklick auf das entsprechende Log, im Kontextmenü wählen Sie dann die Option Download File. Komprimieren Sie Logdatei mit einem ZIP-Tool.
  • Setzten Sie die Parameter, die Sie im Abschnitt Konfiguration des Debug Modes verändert haben, wieder auf deren Standardwerte zurück.
  • Fügen Sie diese Datei schließlich dem passenden Ticket beim requisis_Product Support hinzu. Falls noch nicht erwähnt, auch die Schritt-für-Schritt-Anleitung zum Reproduzieren des Fehlers. Sowie die verwendeten Versionen der Requisis_Toolbox und von DNG inkl. iFix.
    UploadData