Logging

Tritt ein unerwünschtes Ereignis ein, ist es immer erstrebenswert dies so schnell wie möglich zu beheben. Die Loggingfunktionen von IQ4docs unterstützen Sie dabei. Logginginformationen werden in der Datenbank gespeichert und können live (mit Highlighting) in der browsergestützten Administrationsoberfläche eingesehen oder im Nachhinein gefiltert angesehen werden. Gerade bei einer stark frequentierten Clusterinstallation ist es so möglich, die Abarbeitung eines Vorganges (den sich mehrere Server teilen können) nachvollziehen zu können. Ein Remotezugriff auf den Server um Loggingdateien einzusehen, ist dafür nicht erforderlich.

Das Loglevel legt fest wie detailliert Vorgänge protokolliert werden sollen. Ist das Loglevel niedrig, wird wenig protokolliert. Der Zeitraum, der protokolliert wird ist dann groß und das System wird durch das kontinuierliche Schreiben der Logs wenig belastet. Die Aussagekraft der Logs ist jedoch niedrig. Je höher das Loglevel eingestellt ist, desto kleiner wird der abgebildete Zeitraum und desto höher wird das System belastet. Die Aussagekraft der Logs steigt. Legen Sie das Loglevel wie folgt fest.

Ein hohes Loglevel erzeugt sehr aussagekräftige Logs, belastet aber auch das System. Stellen Sie das Loglevel nur auf einen hohen Wert ein, wenn dies erforderlich ist und anschließend wieder auf einen niedrigen Wert zurück.

Um die Webadministration zu öffnen, geben Sie im Webbrowser http://<Hostname>/webadmin ein (wobei Hostname dem Server entspricht, auf dem das IQ4docs WebAdmin installiert wurde). In einer Mandantenumgebung geben Sie die URL ein, die Sie vom Mandantenverwalter erhalten haben (z.B. http://server/webadmin/#/cf992178-4bd6-431c-b815-b9d734d0ded3). Wenn Sie noch nicht angemeldet sind, melden Sie sich mit einem Anwender mit Administratorrechten (Login und Passwort) oder dem IQ4docs Systemadministrator (standardmäßig administrator mit Passwort admin) an.

Klicken Sie in der Webadministration im Menü auf Logging > Logging-Konfiguration.

Sie können das Loglevel für jeden Microservice einzeln oder auch für alle Services gleichzeitig einstellen (Klappliste Für alle setzen). Der Standardwert für das Loglevel ist Informationen.

Folgende Loglevel von niedrig nach hoch können gewählt werden (der Wert in Klammern wird in der Logdatei bei der Logzeile angezeigt):

  • Fehler (ERROR)
  • Warnungen (WARN)
  • Informationen (INFO)
  • Detailliert (DEBUG)
  • Sehr detailliert (TRACE)

Die Informationen des Live-Logging sind in der Datenbank gespeichert. So wird es möglich in der Weboberfläche der Administration die Logs aller beteiligten Services chronologisch einzusehen. Sie können z.B. einen Druckauftrag verfolgen, indem Sie die Logs nach der GUID des Druckauftrages filtern.

Die Funktion des Live Loggings sollte nur bei kleinen Installationen verwendet werden, da bei größeren oder stark frequentierten Systemen die Anzahl der Logzeilen zu groß wird und diese zu schnell laufen. Verwenden Sie dann besser den Log Filter, siehe Log Filter.

Die Funktion des Live-Loggings ist für den anzeigenden Webbrowser sehr rechenintensiv, da sehr oft geänderte Daten an den Browser geschickt werden, der deswegen einen Teil der Webseite neu aufbauen muss.

Um die Webadministration zu öffnen, geben Sie im Webbrowser http://<Hostname>/webadmin ein (wobei Hostname dem Server entspricht, auf dem das IQ4docs WebAdmin installiert wurde). In einer Mandantenumgebung geben Sie die URL ein, die Sie vom Mandantenverwalter erhalten haben (z.B. http://server/webadmin/#/cf992178-4bd6-431c-b815-b9d734d0ded3). Wenn Sie noch nicht angemeldet sind, melden Sie sich mit einem Anwender mit Administratorrechten (Login und Passwort) oder dem IQ4docs Systemadministrator (standardmäßig administrator mit Passwort admin) an.

Klicken Sie in der Webadministration im Menü auf Logging > Live Log. Das Schreiben der Logzeilen beginnt sofort. Möchten Sie das Aktualisieren der Seite unterbrechen, Aktivieren Sie Pause.

Im Feld Text Suche kann ein beliebiger Begriff eingegeben werden. Es werden dann nur die Zeilen angezeigt, die in allen relevanten Feldern den Eintrag enthalten (auch als Teil eines Wortes). Groß- und Kleinschreibung wird nicht beachtet.

  • Loglevel: Geben Sie die Loglevel an, deren Logzeilen Sie sehen möchten. Keine Auswahl zeigt alle Loglevel an. Wird ein Level gar nicht geloggt, kann es hier auch nicht angezeigt werden (z.B. wenn INFO eingestellt ist, kann keine Zeile mit DEBUG gefunden werden, siehe Loglevel einstellen).
  • Logger: Herkunft der Logdaten (Service oder Zugriff auf MongoDB oder RabbitMQ), siehe auch IQ4docs Serverkomponenten.
  • Text Suche: Im Feld Text Suche kann ein beliebiger Begriff eingegeben werden. Es werden dann nur die Zeilen angezeigt, die in allen relevanten Feldern den Eintrag enthalten (auch als Teil eines Wortes). Groß- und Kleinschreibung wird nicht beachtet.

Sie können den Filter mit Anwenden aktivieren und mit Zurücksetzen auf die Standardwerte zurücksetzen.

Um Spalten ein- oder auszublenden, klicken Sie auf die Schaltfläche Spalten auswählen und wählen die gewünschten Spalten aus. Standardmäßig werden nicht alle verfügbaren Spalten angezeigt.

Feld Inhalt
Zeitstempel Zeitstempel des Logeintrags bestehend aus Datum und Zeit (incl. Sekunden und Millisekunden).
Servername Name des Computers, auf dem die loggende Komponente läuft.
Level Loglevel, das der Meldung zugeordnet ist, siehe auch Loglevel einstellen.
Assembly Versionsnummer der ausführenden Komponente (Logger).
P ID Prozess-ID des Windows-Prozesses.
T ID Thread-ID des Windows-Theads.
Logger IQ4docs-Komponente, die die Zeile geloggt hat (der erste Bereich vor dem Punkt gibt den Service an, z.B. ImageService beim Eintrag "imageservice.integration.ImageServiceInteractor").
Meldung Loggingmeldung, Information was passiert ist.

Die Logginginformation von in der DB gespeicherten Logs (Webadministration) und den Logdateien ist nahezu aber nicht komplett gleich.

Die Informationen des Log-Filters sind in der Datenbank gespeichert. So wird es möglich in der Weboberfläche der Administration die Logs aller beteiligten Services chronologisch einzusehen. Dies ist besonders in der Clusterinstallation praktisch, da hier die Dienste auf mehrere Server verteilt sind und sich ein Vorgang entsprechend über die Logs mehrerer Server erstrecken kann. Sie können z.B. einen Druckauftrag verfolgen, indem Sie die Logs nach der GUID des Druckauftrages filtern.

Mit dem Filter schränken Sie die Anzahl Logzeilen ein:

  • Datumsbereich: Geben Sie ein von und einen bis-Zeitstempel an. Der Zeitstempel der Logzeile muss in diesem Bereich sein.
  • Loglevel: Geben Sie die Loglevel an, deren Logzeilen Sie sehen möchten. Keine Auswahl zeigt alle Loglevel an. Wird ein Level gar nicht geloggt, kann es hier auch nicht angezeigt werden (z.B. wenn INFO eingestellt ist, kann keine Zeile mit DEBUG gefunden werden, siehe Loglevel einstellen).
  • Logger: Herkunft der Logdaten (Service oder Zugriff auf MongoDB oder RabbitMQ), siehe auch IQ4docs Serverkomponenten.
  • Text Suche: Im Feld Text Suche kann ein beliebiger Begriff eingegeben werden. Es werden dann nur die Zeilen angezeigt, die in allen relevanten Feldern den Eintrag enthalten (auch als Teil eines Wortes). Groß- und Kleinschreibung wird nicht beachtet.

Sie können den Filter mit Suchen aktivieren und die gewünschten Zeilen werden gesucht. Mit Zurücksetzen wird der Filter auf die Standardwerte zurückgesetzt.

Um Spalten ein- oder auszublenden, klicken Sie auf die Schaltfläche Spalten auswählen und wählen die gewünschten Spalten aus. Standardmäßig werden nicht alle verfügbaren Spalten angezeigt.

Feld Inhalt
Zeitstempel Zeitstempel des Logeintrags bestehend aus Datum und Zeit (incl. Sekunden und Millisekunden).
Servername Name des Computers, auf dem die loggende Komponente läuft.
Level Loglevel, das der Meldung zugeordnet ist, siehe auch Loglevel einstellen.
Assembly Versionsnummer der ausführenden Komponente (Logger).
P ID Prozess-ID des Windows-Prozesses.
T ID Thread-ID des Windows-Theads.
Logger IQ4docs-Komponente, die die Zeile geloggt hat (der erste Bereich vor dem Punkt gibt den Service an, z.B. ImageService beim Eintrag "imageservice.integration.ImageServiceInteractor").
Meldung Loggingmeldung, Information was passiert ist.

Mit der Schaltfläche Highlighting können Sie Zeilen farblich markieren, die einem Suchmuster entsprechen. Die Suche umfasst alle relevanten Felder (Groß- und Kleinschreibung wird nicht beachtet).

Im Ausklappbereich können Sie einen Eintrag hinzufügen oder entfernen. Geben Sie unter Suche einen Begriff ein - enthält eine Logzeile diesen Begriff wird Sie farbig markiert. Klicken Sie auf die Farbe rechts neben dem Hex-Wert der Farbe (Standardmäßig #ffffff) um eine Farbe auszuwählen (im Farbwähler wählen Sie den Farbbereich mit dem senkrechten Schieberegler und klicken dann an der gewünschten Stelle in den linken Farbbereich). Verlassen Sie den Dialog durch Klick auf einen Bereich außerhalb des Fensters. Beachten Sie, dass die Farbe nicht zu hell sein sollte, da markierte Zeilen mit weißer Schrift dargestellt werden.

Mit der Schaltfläche Export können Sie die angezeigten Logzeilen in eine CSV-Datei exportieren.

Alle Microservices liegen im Installationsverzeichnis unter Logs. Die Logdateien tragen den Namen des zugehörigen Microservices. Sobald die maximale Größe einer Logdatei erreicht wird, wird diese automatisch komprimiert und als Zip-Datei abgelegt. Um herauszufinden, welcher Service in etwa welche Aktion durchführt, sehen sie bei den Systemkomponenten nach, siehe IQ4docs Serverkomponenten.

Die Logginginformation von in der DB gespeicherten Logs (Webadministration) und den Logdateien ist nahezu aber nicht komplett gleich.

Wird auf dem Gerät eine Client-Software Installiert (z.B. bei Kyocera- oder Lexmark-Geräten) kann auch ein Logging auf dem Gerät stattfinden. Die Logdatei wird auf dem Gerät gespeichert. Sie können die Logdatei über die Weboberfläche des Gerätes herunterladen.

Melden Sie sich dazu an der Weboberfläche des Gerätes an. Öffnen Sie den Bereich der Applikation. Hier gibt es die Registerkarte Logging. Hier kann das Loglevel eingestellt und die Logdatei heruntergeladen werden.