Logeinträge mit der gcloud CLI schreiben und abfragen
In diesem Dokument werden einige der Funktionen von Cloud Logging vorgestellt und es wird beschrieben, wie Sie Folgendes tun:
- Logeinträge mit der Google Cloud CLI schreiben
- Logeinträge mit der gcloud CLI auflisten
- Logeinträge über die Logging API auflisten
- Logeinträge mit dem Log-Explorer aufrufen und abfragen
Hinweis
Sie benötigen ein Cloud de Confiance -Projekt mit aktivierter Abrechnung, um diese Kurzanleitung durchzuarbeiten. Wenn Sie kein Cloud de Confiance -Projekt haben oder die Abrechnung für Ihr Cloud de Confiance -Projekt nicht aktiviert ist, gehen Sie so vor:-
Installieren Sie die Google Cloud CLI.
-
Konfigurieren Sie die gcloud CLI für die Verwendung Ihrer föderierten Identität.
Weitere Informationen finden Sie unter Mit Ihrer föderierten Identität in der gcloud CLI anmelden.
-
Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:
gcloud init -
Cloud de Confiance Projekt erstellen oder auswählen
Erforderliche Rollen zum Auswählen oder Erstellen eines Projekts
- Projekt auswählen: Für die Auswahl eines Projekts ist keine bestimmte IAM-Rolle erforderlich. Sie können jedes Projekt auswählen, für das Ihnen eine Rolle zugewiesen wurde.
-
Projekt erstellen: Zum Erstellen eines Projekts benötigen Sie die Rolle „Project Creator“ (
roles/resourcemanager.projectCreator), die die Berechtigungresourcemanager.projects.createenthält. Informationen zum Zuweisen von Rollen
-
So erstellen Sie ein Cloud de Confiance Projekt:
gcloud projects create PROJECT_ID
Ersetzen Sie
PROJECT_IDdurch einen Namen für das Cloud de Confiance Projekt, das Sie erstellen. -
Wählen Sie das von Ihnen erstellte Cloud de Confiance Projekt aus:
gcloud config set project PROJECT_ID
Ersetzen Sie
PROJECT_IDdurch Ihren Cloud de Confiance Projektnamen.
-
Wenn Sie für diese Anleitung ein vorhandenes Projekt verwenden, prüfen Sie, ob Sie die erforderlichen Berechtigungen haben. Wenn Sie ein neues Projekt erstellt haben, haben Sie bereits die erforderlichen Berechtigungen.
-
Prüfen Sie, ob die Abrechnung für Ihr Cloud de Confiance Projekt aktiviert ist.
Erforderliche Rollen
Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Logging Admin (roles/logging.admin) für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Erstellen, Auflisten und Löschen von Logeinträgen benötigen.
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.
Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
Die Rollen „Logs Writer“ (roles/logging.logWriter) und „Logs Viewer“ (roles/logging.viewer) enthalten die Berechtigungen zum Erstellen und Auflisten von Logeinträgen. Um Logeinträge zu löschen, weisen Sie die Rolle „Logging Admin“ (roles/logging.admin) zu, die die Berechtigungen zum Erstellen, Auflisten und Löschen von Logeinträgen enthält. Die Rolle „Logging-Administrator“ (roles/logging.admin) gewährt auch Berechtigungen zum Ausführen aller Aktionen in Logging.
Logeinträge mit der gcloud CLI schreiben
Logging unterstützt Logeinträge mit strukturierten und unstrukturierten Daten. Strukturierte Daten bestehen aus einer JSON-Datenstruktur, z. B. {"weather": "partly cloudy"}. Unstrukturierte Daten sind Strings, wie zum Beispiel "A simple entry".
In den nächsten Schritten verwenden Sie die gcloud CLI, um einen Logeintrag mit unstrukturierten Daten und einen Logeintrag mit strukturierten Daten zu schreiben. Die gcloud CLI bietet eine Befehlszeile für die Cloud Logging API.
Wenn Sie einen Logeintrag mit unstrukturierten Daten in das Log
my-test-logschreiben möchten, führen Sie den Befehlgcloud logging writeaus:gcloud logging write my-test-log "A simple entry."Nach Verarbeitung des Befehls wird die folgende Meldung angezeigt:
Created log entry.Schreiben Sie einen Logeintrag mit strukturierten Daten in das Log
my-test-log:gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'Zum Schreiben eines Logeintrags mit strukturierten Daten müssen Sie
--payload-type=jsonangeben. Wenn Sie dieses Feld weglassen, interpretiert Logging die Nutzlast als unstrukturierte Daten.
Wenn das Log my-test-log nicht vorhanden ist, wird es von Logging erstellt, sobald der Logeintrag empfangen wird.
Logeinträge mit der gcloud CLI auflisten
Sie können Logeinträge aus Logging abrufen und mit der gcloud CLI anzeigen. Führen Sie beispielsweise den folgenden Befehl aus, um die Logeinträge mit dem Ressourcentyp global abzurufen und anzuzeigen:
gcloud logging read "resource.type=global"
Das Ergebnis des Befehls sollte in etwa so aussehen:
---
insertId: jpj9zjf73t1mn
jsonPayload:
message: My second entry
weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
labels:
project_id: myloggingproject
type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
labels:
project_id: myloggingproject
type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'
Informationen zum Lesen von Logs finden Sie in der gcloud logging read-Referenzdokumentation.
Logeinträge im Log-Explorer abfragen
Wenn Sie Logeinträge in der Cloud de Confiance Console aufrufen möchten, können Sie den Log-Explorer verwenden. In den meisten Cloud de Confiance Projekten werden viele Logs gespeichert. Sie können bestimmte Logeinträge auswählen, indem Sie eine Abfrage schreiben.
So rufen Sie die Logeinträge auf, die Sie mit dem Log-Explorer geschrieben haben:
-
Rufen Sie in der Cloud de Confiance Console das und die Seite Log-Explorer auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis mit der Zwischenüberschrift Logging aus.
Achten Sie darauf, dass Ihr Cloud de Confiance Projekt in der Cloud de Confiance by S3NSNavigationsleiste ausgewählt ist. Wählen Sie bei Bedarf Ihr Cloud de Confiance Projekt aus der Drop-down-Liste Cloud de Confiance aus.
Wählen Sie im Menü Ressource die Option Global aus.
Wenn die Menüoption Global oder Ihre Logeinträge nicht angezeigt werden, warten Sie einige Minuten und aktualisieren Sie dann die Seite. Der Empfang von Logeinträgen durch Logging kann einige Minuten dauern.
Klicken Sie auf das chevron_right Menü eines Logeintrags, um die Details aufzurufen.
Die Daten des ersten Logeintrags werden in
textPayloadgespeichert. Der zweite Logeintrag enthält strukturierte Daten, die injsonPayloadgespeichert sind. Die strukturierte Nutzlast enthält die Schlüsselmessageundweather.
Informationen zum Datenformat von Logeinträgen finden Sie unter LogEntry-Typ.
Logeinträge im Log-Explorer abfragen
Sie können Logeinträge über den Abfrageeditor und bei strukturierten Logs nach Schlüssel und Wert abfragen. Wenn Sie beispielsweise alle Logeinträge aufrufen möchten, die den Text simple enthalten, gehen Sie so vor:
-
Rufen Sie in der Cloud de Confiance Console das und die Seite Log-Explorer auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis mit der Zwischenüberschrift Logging aus.
Wählen Sie im Menü Ressource die Option Global aus.
Geben Sie im Abfrageeditor den String
simplein Anführungszeichen ein. In der Loganzeige wird nur der LogeintragA simple entry.angezeigt.Nachdem Sie das Log aufgerufen haben, entfernen Sie den hinzugefügten Query-String und klicken Sie auf Abfrage ausführen. Beide Log-Einträge werden wieder in der Anzeige dargestellt.
So rufen Sie alle Logeinträge mit strukturierten Daten auf, die den Schlüssel weather haben, wobei das Feld value den Wert partly enthält:
Der Abfrageeditor enthält die Zeile
resource.type="global". Geben Sie den folgenden Befehl ein:jsonPayload.weather:partlyKlicken Sie auf Abfrage ausführen. Das Ergebnis ist der einzelne Logeintrag
My second entry:
Der Log-Explorer bietet auch gespeicherte, vorgeschlagene und aktuelle Abfragen. Weitere Informationen zu Abfragen finden Sie unter Abfragen im Log-Explorer erstellen.
Beispielabfragen finden Sie unter Beispielabfragen mit dem Log-Explorer.
Fehlerbehebung
Tippfehler und unbekannte Feldnamen führen dazu, dass die gcloud CLI-Befehle mit invalid argument-Meldungen abgeschlossen werden. Wenn Sie beispielsweise den Punkt in
resource.typevergessen, wird der folgende Fehler ausgegeben:ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.Wenn Cloud Logging nicht die erforderlichen Zugriffsberechtigungen erteilt wurden, werden die gcloud CLI-Befehle mit permission denied-Meldungen abgeschlossen. Wenn beispielsweise eine Compute Engine-VM-Instanz mit den Standard-API-Einstellungen konfiguriert ist, wird der Befehl
listmit einem Fehler vom Typ „Permission denied“ abgeschlossen:ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.Um dieses Problem zu beheben, ändern Sie die Berechtigungen Ihrer Compute Engine-VM-Instanz, um Cloud Logging die Leseberechtigung zu erteilen. Gehen Sie dazu so vor:
- Gehen Sie zur Seite VM-Instanzdetails Ihrer VM-Instanz. Klicken Sie auf Beenden. Es kann ein bis zwei Minuten dauern, bis der Vorgang abgeschlossen ist.
- Klicken Sie auf Bearbeiten, um die Konfiguration zu ändern.
- Suchen Sie nach dem Header Zugriffsbereiche für Cloud API und klicken Sie auf Details, um sich die Einstellungen für jede API anzeigen zu lassen. Ändern Sie den Eintrag für die Cloud Logging API zu Vollständiger Zugriff. Klicken Sie dann auf Speichern.
- Klicken Sie auf Starten, um die VM-Instanz neu zu starten. Nach wenigen Augenblicken ist die VM einsatzbereit.
Bereinigen
Löschen Sie das Projekt von Cloud de Confiance zusammen mit den Ressourcen, damit Ihrem Konto von Cloud de Confiance die auf dieser Seite verwendeten Ressourcen nicht in Rechnung gestellt werden.
(Optional) Führen Sie den folgenden
gcloud-Befehl aus, um die erstellten Logeinträge zu löschen:gcloud logging logs delete my-test-log
Wenn Sie Ihre Logbucheinträge nicht löschen, laufen sie ab und werden entfernt. Informationen zur Aufbewahrung finden Sie unter Kontingente und Limits.
Nächste Schritte
- Ausführliche Informationen zur Befehlszeilenschnittstelle von Logging finden Sie auf den Referenzseiten für die Befehlsgruppe
gcloud logging. - Dokumentation zur Logging API finden Sie unter Cloud Logging API.
- Weitere Informationen zum Log-Explorer finden Sie unter Log-Explorer verwenden.