- AppSignal mit Ihrem GitLab-Repository verknüpfen, damit AppSignal weiß, wo sich Ihr Code befindet.
- Backtraces mit Revisionen und Zeilen verknüpfen, damit jede Backtrace-Zeile den Code öffnet, der ausgeliefert wurde.
- GitLab-Issues für Vorfälle erstellen, direkt vom Detailbildschirm eines Vorfalls aus.
GitLab bietet mehrere Möglichkeiten, sich mit Tools von Drittanbietern zu
verbinden. AppSignal stellt die Verbindung über ein persönliches
GitLab-Zugriffstoken und Ihre Projekt-URL her, was auf GitLab.com, GitLab
Self-Managed und GitLab Dedicated unterstützt wird. GitLab bietet auch
OAuth-Anwendungen an, aber AppSignal unterstützt die Verbindung zu GitLab über
OAuth noch nicht.
AppSignal mit Ihrem GitLab-Repository verknüpfen
Schritt 1. Ein persönliches GitLab-Zugriffstoken erstellen
- Melden Sie sich bei GitLab an und gehen Sie zu Ihren Benutzer-Einstellungen.
- Wählen Sie in der linken Seitenleiste Access tokens aus und öffnen Sie dann Personal access tokens (
https://gitlab.com/-/user_settings/personal_access_tokensauf GitLab.com). - Wählen Sie Add new token. GitLab lässt Sie entweder ein fine-grained oder ein legacy personal access token erstellen. Wählen Sie legacy, da dessen Scopes direkt den Anforderungen von AppSignal entsprechen.
- Füllen Sie aus:
- Token name:
AppSignal - Expiration date: Wählen Sie ein Datum, das den Richtlinien Ihrer Organisation entspricht.
- Scopes: Wählen Sie
read_api,read_repositoryundapiaus. AppSignal benötigt alle drei.
- Token name:
- Wählen Sie Create personal access token und kopieren Sie das Token sofort. GitLab zeigt es nur einmal an.
Fine-grained Tokens funktionieren möglicherweise ebenfalls, aber ihre
Ressourcenberechtigungen sind weitaus granularer, und es ist nicht
offensichtlich, welche Kombination Sie wählen sollten. Wir planen, diese
Integration auf GitLab-OAuth-Anwendungen umzustellen, die neuere Art, Tools
von Drittanbietern mit GitLab zu verbinden.
Schritt 2. Die Integration in AppSignal hinzufügen
- Öffnen Sie in AppSignal die App, die Sie verbinden möchten.
- Gehen Sie zu App-Einstellungen → Integrationen → GitLab.
- Füllen Sie das Formular aus:
- Token: Fügen Sie das persönliche Zugriffstoken ein, das Sie in Schritt 1 erstellt haben.
- GitLab-URL: Die vollständige URL zum GitLab-Projekt, zum Beispiel
https://gitlab.com/your-namespace/your-project. Für GitLab Self-Managed verwenden Sie den Hostnamen Ihrer Instanz, z. B.https://gitlab.example.com/your-group/your-project.
- Wählen Sie Integration erstellen.
Schritt 3. Für jeden Benutzer wiederholen
Da dies eine persönliche Integration ist, muss jedes Teammitglied, bei dem Quell-Links, Backtrace-Links oder die Erstellung von Issues im eigenen AppSignal-Account funktionieren sollen, die Schritte 1 und 2 mit dem eigenen GitLab-Token wiederholen.Backtraces mit Revisionen und Zeilen verknüpfen
Codebasen ändern sich ständig, daher ist ein Backtrace am nützlichsten, wenn er auf die Revision verweist, die zum Zeitpunkt des Fehlers deployt war. Das Verbinden von GitLab füllt die Repo URL Ihrer App automatisch aus, sodass Sie sie nicht von Hand eingeben müssen. Sie können sie unter App-Einstellungen → Allgemein bestätigen, wo das Feld die URL Ihres GitLab-Projekts enthält. AppSignal erkennt den Anbieter anhand dieser URL und erstellt die passenden Backtrace- und Vergleichslinks. Sobald Deploy-Marker die deployterevision melden, verknüpft AppSignal jede Backtrace-Zeile mit der passenden Revision, dem Pfad und der Zeile in Ihrem GitLab-Repository, sodass Sie von einem Fehler direkt zum ausgelieferten Code gelangen. Die vollständige Einrichtung finden Sie in der Dokumentation zu Backtrace-Links.
GitLab-Issues für Vorfälle erstellen
AppSignal erstellt keine GitLab-Issues automatisch, um eine Überflutung mit Stories zu vermeiden. So erstellen Sie eines für einen Fehler-Vorfall:- Öffnen Sie den Detailbildschirm des Fehler-Vorfalls.
- Wählen Sie im Panel Actions die Option Send to GitLab.
api-Scope zusätzlich zu den Lese-Scopes, die in Schritt 1 beschrieben sind.
Deploy-Marker aus GitLab CI/CD
Um Deployments aus einer GitLab CI/CD-Pipeline an AppSignal zu melden, lesen Sie die Deploy-Marker-Dokumentation für den empfohlenen Ansatz mit derrevision-Konfigurationsoption oder das Markers-API-Beispiel, falls Ihr Stack keine AppSignal-Integration enthält.
Fehlerbehebung
Das Senden eines Vorfalls an GitLab schlägt fehl. Ein Token mit schreibgeschützten Scopes verbindet sich erfolgreich, kann aber keine Issues erstellen. Bestätigen Sie, dass das Tokenapi sowie read_api und read_repository hat. Da Scopes nach der Erstellung eines Tokens nicht mehr bearbeitet werden können, erstellen Sie ein neues legacy Token mit allen drei und aktualisieren Sie die Integration in AppSignal.
AppSignal meldet die GitLab-Integration als ungültig.
Prüfen Sie, welche Scopes das Token tatsächlich hat. read_registry und read_repository stehen in GitLabs Scope-Liste direkt nebeneinander, und ein Token, das read_registry statt read_api gewährt, kann Ihr Projekt nicht lesen.
Quell-Links in AppSignal öffnen nicht die richtige Datei.
Öffnen Sie erneut App-Einstellungen → Integrationen → GitLab in AppSignal und bestätigen Sie, dass die GitLab-URL auf das Projektstammverzeichnis verweist (z. B. https://gitlab.com/namespace/project) und nicht auf einen Unterpfad, einen Branch oder eine .git-URL.