Zum Hauptinhalt springen
Sobald Sie die AppSignal-GitHub-Integration installiert, AppSignal die Berechtigung erteilt haben, Issues in Ihren GitHub-Repositories zu lesen und zu schreiben, und Ihre AppSignal-App mit dem gewünschten Repo verbunden haben, können Sie AppSignal-Vorfälle in GitHub-Issues umwandeln. Sie können auch bereits vorhandene Issues und Pull Requests verknüpfen und ihren Status vom Vorfall aus verfolgen.

Ein GitHub-Issue aus einem Vorfall erstellen

Öffnen Sie den relevanten Namespace Ihrer AppSignal-Anwendung, wählen Sie Errors in der Seitennavigation aus und dann Issue list. Öffnen Sie den Fehlervorfall, den Sie an GitHub senden möchten. Wählen Sie auf dem Tab Summary des Vorfalls Send to GitHub im Panel Actions aus. Zusammenfassungsseite eines Fehlervorfalls mit der Aktion „Send to GitHub“ im Panel „Actions“ Dadurch wird ein Bildschirm geöffnet, über den Sie ein GitHub-Issue erstellen können. AppSignal füllt Titel und Beschreibung für Sie aus. Die Beschreibung enthält einen Link zum AppSignal-Vorfall, die Fehlermeldung und, falls zutreffend, bis zu den letzten 10 Zeilen des Backtrace. Sie können Titel und Beschreibung ändern, wir empfehlen jedoch, den Vorfall-Link und den Backtrace zu behalten. Bildschirm zum Erstellen eines GitHub-Issues mit vorausgefülltem Titel und vorausgefüllter Beschreibung Wählen Sie Create GitHub issue aus, um das Issue im GitHub-Repo zu erstellen, mit dem der Namespace Ihrer Anwendung verbunden ist. Das neue Issue erscheint im Panel Actions, und das Logbuch des Vorfalls verzeichnet Sent the issue to GitHub. Wenn AppSignal das Issue nicht erstellen kann, zeigt der Erstellungsbildschirm den Grund an. Entweder ist Ihre App noch nicht mit einem GitHub-Repository verknüpft, oder die AppSignal-GitHub-App hat keine Berechtigung Issues (Schreiben) oder keinen Zugriff auf das Repository. Wie Sie beides beheben, erfahren Sie unter AppSignal mit dem Repository Ihrer App auf GitHub verknüpfen. Sie können das Repo, mit dem die Namespaces Ihrer AppSignal-Anwendung verbunden sind, in den Einstellungen Ihrer AppSignal-Anwendung ändern. Sie können auch die Zugriffsrechte von AppSignal in den Einstellungen Ihrer GitHub-Integration verwalten. Oft ist der Fix bereits in Arbeit: Jemand hat einen Pull Request geöffnet, oder für den Bug gibt es ein GitHub-Issue. Fügen Sie dessen Link in eine Notiz ein, und AppSignal verfolgt ihn für Sie. Der Vorfall zeigt, wie es um den Fix steht, und niemand muss nachfragen, ob er ausgeliefert wurde. Öffnen Sie den Tab Summary des Vorfalls, schreiben Sie im Feld Logbook eine Notiz mit der URL des GitHub-Issues und wählen Sie Post note aus. AppSignal erkennt zwei Formen von Verweisen an beliebiger Stelle in der Notiz:
  • Eine vollständige URL, zum Beispiel https://github.com/acme/shop/issues/123 oder https://github.com/acme/shop/pull/456.
  • Die Kurzform acme/shop#123.
AppSignal verknüpft nur Verweise auf Repositories der GitHub-Organisation oder des Benutzer-Accounts, der das verknüpfte Repository gehört. Eine App, die mit acme/shop verknüpft ist, verknüpft auch Verweise auf acme/shop-api, ignoriert aber Verweise auf andere Organisationen. Ein bereits verknüpftes Issue wird nicht erneut verknüpft, sodass beim Bearbeiten der Notiz keine Duplikate entstehen. Das Logbuch verzeichnet Linked #123 on GitHub, wobei die Nummer auf das Issue verlinkt. Das Issue erscheint außerdem mit seinem Status im Panel Actions. Vorfall-Zusammenfassung mit einer Notiz, die eine GitHub-Issue-URL enthält, dem Logbuch-Eintrag „Linked #6 on GitHub“ und der Aktion „View #6 in GitHub“ mit einem Open-Badge Der AppSignal-MCP-Server verknüpft Issues auf dieselbe Weise, wenn ein KI-Agent eine Notiz zu einem Vorfall schreibt. So verknüpfen Sie einen Vorfall von GitHub aus:
  1. Kopieren Sie die URL des Vorfalls aus AppSignal.
  2. Fügen Sie sie in die Beschreibung eines GitHub-Issues oder Pull Requests ein, mit einem Wort davor. Zum Beispiel: Fixes <incident URL>.
  3. Erstellen Sie das Issue oder den Pull Request, oder speichern Sie Ihre Bearbeitung.
Das Issue oder der Pull Request erscheint jetzt im Panel Actions und im Logbuch des Vorfalls. Großbuchstaben und ein Doppelpunkt nach dem Wort, etwa Fixes:, funktionieren ebenfalls.
Das Logbuch eines Vorfalls in AppSignal mit zwei von GitHub hinzugefügten Einträgen: ein referenziertes und ein verknüpftes Issue, jeweils mit einem github-Badge, über einer früheren Verknüpfung, die aus einer Notiz hinzugefügt wurde

Von GitHub aus verknüpfte und referenzierte Issues im Logbuch des Vorfalls.

Gut zu wissen:
  • Das Issue oder der Pull Request muss sich in einem Repository derselben GitHub-Organisation oder desselben Benutzer-Accounts befinden wie das mit Ihrer App verknüpfte Repository.
  • Wenn Sie die URL aus der Beschreibung entfernen, wird die Verknüpfung beim Vorfall nicht entfernt.
  • Das Logbuch zeigt, wer die Verknüpfung auf GitHub hinzugefügt hat.
  • Dieselben Wörter funktionieren in Notizen zum Vorfall. Zum Beispiel referenziert See acme/shop#123 das Issue.

Verknüpfte Issues vom Vorfall aus verfolgen

Das Panel Actions zeigt für jedes verknüpfte Issue und jeden verknüpften Pull Request eine Schaltfläche mit der Beschriftung View #123 in GitHub. Die Schaltflächen erscheinen in der Reihenfolge, in der die Issues verknüpft wurden. Bewegen Sie den Mauszeiger über eine Schaltfläche, um zu sehen, wann das Issue verknüpft oder referenziert wurde. Wählen Sie sie aus, um das Issue auf GitHub zu öffnen oder das Issue neu zu erstellen. Beim Neuerstellen wird die Verknüpfung entfernt und der Erstellungsbildschirm erneut geöffnet. Jede Schaltfläche zeigt den Status des Issues als Badge: Open, Closed oder, bei Pull Requests, Merged oder Live. AppSignal liest den Status, wenn Sie ein Issue verknüpfen. Der Status wird aktualisiert, wenn das Issue oder der Pull Request auf GitHub geschlossen, wieder geöffnet oder zusammengeführt wird. Jede Statusänderung erscheint auch im Logbuch des Vorfalls, zum Beispiel Changed the status of #123 on GitHub from open → merged. Der Eintrag zeigt, wer die Änderung auf GitHub vorgenommen hat. Wenn diese Person Mitglied Ihrer AppSignal-App ist und ihren GitHub-Account verknüpft hat, zeigt der Eintrag ihren AppSignal-Namen. Statusaktualisierungen benötigen die Berechtigungen Issues und Pull requests der AppSignal-GitHub-App. Wenn AppSignal diese anfordert, muss ein Owner Ihrer GitHub-Organisation die neuen Berechtigungen auf GitHub genehmigen. Ohne sie funktioniert das Verknüpfen weiterhin, aber verknüpfte Issues zeigen kein Status-Badge.

Sehen, wann ein verknüpfter Pull Request deployt ist

Sobald ein Deploy einen verknüpften Pull Request ausliefert, wechselt sein Badge von Merged zu Live. Bewegen Sie den Mauszeiger über die Schaltfläche, um die Revision des Deploys und seinen Zeitpunkt zu sehen, zum Beispiel Deployed in 9175503 2 minutes ago. Das Logbuch verzeichnet die Änderung als Changed the status of #20 on GitHub from merged → deployed, vorgenommen von AppSignal.
Der Tab Summary eines Vorfalls in AppSignal. Das Logbuch zeigt, dass AppSignal den Status von #20 auf GitHub von merged zu deployed geändert hat. Im Panel Actions hat View #20 in GitHub ein Live-Badge, und ein Tooltip zeigt Deployed in 9175503 2 minutes ago

Ein verknüpfter Pull Request zeigt Live, sobald ein Deploy ihn ausliefert.

Wenn AppSignal einen Deploy-Marker für einen neuen Deploy erstellt, fragt es GitHub, welche Commits seit dem vorherigen Deploy im selben Namespace hinzugekommen sind. Wenn ein verknüpfter Pull Request in einem dieser Commits zusammengeführt wurde, wechselt er zu Live. Damit ein Pull Request Live zeigt, benötigen Sie:
  1. Eine Verknüpfung, keine Referenz. Setzen Sie ein verknüpfendes Wort wie Fixes oder gar kein Wort vor den Link, auf GitHub oder in einer Notiz zum Vorfall. Ein referenzierter Pull Request, etwa See acme/shop#123, bleibt Merged.
  2. Ihre App mit dem Repository des Pull Requests verknüpft. Siehe AppSignal mit dem Repository Ihrer App auf GitHub verknüpfen.
  3. Einen Deploy-Marker für jeden Deploy, mit einer Revision, die GitHub kennt: einem Commit-SHA, einem Tag oder einem Branch-Namen. Siehe Revisionswert wählen.
  4. Die Berechtigungen Contents, Issues und Pull requests der AppSignal-GitHub-App. Wenn AppSignal neue Berechtigungen anfordert, muss ein Owner Ihrer GitHub-Organisation sie auf GitHub genehmigen.
AppSignal verfolgt Folgendes nicht:
  • Einen Pull Request, den Sie erst nach dem Deploy verknüpfen, der ihn ausgeliefert hat.
  • Einen Deploy mit mehr als 1.000 Commits.
  • Eine Revision, die GitHub nicht kennt, etwa eine Build-Nummer oder 1.2.3, wenn der Tag v1.2.3 lautet.
  • Rollbacks. Ein Pull Request bleibt Live, nachdem Sie den Deploy, der ihn ausgeliefert hat, zurückgerollt haben.
  • Den genauen Commit eines Branch-Deploys. Wenn die Revision ein Branch-Name ist, verwendet AppSignal bei der Prüfung den neuesten Commit des Branches. Dieser Commit kann neuer sein als der, den Sie deployt haben.
  • Denselben Deploy zweimal. Wenn ein Deploy in mehreren Namespaces einen Deploy-Marker hat, wechselt der Pull Request nur einmal zu Live.
  • Einen Deploy, den GitHub nicht vergleichen kann. Wenn GitHub einen Fehler zurückgibt, bleibt der Pull Request Merged, und AppSignal zeigt den Fehler nicht an.
  • Einen fehlgeschlagenen Logbuch-Eintrag. Wenn das Speichern fehlschlägt, nachdem der Pull Request zu Live gewechselt ist, versucht AppSignal es nicht erneut.

Den Vorfall schließen, wenn sein Fix deployt ist

Diese Funktion ist in der Beta, als Teil von AppSignal Labs. Bitten Sie den Support, sie für Ihre Organisation zu aktivieren.
So lassen Sie AppSignal einen Vorfall schließen, wenn sein Fix ausgeliefert wird:
  1. Schreiben Sie in die Beschreibung des Pull Requests auf GitHub Fixes <incident URL>. Sie können auch die URL des Pull Requests in einer Notiz zum Vorfall posten.
  2. Führen Sie den Pull Request zusammen.
  3. Deployen Sie ihn. AppSignal muss den Deploy sehen, damit der Pull Request zu Live wechselt.
AppSignal schließt den Vorfall dann. Das Logbuch verzeichnet den Wechsel zu Closed mit einem deploy-Badge und nennt den Pull Request. Gut zu wissen:
  • Der Vorfall muss offen sein. Sein Status muss Open oder Work in progress sein.
  • Verknüpfen Sie den Pull Request, statt ihn zu referenzieren. Fügen Sie die URL des Vorfalls in die Beschreibung des Pull Requests ein oder die URL des Pull Requests in eine Notiz zum Vorfall. Setzen Sie Fixes oder gar kein Wort vor die URL. Ein Wort wie See vor der URL referenziert sie nur, und eine Referenz schließt den Vorfall nie.
  • AppSignal wartet auf jeden zusammengeführten Pull Request. Wenn der Vorfall mehr als einen hat, schließt AppSignal ihn, sobald der letzte Live ist. Verknüpfte Issues und noch nicht zusammengeführte Pull Requests halten ihn nicht offen.
  • Fehler aus altem Code öffnen ihn nicht wieder. Während ein Deploy ausgerollt wird, können Hosts, die noch einen älteren Deploy ausführen, den Fehler melden. Diese Fehler zählen zum Vorfall, öffnen ihn aber nicht wieder und senden keine Benachrichtigungen. Ein Fehler aus dem neuen Deploy oder einem späteren öffnet ihn wie gewohnt wieder.
  • Ihre Änderungen haben Vorrang. Wenn Sie den Vorfall wieder öffnen, schließt ihn ein erneuter Deploy derselben Revision nicht. Sobald sich der Status des Vorfalls wieder ändert, können Fehler aus älteren Deploys ihn wieder öffnen, wie jeder andere Fehler.
Der Vorfall ist jetzt der zentrale Ort, um den Stand eines Fixes zu prüfen: welche Issues und Pull Requests dazugehören und ob jeweils offen, zusammengeführt, geschlossen oder live. Um von einer Backtrace-Zeile zum ausgelieferten Code zu springen, richten Sie als Nächstes Backtrace-Links ein.
🛟 Falls Sie Probleme beim Erstellen von GitHub-Issues für AppSignal-Vorfälle haben, nehmen Sie bitte Kontakt mit uns auf, und wir helfen Ihnen gerne weiter.