Cloud Logging für Python einrichten

Sie können Logs von Python-Anwendungen mit dem standardmäßigen Python-Logging-Handler in Cloud Logging schreiben. Dies ist auch direkt über die Cloud Logging API-Clientbibliothek für Python möglich. Wenn Sie den standardmäßigen Python-Logging-Handler verwenden, müssen Sie an den Python-Root-Handler einen Cloud Logging-Handler anhängen. In diesem Dokument wird dieser Ansatz veranschaulicht.

Hinweise

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Logging API.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Logging API.

    Enable the API

    8.
  8. Bereiten Sie Ihre Umgebung für die Python-Entwicklung vor.

    Einrichtungsleitfaden für Python aufrufen

    9. Bibliothek installieren

    Wie Sie die Cloud Logging-Bibliothek für Python installieren, erfahren Sie unter Clientbibliothek für Python installieren. Mit dieser Bibliothek können Sie einen Cloud Logging-Handler an den standardmäßigen Python-Root-Handler anhängen. Sie können diese Bibliothek auch verwenden, um API-Anfragen an Cloud Logging zu senden.

    Weitere Informationen zur Installation erhalten Sie in der Dokumentation zur Cloud Logging-Bibliothek für Python. Probleme können Sie über die Problemverfolgung melden.

    Logs mit dem standardmäßigen Python-Logging-Handler schreiben

    So senden Sie alle Logeinträge, die mit dem standardmäßigen Python-Root-Handler geschrieben werden, an Cloud Logging:

    1. Hängen Sie den Cloud Logging-Handler an den Python-Root-Logger an. Rufen Sie dazu die Methode setup_logging auf:

      # Imports the Cloud Logging client library
import google.cloud.logging

# Instantiates a client
client = google.cloud.logging.Client()

# Retrieves a Cloud Logging handler based on the environment
# you're running in and integrates the handler with the
# Python logging module. By default this captures all logs
# at INFO level and higher
client.setup_logging()

      Informationen zum Konfigurieren des Logging-Handlers finden Sie unter Integration in die Standardbibliothek für Logging.

      Informationen zu den Parametern der setup_logging-Funktion finden Sie im Cloud Logging-Client. Suchen Sie dort nach setup_logging. Auf dieser Seite wird beispielsweise beschrieben, wie Sie Protokollierungsstufen konfigurieren.

    2. Logdaten mit dem Python-Root-Logger schreiben:

      # Imports Python standard library logging
import logging

# The data to log
text = "Hello, world!"

# Emits the data using the standard logging module
logging.warning(text)

      Standardmäßig werden alle Logs, deren Schweregrad mindestens INFO ist und die von Ihrer Anwendung geschrieben werden, an Cloud Logging gesendet.

      Wenn Nachrichten von App Engine oder Google Kubernetes Engine in Logging protokolliert werden, sendet sie der Handler an die Ressourcentypen der jeweiligen Umgebung. Andernfalls werden die Logs unter dem python-Log im Ressourcentyp Global aufgeführt.

    Logs mit der Cloud Logging-Clientbibliothek schreiben

    Informationen zur direkten Verwendung der Cloud Logging-Clientbibliothek für Python finden Sie unter Cloud Logging-Clientbibliotheken.

    Ausführen auf Google Cloud

    IAM-Rolle Logautor (roles/logging.logWriter) haben. In den meisten Google Cloud Umgebungen wird das Standarddienstkonto automatisch für diese Rolle konfiguriert.

    App Engine

    Cloud Logging ist für App Engine automatisch aktiviert und das Standarddienstkonto Ihrer Anwendung hat standardmäßig die IAM-Berechtigungen zum Schreiben von Logeinträgen.

    Weitere Informationen finden Sie unter Logs schreiben und ansehen.

    Google Kubernetes Engine (GKE)

    GKE gewährt dem Standarddienstkonto automatisch die IAM-Rolle Logautor (roles/logging.logWriter). Wenn Sie die Workload Identity Federation for GKE mit diesem Standarddienstkonto verwenden, damit Arbeitslasten auf bestimmteGoogle Cloud APIs zugreifen können, ist keine zusätzliche Konfiguration erforderlich. Wenn Sie jedoch die Workload Identity-Föderation für GKE mit einem benutzerdefinierten IAM-Dienstkonto verwenden, muss das benutzerdefinierte Dienstkonto die Rolle „Logs Writer“ (roles/logging.logWriter) haben.

    Bei Bedarf können Sie auch den folgenden Befehl verwenden, um beim Erstellen des Clusters den Zugriffsbereich logging.write hinzuzufügen:

    gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

    Compute Engine

    Wenn Sie Compute Engine-VM-Instanzen verwenden, fügen Sie der jeweiligen Instanz den Zugriffsbereich für cloud-platform hinzu. Wenn Sie über dieGoogle Cloud -Konsole eine neue Instanz erstellen, können Sie das im Bereich Instanz erstellen im Abschnitt Identität und API-Zugriff erledigen. Verwenden Sie das Compute Engine-Standarddienstkonto oder ein anderes Dienstkonto und wählen Sie im Abschnitt Identität und API-Zugriff die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus. Achten Sie darauf, dass jedem ausgewählten Dienstkonto im Abschnitt IAM & Verwaltung derGoogle Cloud -Konsole die Rolle "Logautor" zugewiesen ist.

    Lokal und extern ausführen

    Wenn Sie die Cloud Logging-Clientbibliothek für Python außerhalb von Google Cloudverwenden möchten, z. B. auf Ihrem eigenen Arbeitsplatz, auf den Computern Ihres Rechenzentrums oder auf den VM-Instanzen eines anderen Cloud-Anbieters, müssen Sie Standardanmeldedaten für Anwendungen (ADC) in Ihrer lokalen Umgebung einrichten, um sich bei der Cloud Logging-Clientbibliothek für Python zu authentifizieren.

    Weitere Informationen finden Sie unter ADC für lokale oder andere Cloud-Anbieter einrichten.

    Logs ansehen

    Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf:

    Zum Log-Explorer

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

    Im Log-Explorer müssen Sie eine oder mehrere Ressourcen angeben. Die Auswahl der Ressourcen ist jedoch möglicherweise nicht offensichtlich. Hier sind ein paar Tipps für den Einstieg.

    • Wenn Sie Ihre Anwendung für App Engine bereitstellen oder die App Engine-spezifischen Bibliotheken verwenden, setzen Sie die Ressource auf GAE-Anwendung.

    • Wenn Sie Ihre Anwendung auf der Compute Engine bereitstellen, setzen Sie die Ressource auf GCE-VM-Instanz.

    • Wenn Sie Ihre Anwendung in Google Kubernetes Engine bereitstellen, wird der Ressourcentyp der Logeinträge von der Loggingkonfiguration des Clusters bestimmt. Weitere Informationen zu den Lösungen mit Legacy Google Cloud Observability und Google Cloud Observability Kubernetes Monitoring und den jeweiligen Auswirkungen auf den Ressourcentyp finden Sie unter Zu Google Cloud Observability Kubernetes Monitoring migrieren.

    • Wenn Ihre Anwendung die Cloud Logging API direkt nutzt, ist die Ressource von der API und Ihrer Konfiguration abhängig. Sie können in Ihrer Anwendung zum Beispiel eine Ressource angeben oder eine Standardressource verwenden.

    • Wenn im Log-Explorer keine Logs zu sehen sind, wechseln Sie zum erweiterten Abfragemodus und verwenden Sie eine leere Abfrage, um alle Logeinträge zu sehen.

      1. Klicken Sie oben im Log-Explorer auf das Dreipunkt-Menü (▾) und wählen Sie In erweiterten Filter umwandeln aus, um zum erweiterten Abfragemodus zu wechseln.
      2. Löschen Sie den Inhalt, der im Filterfeld angezeigt wird.
      3. Klicken Sie auf Filter senden.

      Sie können die einzelnen Einträge prüfen, um Ihre Ressourcen zu identifizieren.

    Weitere Informationen finden Sie unter Log-Explorer verwenden.