Zum Inhalt

Troubleshooting#

Nicht nachvollziehbares Verhalten in i-doit. Ein Fehler? Wie soll man sich verhalten? Bitte weiterlesen! Es könnte nützlich sein. 😉

Don't panic#

Zuallererst ist es sehr wichtig, Ruhe zu bewahren. Fehler passieren. Uns. Dir. Allen. Die Welt geht nicht unter. IT-Dokumentationen lösen sich nur sehr, sehr selten in Luft auf.

Nach dem anfänglichen Schock, gilt es, die Situation zu bewerten und anschließend richtig zu handeln. "Richtig" wäre im Falle eines Fehlers, uns so schnell wie möglich, aber auch so ausführlich wie nötig zu informieren. Trage erst einmal alle Informationen zusammen, bevor du uns kontaktierst. So können wir dir schnellstmöglich ohne langwierige Rückfragen weiterhelfen.

Fehler analysieren#

Was passiert genau, wenn der Fehler auftritt? Welche Schritte wurden durchgeführt, um den Fehler zu provozieren? Gibt es eine Fehlermeldung? Lässt sich der Fehler reproduzieren? - Dies sind wichtige Fragen, die beantwortet werden sollten, bevor es ins Detail geht.

Hier ist eine kleine Checkliste, was du darüber hinaus recherchieren kannst:

  1. Ist der Fehler bereits bekannt und gar behoben?
    Hier in der Knowledge Base pflegen wir zu einigen Fehlern eine Liste. Auch unsere FAQ ist Quell für mögliche Lösungen. Eine beherzte Suche bei der Suchmaschine deiner Wahl könnte weitere Anhaltspunkte liefern.
  2. Wurde i-doit korrekt installiert und konfiguriert?
    Ein Fehler kann auftreten, wenn unsere Systemvoraussetzungen und -einstellungen nicht ausreichend beachtet worden sind. Zudem können sich diese Angaben ändern. Ein Blick in die zum Fehlerzeitpunkt aktiven Einstellungen verschafft Klarheit. Zudem sollte kontrolliert werden, ob die Dateirechte im Installationsverzeichnis von i-doit korrekt gesetzt sind.
  3. Wurde i-doit regelmäßig gepflegt?
    Ein Fehler könnte bereits behoben und ein Fix veröffentlicht sein. Bitte stelle sicher, die aktuelle Version von i-doit einzusetzen.
  4. Gibt es übergreifende Probleme?
    Beispielsweise könnte es Netzwerkprobleme geben. Angebundene Dritt-Systeme könnten umkonfiguriert oder gar ausgefallen sein.
  5. Werden Log-Dateien von i-doit bereitgestellt?
    Beispielsweise können Importe, Benachrichtigungen oder API Requests mit geloggt werden. Zudem gibt es teilweise verschiedene Log Level, zum Beispiel beim Import von Daten aus JDisc. Je höher das Level (Debug ist das höchste), desto detaillierter fällt die Fehleranalyse aus. Diese Logs befinden sich im Installationsverzeichnis von i-doit unter log/. Einige von ihnen können unter Verwaltung → [Mandanten-Name] Verwaltung → Einstellungen für [Mandanten-Name] → Logging aktiviert werden.
  6. Werden Exceptions geschmissen?
    In PHP können viele Fehler abgefangen werden. Diese Fehler werden im Installationsverzeichnis von i-doit unter log/exception.log gesammelt. Die Option wird unter Verwaltung → [Mandanten-Name] Verwaltung → Einstellungen für [Mandanten-Name] → Logging → Exception Log aktiviert.
  7. Werden Fehler von PHP an den Apache Webserver weitergereicht?
    Wer unseren Installationsanleitungen folgt, lässt viele Fehler vom Apache Webserver mit loggen. Zu finden ist dieses Log unter Debian-basierten Betriebssystemen unter /var/log/apache2/error.log.
  8. Meldet der Webserver an den Webbrowser einen Fehler?
    Gesetzt den Fall, der Fehler tritt über die Web GUI auf: Teilweise sendet der Webserver eine Fehlermeldung an den Browser, ohne dass er dies für den Benutzer sichtbar macht. Über die Entwicklerkonsolen der Browser wird die Kommunikation zwischen beiden sichtbar, also auch mögliche Fehler.
  9. Meldet das Betriebssystem Fehler?
    Vielleicht ist der Fehler nicht bei i-doit. sondern bei den verwendeten Diensten wie Apache Webserver, MySQL/MariaDB oder dem Betriebssystem selbst zu suchen. Die Dienste werden unter GNU/Linux üblicherweise über einen Init-Dienst wie systemd verwaltet. Dieses schreibt Meldungen ins Syslog, meist zu finden unter /var/log/syslog.

Debugging für Anfänger

Um einen Fehler nicht erst im Nachhinein, sondern in Echtzeit zu beobachten, lohnt es sich, die oben genannten Log-Dateien und die Systemlast parallel zu untersuchen. Log-Dateien können unter GNU/Linux mit tail -f [log-Datei] geöffnet werden. Änderungen werden sofort sichtbar. Um die Systemlast zu beobachten, eignen sich Kommandozeilen-Befehle wie top, htop, atop und free. Hierbei ist darauf zu achten, ob die Prozesse von Apache und MySQL/MariaDB ungewöhnlich viel CPU-Zeit und/oder Arbeitsspeicher fressen.

Bug Report schreiben#

Wenn wir einen Fehler kennen, können wir ihn auch beheben. Wer einen Support-Vertrag mit uns abgeschlossen hat, verfügt bereits über die nötigen Kontaktdaten. Fehler lassen sich auch ohne Support-Vertrag über das Kundenportal oder über das Help Portal melden.

Wichtig

Bitte gib immer an, welche Versionen von i-doit, betroffenen Add-ons, Apache Webserver, PHP und MySQL/MariaDB im Einsatz sind. Dabei hilft dir das i-doit environment info file, das im Admin Center zum Download steht. Konfigurationsdateien, Log-Dateien, Screenshots und die Fehlermeldung im Klartext unterstützen ebenfalls bei der Analyse. Antworten auf die oben genannten Fragen helfen uns und letztendlich dir enorm weiter.

Weniger wichtig ist uns, dass du deinen Bug Report hübsch formatierst oder gar in Hochglanz-PDFs einbettest. Umso mehr freuen wir uns über einen freundlichen, sachlichen Umgangston. Aber das versteht sich von selbst.

Wir melden uns#

Bei unseren Kunden mit Support-Vertrag melden wir uns innerhalb kurzer Zeit zurück (nicht selten mit einem Lösungsvorschlag). Wir versuchen anhand deiner Informationen den Fehler auf unseren Testsystemen nachzustellen. Wird dieser Fehler als solcher erkannt, wird er von uns schnellstmöglich behoben. Bevor wir einen Fix liefern, durchläuft dieser unsere Testing-Prozesse. Qualität braucht Zeit. Danach veröffentlichen wir diesen Fix im Rahmen unserer Release-Zyklen. Warum auch immer: Manchmal dauert es ein wenig länger, um einen Fehler zu korrigieren. Wir bitten in solchen Fällen um Verständnis. Wir bleiben am Ball.

Alles gut?#

Wenn du einen Lösungsweg (Fix, Workaround, o. ä.) ausprobiert hast, würden wir uns über Feedback freuen. Hat es geklappt? Wunderbar. Existiert das Problem weiterhin? Auch gut, dann probieren wir eben alternative Wege. Es ist ein Folgefehler aufgetreten? Keine Panik, wir gehen die obigen Schritte noch einmal durch, bis alle Fehler erkannt und bestenfalls behoben sind. Und nicht vergessen: You'll never walk alone. 😉