Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Kurzanleitung: Logeinträge mit der gcloud CLI schreiben und abfragen

Logeinträge mit der gcloud CLI schreiben und abfragen

In diesem Dokument werden einige der Funktionen von Cloud Logging vorgestellt und folgende Schritte erläutert:

  • Logeinträge über die 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 Google Cloud-Projekt mit aktivierter Abrechnungsfunktion, um diese Kurzanleitung durchzuarbeiten. Wenn Sie kein Cloud-Projekt haben oder die Abrechnung für Ihr Cloud-Projekt nicht aktiviert ist, gehen Sie so vor:
  1. Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

  2. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  3. Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für ein Projekt aktiviert ist.

  4. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  5. Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für ein Projekt aktiviert ist.

Erste Schritte

Die gcloud-Befehlszeile enthält die Befehlsgruppe gcloud logging, die eine Befehlszeile für die Cloud Logging API bietet.

Sie können die Cloud Shell-Umgebung oder eine Compute Engine-VM-Instanz für die gcloud-Kommandozeilenbefehle in dieser Kurzanleitung verwenden. Die gcloud CLI ist in der Cloud Shell-Umgebung vorinstalliert.

Cloud Shell

Prüfen Sie, ob die gcloud-Befehlszeile für die Verwendung des richtigen Cloud-Projekts konfiguriert ist:

  1. Klicken Sie in der Google Cloud Console auf Cloud Shell aktivieren:

    Screenshot der Cloud Shell-Schaltfläche in der Google Cloud Console.

    Cloud Shell wird in einem Fenster mit einer Willkommensnachricht geöffnet. Die Willkommensnachricht gibt die konfigurierte Projekt-ID wieder:

    Screenshot von Cloud Shell mit einer Willkommensnachricht

  2. Wenn Sie ein anderes Cloud-Projekt als das in der Begrüßungsnachricht aufgeführte verwenden möchten, führen Sie den folgenden Befehl aus, nachdem Sie PROJECT_ID durch Ihre Projekt-ID ersetzt haben:

       gcloud config set project PROJECT_ID

    Informationen zum Abrufen der Projekt-ID finden Sie unter Projekte identifizieren.

VM-Instanz

So erstellen Sie eine Compute Engine-VM-Instanz in der Google Cloud Console:

  1. Wählen Sie in der Google Cloud Console Compute Engine und dann VM-Instanzen aus.

  2. Wählen Sie Instanz erstellen aus.

  3. Wählen Sie unter Identität und API-Zugriff unter Zugriffsbereiche die Option Zugriff für jede API festlegen aus.

  4. Scrollen Sie durch die APIs, bis Sie die Stackdriver Logging API finden. Stellen Sie den Zugriff auf Uneingeschränkt ein.

  5. Übernehmen Sie für alle anderen Einstellungen die Standardwerte und klicken Sie auf Erstellen. Die VM-Instanz ist einsatzbereit.

  6. Klicken Sie auf SSH, um eine Verbindung zur Shell Ihrer VM-Instanz herzustellen. Nach kurzer Zeit wird eine Debian GNU/Linux-Shell in einem Fenster geöffnet und eine Begrüßungsnachricht angezeigt.

  7. Führen Sie den folgenden Befehl aus, um zu prüfen, ob die gcloud CLI für Ihr Compute Engine-Projekt konfiguriert ist:

    gcloud config list

  8. Wenn Sie ein anderes Cloud-Projekt verwenden möchten, führen Sie den folgenden Befehl aus, nachdem Sie PROJECT_ID durch Ihre Projekt-ID ersetzt haben:

      gcloud config set project PROJECT_ID

    Informationen zum Abrufen der Projekt-ID finden Sie unter Projekte identifizieren.

Logeinträge mit der gcloud CLI schreiben

Logging unterstützt Logeinträge mit strukturierten und unstrukturierten Daten. Strukturierte Daten bestehen aus einer JSON-Datenstruktur, zum Beispiel {"weather": "partly cloudy"}. Unstrukturierte Daten sind Strings, wie zum Beispiel "A simple entry". In den nächsten Schritten schreiben Sie mit der gcloud CLI einen Logeintrag mit unstrukturierten Daten und einen Logeintrag mit strukturierten Daten:

  1. Logeintrag mit unstrukturierten Daten in das Log my-test-log schreiben:

    gcloud logging write my-test-log "A simple entry."

    Nach Verarbeitung des Befehls wird die folgende Meldung angezeigt: Created log entry.

  2. Logeintrag mit strukturierten Daten in das Log my-test-log schreiben:

    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=json angeben. 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 anzeigen zu lassen:

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'

Logeinträge mit APIs Explorer auflisten

Informationen zum Ausführen von Logging API-Methoden ohne Schreiben von Code finden Sie unter APIs Explorer verwenden. So lesen Sie eine Liste von Logeinträgen aus Logging:

  1. Rufen Sie die API-Referenzseite für die API-Methode entries.list auf:

    Weiter zur API-Seite "entries.list"

  2. Konfigurieren und führen Sie den API-Befehl aus:

    1. Ersetzen Sie PROJECT_ID im folgenden Text:

      "resourceNames": [
"projects/PROJECT_ID"
],
"filter": "resource.type=global",
"orderBy": "timestamp desc"

    2. Kopieren Sie den aktualisierten Text aus dem vorherigen Schritt und fügen Sie ihn in das Feld Anfragetext des APIs Explorer ein.

    3. Klicken Sie auf Ausführen.

    Die Methode gibt in etwa folgende Antwort zurück:

    {
  "entries": [
    {
      "textPayload": "A simple entry",
      "insertId": "vd4m1if7h7u1a",
      "resource": {
        "type": "global",
        "labels": {
          "project_id": "myloggingproject"
        }
      },
      "timestamp": "2018-11-01T18:39:19.718100792Z",
      "logName": "projects/myloggingproject/logs/my-test-log",
      "receiveTimestamp": "2018-11-01T18:39:19.718100792Z"
    },
    {
      "insertId": "jpj9zjf73t1mn",
      "jsonPayload": {
        "message": "My second entry",
        "weather": "partly cloudy"
      },
      "resource": {
        "type": "global",
        "labels": {
          "project_id": "myloggingproject"
        }
      },
      "timestamp": "2018-11-01T18:39:31.114507977Z",
      "logName": "projects/myloggingproject/logs/my-test-log",
      "receiveTimestamp": "2018-11-01T18:39:31.114507977Z"
    }
  ]
}

Logeinträge im Log-Explorer abfragen

Zum Aufrufen von Logeinträgen in der Google Cloud Console können Sie den Log-Explorer verwenden. Die meisten Cloud-Projekte speichern eine große Anzahl von Logs. Sie können bestimmte Logeinträge durch Schreiben einer Abfrage auswählen.

So rufen Sie die Logeinträge auf, die Sie mit dem Log-Explorer geschrieben haben:

  1. Rufen Sie in der Google Cloud Console den Log-Explorer auf:

    Zum Log-Explorer

    Achten Sie darauf, dass Ihr Cloud-Projekt in der Google Cloud-Navigationsleiste ausgewählt ist. Wählen Sie bei Bedarf in der Drop-down-Liste das Cloud-Projekt aus.

  2. 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.

  3. Klicken Sie auf das Menü , um die Details eines Logeintrags aufzurufen.

    Die Daten des ersten Logeintrags werden in textPayload gespeichert. Der zweite Logeintrag enthält strukturierte Daten, die in jsonPayload gespeichert sind. Die strukturierte Nutzlast enthält die Schlüssel message und weather.

Informationen zum Datenformat von Logeinträgen finden Sie unter LogEntry-Typ.

Logeinträge im Log-Explorer abfragen

Sie können Logeinträge mit dem Abfrageeditor und mit strukturierten Logs nach Schlüssel und Wert abfragen. So können Sie beispielsweise alle Logeinträge anzeigen lassen, die den Text simple enthalten:

  1. Rufen Sie in der Google Cloud Console den Log-Explorer auf:

    Zum Log-Explorer

  2. Wählen Sie im Menü Ressource die Option Global aus.

  3. Geben Sie im Abfrageeditor den String simple in Anführungszeichen ein. In der Loganzeige wird nur der Logeintrag A simple entry. angezeigt.

  4. Nachdem Sie das Log aufgerufen haben, entfernen Sie den hinzugefügten Abfragestring und klicken 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 partly enthält:

  1. Der Abfrageeditor enthält die Zeile resource.type="global". Geben Sie den folgenden Befehl ein:

    jsonPayload.weather:partly

  2. Klicken 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

  • Schreibfehler und unbekannte Feldnamen führen dazu, dass gcloud-Kommandozeilenbefehle mit ungültigen Argumentmeldungen abgeschlossen werden. Wenn Sie beispielsweise den Punkt in resource.type vergessen, wird der Fehler ausgegeben:

     ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.

  • Wenn Cloud Logging nicht die erforderlichen Zugriffsberechtigungen gewährt wurden, werden die gcloud CLI-Befehle mit der Meldung permission denied abgeschlossen. Wenn beispielsweise eine Compute Engine-VM-Instanz mit den Standard-API-Einstellungen konfiguriert ist, wird der Befehl list mit dem Fehler „Berechtigung verweigert“ abgeschlossen:

     ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.

    Ändern Sie die VM-Instanzberechtigungen in Compute Engine so, dass Cloud Logging Leseberechtigungen gewährt werden. Gehen Sie dazu so vor:

    1. 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.
    2. Klicken Sie auf Bearbeiten, um die Konfiguration zu ändern.
    3. Suchen Sie nach dem Header Zugriffsbereiche für Cloud API und klicken Sie auf Details, um die Einstellungen für jede API aufzurufen. Ändern Sie den Eintrag von der Cloud Logging API zu Full. Klicken Sie auf Speichern.
    4. Klicken Sie auf Starten, um die VM-Instanz neu zu starten. Nach wenigen Augenblicken ist die VM einsatzbereit.

  • Wenn APIs Explorer Ihren Befehl nicht ausführen kann oder eine zusätzliche Autorisierung erforderlich ist, wird eine Meldung oder ein Fehlercode angezeigt:

    • Antwortcode 200 und keine Einträge: Wenn die Meldung nextPageToken angezeigt wird, bedeutet dies, dass APIs Explorer nicht genügend Zeit hatte, die Suche abzuschließen. Fügen Sie der Anfrage einen pageToken hinzu, stellen Sie diesen auf denselben Wert ein wie der des nextPageToken des Schlüssels und führen Sie dann den Befehl noch einmal aus.
    • Antwortcode 400: Der Abfragewert ist ungültig. Wenn Sie beispielsweise global als gloobal falsch schreiben, lautet die Meldung Unsupported resource type: gloobal.
    • Antwortcode 404: Die Projekt-ID ist ungültig. Überprüfen Sie die Schreibweise der Projekt-ID.
    • Sie werden möglicherweise aufgefordert, sich bei Ihrem Google-Konto anzumelden und APIs Explorer Zugriff auf Ihr Konto zu gewähren.

Bereinigen

So vermeiden Sie, dass Ihrem Google Cloud-Konto die auf dieser Seite verwendeten Ressourcen in Rechnung gestellt werden:

  1. (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 Logeinträge nicht löschen, verfallen sie und werden entfernt. Informationen zur Aufbewahrung finden Sie unter Kontingente und Limits.

Nächste Schritte