Der Qlik Sense Log Collector

administration log files qlik sense
Viele kleine Würfel in allen möglichen Größen, die gesammelt wurden.

Wenn Du einen Qlik Sense Support Case beim Qlik Support eröffnest, benötigt dieser die Log Dateien von Deinem Qlik Sense Server.

Allerdings erstellt der Qlik Sense Server eine riesige Menge an Log Dateien und es ist gar nicht so einfach, die wirklich benötigten Log Dateien aus den vielen Unterverzeichnissen zusammenzustellen.

Zum Glück gibt es den Qlik Sense Log Connector - den aber kaum jemand kennt.

In diesem Artikel zeige ich Dir das simple Tool und wie Du damit schnell und einfach alle benötigten Logdateien zusammenstellen kannst.


P.S.: Den Log Collector gibt es auch für den QlikView Server. Beide Tools werden offiziell nicht von der QlikTech supported - bedeuten aber eine enorme Zeitersparnis für Dich, wenn Du Deine aktuellen Log Dateien brauchst.


Was ist eine Log Datei?

Hierbei handelt es sich um eine Datei, in der relevante Informationen gesammelt werden, anhand derer nachvollzogen werden kann, was eine bestimmte Software wann genau gemacht hat.

Die Log Daten werden meistens in eine Text-Datei geschrieben und sind chronologisch aufgebaut. Jede Zeile entspricht einer Aktion, versehen mit einem Zeitstempel, der das Datum und die Uhrzeit enthält.

Dahinter steht, was die Software genau gemacht hat.

Insbesondere bei der Fehlersuche sind die Log Dateien sehr hilfreich, da sie wertvolle Informationen enthalten, die auf die Fehlerursache hindeuten können.

Wenn zum Beispiel eine Anmeldung eines Users nicht funktioniert, würde man im Qlik Sense Proxy Log nachschauen und nach Hinweisen suchen, warum die Anmeldung nicht funktioniert hat. Dabei ist der Zeitstempel extrem wichtig, da man so genau den Zeitpunkt betrachten kann, zu dem sich der User versucht hat anzumelden.


Warum braucht der Qlik Support die Logdateien?

Die technischen Spezialisten bei der Qlik kennen ja Deinen Qlik Sense Server nicht und können da natürlich auch nicht einfach so drauf schauen. 

Selbst wenn sie jetzt drauf schauen würden, könnten sie nicht sehen, warum die Anmeldung gestern nicht funktioniert hat - sie würden nur den Ist-Zustand sehen und nicht den Zustand zum Zeitpunkt der Anmeldung.

Darum benötigen sie die Log Dateien von Deinem Server.

In den Log Dateien ist chronologisch aufgezeichnet, wann was genau wo passiert ist.

Fehlende Einträge in den Log Dateien können außerdem ein Hinweis darauf sein, dass etwas, was hätte passieren sollen, nicht passiert ist.

Diese Informationen sind äußerst wertvoll für die Support-Spezialisten, um die Fehlerursache so schnell wie möglich zu identifizieren.


Wo liegen die Qlik Sense Log Dateien?

Normalerweise findest Du die Qlik Sense Log Dateien direkt auf Deinem Qlik Sense Server im Verzeichnis:

C:\ProgramData\Qlik\Sense\Log

Dabei hat jeder Dienst ein eigenes Verzeichnis, in dem die Log Dateien abgelegt sind. Außerdem haben die meisten Verzeichnisse noch n Unterverzeichnisse und auch die Log Dateien selbst sind wiederum nach Tagen aufgeteilt.

Hier manuell die aktuellen Log Dateien zusammenzustellen wäre immens aufwendig und zeitraubend. Auch die Gefahr, wichtige Dateien zu übersehen, wäre damit sehr hoch.


Der Log Collector

Damit alle benötigten Log Dateien schnell, einfach und vollständig zusammengestellt werden können, wurde ein kleines Tool von Bjarni Fridjonsson (ehemaliger Lead Developer bei der Qlik in Lund) entwickelt, welches mit der Installation des Qlik Sense Servers auf dem Qlik Sense Server abgelegt wird.

Du findest den Log Collector in folgendem Verzeichnis auf Deinem Qlik Sense Server:

C:\Programme\Qlik\Sense\Tools\QlikSenseLogCollector\QlikSenseLogCollector.exe


Alternativ kann das Tool hier heruntergeladen werden:

https://proactiveportal.qliktech.com/QlikDiagnostics/QlikSenseLogCollector.zip


Log Connector starten

Wenn Du den Log Connector starten möchtest, musst Du das unbedingt mit dem Account tun, der auch die Qlik Sense Dienste startet!

Das ist wirklich wichtig, sonst funktioniert es nicht.

Wenn also Deine Qlik Sense Dienste zum Beispiel mit dem User: Domain\Hefeweizen gestartet werden, dann musst Du den Log Collector ebenfalls mit genau diesem User Account starten.

Es gibt auf Deinem Windows Server dafür die Funktion: Als anderer Benutzer ausführen, mit der Du ein Programm mit einem anderen User Account starten kannst.


Ohne diese Funktion würdest Du das Programm mit dem User Account starten, mit dem Du am Qlik Sense Server angemeldet bist. 


Halte dafür die UMSCHALT-Taste (Shift Taste) gedrückt und mache einen Rechtsklick auf die Datei: QlikSenseLogCollector.exe.

Klicke auf: Als anderer Benutzer ausführen.


Trage jetzt die Anmeldedaten des Benutzers ein, der die Qlik Sense Dienste auf Deinem Qlik Sense Server startet.

Domäne\Username und das Passwort.

Bitte achte darauf, dass Du auch die Domäne vor dem dem Usernamen mit angeben musst.

Klicke dann auf OK.


Bestätige die folgende Sicherheitsabfrage mit OK.


Jetzt startet der Qlik Sense Log Collector.


Welche Informationen sammelt der Log Collector?

Unten rechts im Collector Fenster findest Du einen Link: What do we collect.

Wenn Du da drauf klickst, findest Du verschieden Infos wie die Log Dateien gesammelt werden - aber leider nicht welche.

Da wird jeder mit Sicherheitsbewusstsein gleich ein wenig misstrauisch - aber Du brauchst Dir hier keinerlei Sorgen machen. Der Vorgang ist komplett transparent.


Der Qlik Sense Log Collector verschickt keine Daten - er sammelt nur die Log Dateien und stellt sie Dir als .zip Datei bereit.

Diese .zip Datei musst Du dann selber und manuell in Dein Qlik Support Ticket hochladen.

Vorher kannst Du die .zip Datei natürlich mit einem Doppelklick öffnen und prüfen, was da genau drin ist.

Du erkennst die Datei daran, dass der Dateiname mit SenseCollector beginnt, gefolgt von der Qlik Support Case Nummer, wenn Du sie im Hauptfenster des Collectors einträgst.

Die Dateierweiterung für ein ZIP-Archiv lautet immer .zip


Grob zusammengefasst, enthält die .zip Datei:

  • Die Logdateien der wichtigsten Qlik Sense Dienste
    • About Service
    • App Distribution Service
    • Data Profiling
    • Engine
    • Hybrid Deployment Service
    • Printing
    • Proxy
    • Repository
    • Scheduler
  • Ein Verzeichnis mit dem Namen des Qlik Sense Nodes (wenn du mehrere Nodes hast, ein Verzeichnis für jeden Node) und darin die Logs der wichtigsten Services:
    • Engine
    • Printing
    • Proxy
    • Repository
    • Scheduler
  • Weitere .json Dateien mit weiteren Informationen zu Deiner Windows Umgebung (also die Log Dateien Deines Windows Servers, auf dem der Qlik Sense Server installiert ist).
  • Skript Logs

Dabei kannst Du aber im Hauptfenster wählen, welche Log Dateien Du überhaupt sammeln möchtest:

Normalerweise braucht der Qlik Support nur die Log Dateien der Kategorie System Info und Windows Logs.

Die Skript Logs werden nur benötigt, wenn es sich um ein Problem mit einer App handelt.

Das wird Dir der Qlik Support dann aber schreiben.


Mit den beiden Dropdowns Logs from und To, kannst Du den Zeitraum auswählen, für den Du die Log Dateien sammeln möchtest.

Im Feld Case Number kannst Du die Qlik Support Ticket Nummer eintragen, damit sie in den Dateinamen der .zip Datei mit eingetragen wird.


Log Dateien sammeln

In diesem Screenshot habe ich zum Beispiel den Zeitraum 01.-31.01.2021 angegeben und meine Qlik Support Case Nummer lautet 01234567.

Ich habe nur die System-Informationen und die Windows Logs angehakt - die Script Logs möchte ich nicht haben.

Dann auf Collect klicken.


Der Log Collector arbeitet jetzt eine Weile, je nachdem, wie umfangreich die Dateien sind und wie groß der gewählte Zeitraum ist.

Am Ende bekomme ich im Verzeichnis des Qlik Sense Log Collectors die fertige .zip Datei:

Im Dateinamen findest Du dann auch die angegebene Qlik Support Case Nummer.

Diese .zip Datei kannst Du jetzt in Deinen Qlik Support Case hochladen.


Fazit

Der Qlik Sense Log Collector ist ein sehr nützliches Tool, das Du unbedingt kennen solltest.

Auch wenn es offiziell nicht von der QlikTech suppoted wird, bewirbt der Qlik Support dies trotzdem insgeheim in seinen Support Artikeln.

Du sparst wirklich immens viel Zeit mit der Zusammenstellung der Log Dateien.


Wenn Du noch Fragen hast, schreibe sie gerne unten in die Kommentare.