Strukturiertes Logging

In diesem Dokument wird das Konzept des strukturierten Loggings und die Methoden zum Strukturieren von Nutzlastfeldern von Logeinträgen erläutert. Wenn die Lognutzlast als JSON-Objekt formatiert und dieses Objekt im Feld jsonPayload gespeichert wird, wird der Logeintrag als strukturierter Logeintrag bezeichnet. Für diese Protokolle können Sie Abfragen erstellen, die nach bestimmten JSON-Pfaden suchen, und bestimmte Felder in der Protokollnutzlast indexieren. Wenn die Lognutzlast dagegen als String formatiert und im Feld textPayload gespeichert wird, ist der Logeintrag unstrukturiert. Sie können im Textfeld zwar suchen, aber den Inhalt nicht indexieren.

So erstellen Sie strukturierte Logeinträge:

  • Rufen Sie die API-Methode entries.write auf und geben Sie einen vollständig formatierten LogEntry an.
  • Führen Sie den Befehl gcloud logging write aus.
  • Verwenden Sie eine Cloud Logging-Clientbibliothek, die strukturierte Protokolle schreibt.

Weitere Informationen zu diesen Ansätzen finden Sie in den folgenden Abschnitten.

Protokolle mit Clientbibliotheken oder der API schreiben

Sie können Protokolldaten mithilfe der Cloud Logging-Clientbibliotheken schreiben, die die Cloud Logging API aufrufen. Sie können die Cloud Logging API auch direkt aufrufen. Clientbibliotheken können die Ausfüllung der speziellen JSON-Felder vereinfachen, indem einige Informationen automatisch erfasst und Schnittstellen bereitgestellt werden, um die Felder entsprechend auszufüllen. Wenn Sie jedoch die Struktur Ihrer Nutzlasten vollständig steuern möchten, rufen Sie die Cloud Logging API direkt auf und übergeben Sie die vollständige LogEntry-Struktur an die Cloud Logging API.

Weitere Informationen finden Sie in der Referenz zu entries.write.

Codebeispiele finden Sie unter Strukturierte Protokolle schreiben.

Protokolle mit der gcloud CLI schreiben

Sie können Protokolldaten mit der gcloud CLI schreiben. Die Benutzeroberfläche unterstützt unstrukturierte und strukturierte Protokolle. Wenn Sie ein strukturiertes Protokoll schreiben möchten, geben Sie dem Befehl ein serialisiertes JSON-Objekt an.

Eine Kurzanleitung finden Sie unter Logeinträge mit der Google Cloud CLI schreiben und abfragen.

Codebeispiele finden Sie in der gcloud logging write-Referenz.

Nächste Schritte