BugIt4 Min. Lesezeit

Einen Fehler aus einer Logdatei reproduzieren: eine Anleitung für Detektive

So finden Sie den Moment des Fehlschlags in einem Log, kürzen es auf das Wesentliche, machen daraus wiederholbare Schritte und geben es sicher weiter.

Ein kurzes Beispiel-Log mit hervorgehobener Fehlerzeile, ein Pfeil und drei nummerierte Schritte zur Reproduktion des Fehlers.

Ein Nutzer schreibt: „Es ist kaputtgegangen. Keine Ahnung, wie.“ Sie probieren das Naheliegende. Nichts passiert. Der Fehler ist echt, der Nutzer ist verärgert, und der einzige Zeuge ist eine Logdatei mit Tausenden von Zeilen.

Die gute Nachricht: Ein Log ist ein Zeuge, der nicht lügen kann, nur nuscheln. Mit etwas Methode finden Sie den Moment, in dem es schiefging, lesen die Hinweise drumherum und machen daraus Schritte, denen eine andere Person folgen kann. Hier ist die Methode.

Schritt eins: die Tatzeit bestimmen

Beginnen Sie mit einem Zeitpunkt. Fragen Sie die meldende Person, wann es passiert ist, oder nehmen Sie den Zeitstempel des Tickets, und durchsuchen Sie das Log in diesem Zeitfenster. Suchen Sie die erste Zeile auf Warn- oder Fehlerebene, nicht nur die lauteste. Der erste Fehler ist oft die Ursache. Die Fehler danach sind häufig die Reaktion des Programms auf den Schaden.

Wenn Sie eine Request-ID, eine Session-ID oder eine Benutzer-ID haben, suchen Sie danach. Wer einer einzigen ID durch ein Log folgt, macht aus einer Textwand eine einzige Geschichte mit Anfang, Mitte und Ende.

Schritt zwei: den Stack von oben lesen

Eine Exception-Zeile nennt Ihnen Typ und Meldung. Die Frames darunter zeigen, wo das Programm gerade stand. Lesen Sie nach unten, bis Sie die ersten Frames erreichen, die zu Ihrem eigenen Code gehören, denn diese nennen die Datei und die Zeile, die Sie sich ansehen sollten.

`` 12:04:13 ERROR TypeError: plan.period is undefined at applyPromo (pricing.ts:88) at updateTotal (cart.ts:41) at onPromoSubmit (checkout.ts:130) ``

In diesem Beispiel liegt der Fehler in applyPromo, aufgerufen von der Warenkorbsumme, die wiederum beim Absenden eines Promo-Codes aufgerufen wird. Damit haben Sie bereits ein Verb für Ihren ersten Schritt: einen Promo-Code auf einen Warenkorb anwenden.

Schritt drei: ansehen, was direkt davor kam

Die Zeilen vor dem Fehler zeigen den Zustand, in dem sich das Programm befand. Vielleicht hat sich einen Moment zuvor eine Einstellung geändert. Vielleicht wurde ein Wert von einer Stelle geladen, an der er fehlte. Im Beispiel könnte das Log ein paar Zeilen weiter oben zeigen, dass der Abrechnungszeitraum von monatlich auf jährlich umgestellt wurde. Das ist ein Hinweis auf die Eingabe, die zum Fehler geführt hat.

Notieren Sie die Werte, die Sie sehen: den Tarifnamen, den eingegebenen Code, die geänderte Einstellung, die Reihenfolge der Aktionen. Die Reihenfolge zählt. Ein Fehler, der erst A und dann B braucht, zeigt sich nicht, wenn Sie erst B und dann A ausführen.

Schritt vier: aus den Hinweisen Schritte machen

Jetzt haben Sie genug, um etwas zu schreiben, dem eine Person folgen kann.

  1. Schreiben Sie die Aktionen des Nutzers in der Reihenfolge auf, die das Log zeigt.
  2. Ersetzen Sie alles, was nur für eine Person gilt, durch einen Platzhalter, den Tester wiederverwenden können, etwa ein Testkonto.
  3. Behalten Sie die Werte, die relevant wirken, etwa den Promo-Code und den Tarif. Den Rest lassen Sie weg.
  4. Führen Sie die Schritte aus. Erscheint derselbe Fehler, haben Sie eine Reproduktion. Wenn nicht, ändern Sie jeweils eine Sache: den Build, den Kontotyp, die Daten, die Reihenfolge.

Jeweils nur eine Sache zu ändern fühlt sich langsam an und ist in Wahrheit schnell. Ändern Sie drei Dinge, sagt Ihnen ein Erfolg gar nichts.

Schritt fünf: zählen, wie oft es passiert

Führen Sie die Schritte einige Male aus und notieren Sie das Ergebnis. Ein Fehler, der jedes Mal auftritt, deutet auf einen Logikfehler hin. Ein Fehler, der nur ab und zu auftritt, deutet oft auf Timing, Last oder Daten hin, die sich zwischen den Durchläufen unterscheiden. Nennen Sie die Häufigkeit im Bericht, denn sie bestimmt, wo ein Entwickler ansetzt.

Schritt sechs: das Log kürzen, bevor Sie es weitergeben

Ein Log, das Sie an ein Ticket anhängen, wird von mehr Menschen gelesen, als Sie erwarten, und es kann Dinge enthalten, die nicht in einen Tracker gehören.

  • Behalten Sie den nützlichen Teil. Die Fehlerzeile, den Stack und ein paar Zeilen davor. Geben Sie an, aus welcher Stelle der Datei der Auszug stammt.
  • Maskieren Sie personenbezogene Daten. E-Mail-Adressen, Namen und alles, was eine Person identifiziert.
  • Maskieren Sie Geheimnisse. Zugriffstokens, API-Schlüssel und Passwörter. Ein Token in einem Ticket kann jeder lesen, der das Ticket öffnen kann.
  • Prüfen Sie mit eigenen Augen. Automatisches Maskieren hilft, geschieht aber nur nach besten Kräften, also sehen Sie sich das Ergebnis an, bevor Sie es anhängen.

Was ins Ticket gehört

Nennen Sie die gefundenen Schritte, was Sie erwartet haben, was passiert ist, den Build und die Häufigkeit, und hängen Sie den gekürzten Auszug an. Ein Entwickler, der das liest, kann das Problem in Minuten statt Stunden nachstellen. Wenn Sie eine Vorlage suchen, geht die Vorlage für Fehlerberichte jeden Teil durch.

Wo BugIt ins Spiel kommt

Logs lesen zu können ist eine wertvolle Fähigkeit, bei einem langen Log aber auch eine lästige Pflicht. Wenn Sie ein Log in BugIt einfügen, behält es die Fehlerzeile und den Stack, auf die es ankommt, lässt das Rauschen drumherum weg und nutzt das Gefundene, um die Schritte und die Umgebung in den Entwurf zu schreiben. BugIt schwärzt gängige personenbezogene Daten nach besten Kräften, daher lesen Sie den Entwurf, bevor er angelegt wird. Sie prüfen jeden Entwurf, und nichts wird in Ihren Tracker geschrieben, bevor Sie FILE IT eingeben.

Mehr erfahren Sie unter bugit.dev und taskivator.com/bugit.

Das Wichtigste in Kürze

Finden Sie den ersten Fehler, lesen Sie den Stack von oben, sehen Sie sich an, was direkt davor kam, und schreiben Sie die Schritte in der Reihenfolge auf, die das Log zeigt. Ändern Sie jeweils eine Sache, wenn sich der Fehler nicht wiederholt, halten Sie fest, wie oft er auftritt, und kürzen und maskieren Sie das Log, bevor Sie es weitergeben. Ein Log ist ein geduldiger Zeuge. Stellen Sie ihm die richtigen Fragen, und es verrät Ihnen, wie sich das Problem wiederholen lässt.

Jetzt verfügbarQA-Agent für Ihren KI-Assistenten

BugIt

Deutsch