Projekt, Dienst, Umgebung
Projekt einrichten
Installieren Sie die CLI. Führen Sielogbrew status --json
aus, um Ihren Kontozugriff zu lesen. Ist der Zugriff nicht gültig, führt ein
Mensch logbrew login aus. Mit einem Projekt-Ingest-Schlüssel können Sie sich
nicht anmelden.
1
Projekt anlegen oder auswählen
Listen Sie zuerst Ihre Projekte auf. Legen Sie ein Projekt nur an, wenn es
noch nicht existiert.Die CLI schreibt den Ingest-Schlüssel in eine neue Datei, die nur der
Eigentümer lesen kann. Sie gibt weder den Schlüssel noch den Dateipfad
aus. Ist das Ergebnis unklar, führen Sie genau denselben Befehl erneut
aus. Ändern Sie dabei weder den Projektnamen noch die Schlüsseldatei. Die
CLI verwendet die Identität ihrer ausstehenden Anfrage erneut. Der
Schnellstart zeigt, wie Sie die Projekt-ID aus dem
Ergebnis lesen.Erfassen Sie für ein bestehendes Projekt den Einrichtungsstatus:Einen weiteren Ingest-Schlüssel für ein bestehendes Projekt erstellen Sie
mit
logbrew projects keys create. Den Befehl zeigt der
Leitfaden zur Rotation von Ingest-Schlüsseln.logbrew setup --create-project zeigt nur die Hilfe an. Es legt kein
Projekt an.2
Dienstnamen im SDK festlegen
Verwenden Sie Namen aus Ihrem Repository und Ihrer Bereitstellung, zum
Beispiel
api, worker, web, ios oder checkout-api. Ein Dienstname
ist eine Bezeichnung, keine Projektauswahl. Der Ingest-Schlüssel wählt das
Projekt aus. Wenn Sie einen Dienst umbenennen, werden gespeicherte
Ereignisse nicht verschoben. Finden Sie ein Ereignis nicht, prüfen Sie
zuerst das Projekt und den Ingest-Schlüssel, die die Anwendung verwendet,
bevor Sie ein weiteres Projekt anlegen.3
Standardumgebungen verwenden
Verwenden Sie
production, staging, preview und local. Nutzt Ihre
Bereitstellung andere Namen, verwenden Sie diese einheitlich. Ein
Umgebungsname darf keine Leerzeichen, kein / und keinen Backslash
enthalten.4
Testereignis senden und lesen
Konfigurieren Sie das SDK mit dem Projekt-Ingest-Schlüssel, wie im
Leitfaden zur SDK-Integration beschrieben.
Das Anlegen eines Projekts installiert kein SDK in Ihrer Anwendung.
Halten Sie den Schlüssel aus der Versionsverwaltung heraus. Legen Sie
Dienst, Umgebung und Release in der Anwendung fest. Senden Sie ein
sicheres Ereignis, und lesen Sie es dann:Jedes Signal hat eine eigene Liste. Eine leere Log-Liste bedeutet nicht,
dass das Projekt keine Issues oder Traces hat.Wählen Sie im Dashboard dasselbe Projekt und einen Zeitraum, der das
Testereignis enthält. Prüfen Sie, dass die Filter für Dienst, Umgebung
und Release zum Ereignis passen.
Projekteinrichtung diagnostizieren
Lesen Sie den Einrichtungsstatus mit dem Projekt-Doctor. Schließen Sie nicht aus lokalen Dateien oder einer leeren Log-Abfrage auf den Einrichtungsstatus.status, checks und next. Der Exit-Code
0 zeigt nicht, dass alle Prüfungen bestanden wurden. Lesen Sie jeden
Eintrag in checks. Siehe
Bericht des Projekt-Doctors lesen.
Direkte API-Antwort
API-Clients rufenGET /api/projects/{project_id}/doctor mit
Kontoauthentifizierung auf. Der Endpunkt hat keine Query-Parameter und keinen
Anfrage-Body. Verwenden Sie für diesen Lesezugriff nie einen
Projekt-Ingest-Schlüssel.
Eine 200-Antwort hat diese Schlüssel: project_id, state, setup_status,
setup_acknowledged, has_active_ingest_key, first_telemetry_seen_at,
last_seen_at, last_signal, next und next_action. Zeitstempel sind
RFC3339 oder null. last_signal ist eine sicher anzeigbare Zusammenfassung,
kein rohes Signal.
Der Doctor prüft zuerst den Ingest-Schlüssel. Ein Projekt ohne aktiven
Ingest-Schlüssel ist
needs_ingest_key, unabhängig vom Einrichtungsstatus.
setup_status ist created, setup_started, sdk_seen,
first_telemetry_seen oder active. setup_acknowledged ist nur bei den
letzten drei Werten true. created ergibt needs_setup. setup_started
und sdk_seen ergeben needs_telemetry. first_telemetry_seen und active
ergeben ready.
Schlägt der Lesezugriff weiterhin fehl, nutzen Sie Problem melden.
Geben Sie keine Zugangsdaten, Header, Signal-Inhalte, Kundendaten, lokalen
Pfade oder Quellcode an.
Projekt archivieren oder löschen
Archivieren Sie ein Projekt, um es aus der Liste aktiver Projekte zu entfernen:--yes. Nach dem Archivieren nehmen die
Ingest-Schlüssel des Projekts keine neue Telemetrie mehr an. Die API-Route ist
DELETE /api/projects/{project_id}. Sie liefert 204 ohne Body. Archivierte
Projekte listen Sie mit GET /api/projects/archived auf. Ein Projekt stellen
Sie mit POST /api/projects/{project_id}/restore wieder her. Auch diese Route
liefert 204.
Löschen Sie ein Projekt nur dann endgültig, wenn Sie sicher sind:
--confirm. Eine angenommene
Anfrage macht das Projekt sofort inaktiv und plant die endgültige Löschung.
Danach können Sie das Projekt nicht wiederherstellen.