Schnellstart mit Python

In dieser Kurzanleitung werden einige der Funktionen von Cloud Logging vorgestellt und Sie erfahren, wie Sie Folgendes tun:

  • Logeinträge mit einem Python-Skript schreiben
  • Logeinträge mit einem Python-Skript aufrufen.
  • Löschen Sie Logeinträge mit einem Python-Skript.
  • Leiten Sie Logs an einen Cloud Storage-Bucket weiter.

Logging kann Logeinträge an folgende Ziele weiterleiten:

  • Cloud Storage-Buckets
  • BigQuery-Datasets
  • Pub/Sub
  • logging-buckets

Hinweis

Sie benötigen ein Google Cloud-Projekt mit aktivierter Abrechnungsfunktion, um diese Kurzanleitung durchzuarbeiten. Wenn Sie kein Google 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 Ihr 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 Ihr Projekt aktiviert ist.

In dieser Kurzanleitung werden Cloud Logging und Cloud Storage verwendet. Die Verwendung dieser Ressourcen kann Kosten für Sie verursachen. Löschen Sie die erstellten Ressourcen, nachdem Sie diese Kurzanleitung abgeschlossen haben, um fortlaufende Kosten zu vermeiden. Weitere Informationen finden Sie auf dieser Seite unter Bereinigen.

Erste Schritte

Sie können die Cloud Shell-Umgebung oder eine generische Linux-Umgebung verwenden, um diese Kurzanleitung abzuschließen. Python ist in Cloud Shell vorinstalliert.

Cloud Shell

  1. Öffnen Sie Cloud Shell und überprüfen Sie die Cloud-Projektkonfiguration:

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

      Cloud Shell aktivieren

      Cloud Shell wird in einem Fenster geöffnet und eine Begrüßungsnachricht wird angezeigt:

      Willkommen bei Cloud Shell

    2. Die Begrüßungsnachricht gibt die konfigurierte Cloud-Projekt-ID wieder. Wenn dies nicht das Cloud-Projekt ist, das Sie verwenden möchten, führen Sie den folgenden Befehl aus und ersetzen Sie dabei [PROJECT_ID] durch die Projekt-ID:

       gcloud config set project [PROJECT_ID]
      

Linux

  1. Python muss installiert und konfiguriert sein. Informationen zur Vorbereitung Ihrer Maschine für die Python-Entwicklung finden Sie unter Python-Entwicklungsumgebung einrichten.

  2. Richten Sie die Berechtigungen für die Identitäts- und Zugriffsverwaltung für Ihr Cloud-Projekt ein. Mit den folgenden Schritten erstellen Sie ein Dienstkonto für Ihr Cloud-Projekt und generieren bzw. laden eine Datei auf Ihre Linux-Workstation.

    1. Wechseln Sie in der Cloud Console zu IAM & Verwaltung > Dienstkonten:

      Zur Seite „Dienstkonten“

    2. Wählen Sie Ihr Schnellstart-Cloud-projekt aus und klicken Sie dann auf Dienstkonto erstellen:

      • Geben Sie einen Kontonamen ein.
      • Geben Sie eine Kontobeschreibung ein.
      • Klicken Sie auf Erstellen.
    3. Wählen Sie im Bereich Dienstkontoberechtigungen (optional) für die Rolle die Option Logging-Administrator aus der Drop-down-Liste aus. Klicken Sie auf Weiter.

    4. Überspringen Sie die Option, um Nutzern Zugriff auf das Dienstkonto zu gewähren.

    5. Klicken Sie auf Fertig.

    6. Erstellen Sie eine Schlüsseldatei und laden Sie sie auf Ihre Workstation herunter:

      • Klicken Sie für Ihr Dienstkonto auf Weitere Optionen und wählen Sie Schlüssel verwalten aus.
      • Klicken Sie im Bereich Schlüssel auf Schlüssel hinzufügen.
      • Wählen Sie als Schlüsseltyp JSON aus und klicken Sie dann auf Erstellen. Nach kurzer Zeit wird in einem Pop-up-Fenster eine Nachricht wie die folgende angezeigt:

        Privater Schlüssel gespeichert

  3. Geben Sie in der Linux-Workstation die Anmeldedaten zur Authentifizierung für Ihre Anwendung an. Dazu legen Sie für die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS den Pfad zur Schlüsseldatei fest. Beispiel:

     export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json"
    

    Diese Umgebungsvariable gilt nur für Ihre aktuelle Shell-Sitzung. Wenn Sie eine neue Sitzung öffnen, müssen Sie die Variable noch einmal festlegen.

Quellcode klonen

So konfigurieren Sie Cloud Shell für diese Kurzanleitung:

  1. Klonen Sie das GitHub-Projekt python-logging:

      git clone https://github.com/googleapis/python-logging
    

    Das Verzeichnis samples/snippets enthält die beiden in dieser Kurzanleitung verwendeten Skripts:

    • Mit snippets.py können Sie Einträge in einem Log verwalten.
    • Mit export.py können Sie Logexporte verwalten.
  2. Wechseln Sie in das Verzeichnis snippets:

      cd python-logging/samples/snippets
    

Logeinträge schreiben

Das snippets.py-Skript verwendet die Python-Clientbibliotheken, um Logeinträge in das Logging zu schreiben. Wenn die Option write in der Befehlszeile angegeben ist, schreibt das Skript die folgenden Logeinträge:

  • Einen Eintrag mit unstrukturierten Daten und ohne angegebene Wichtigkeitsstufe
  • Einen Eintrag mit unstrukturierten Daten und der Wichtigkeitsstufe ERROR
  • Einen Eintrag mit strukturierten JSON-Daten und ohne angegebene Wichtigkeitsstufe

Zum Schreiben neuer Logeinträge in das Log my-log führen Sie das snippets.py-Skript mit der Option write aus:

python snippets.py my-log write

Logeinträge aufrufen

Führen Sie das snippets.py-Skript mit der Option list aus, um die Logeinträge in der Cloud Shell zu sehen:

python snippets.py my-log list

Der Befehl wird mit dem Ergebnis abgeschlossen:

    Listing entries for logger my-log:
    * 2018-11-15T16:05:35.548471+00:00: Hello, world!
    * 2018-11-15T16:05:35.647190+00:00: Goodbye, world!
    * 2018-11-15T16:05:35.726315+00:00: {u'favorite_color': u'Blue', u'quest': u'Find the Holy Grail', u'name': u'King Arthur'}

Wenn im Ergebnis keine Einträge angezeigt werden, wiederholen Sie den Befehl. Es kann einige Minuten dauern, bis Logging Logeinträge empfängt und verarbeitet.

Sie können Ihre Logeinträge auch mit dem Log-Explorer aufrufen. Weitere Informationen finden Sie unter Logs in der Log-Explorer ansehen.

Logeinträge löschen

Wenn Sie alle Logeinträge im Log my-log löschen möchten, führen Sie das snippets.py-Skript mit der Option delete aus:

python snippets.py my-log delete

Der Befehl wird mit dem Ergebnis abgeschlossen:

Deleted all logging entries for my-log.

Logs weiterleiten

In diesem Abschnitt tun Sie Folgendes:

  • Einen Cloud Storage-Bucket als Zielort für Ihre Daten erstellen
  • Eine Datensenke erstellen, die neue Logeinträge zum Ziel kopiert
  • Die Berechtigungen Ihres Cloud Storage-Buckets aktualisieren
  • Logeinträge in Logging schreiben
  • Optional den Inhalt Ihres Cloud Storage-Buckets überprüfen

Zielort erstellen

Das Exportziel für diese Kurzanleitung ist ein Cloud Storage-Bucket. So erstellen Sie einen Cloud Storage-Bucket:

  1. Wechseln Sie in der Cloud Console zu Storage und wählen Sie Browser aus:

    Browser aufrufen

  2. Klicken Sie auf Bucket erstellen.

  3. Geben Sie einen Namen für den Bucket ein.

  4. Wählen Sie als Standorttyp die Option Region aus, um einen Bucket-Standort mit der geringsten Latenz auszuwählen.

  5. Wählen Sie für Standard-Speicherklasse die Option Standard aus.

  6. Wählen Sie für Zugriffssteuerung die Option Detailliert aus.

  7. Wählen Sie für Schutztools die Option Keine aus und klicken Sie dann auf Erstellen.

In dieser Kurzanleitung wird der Cloud Storage-Bucket-Name myloggingproject-1 verwendet.

Senke erstellen

Eine Senke ist eine Regel, die bestimmt, ob Stackdriver Logging einen neu eingetroffenen Logeintrag an einen Zielort weiterleitet. Eine Senke hat drei Attribute:

  • Name
  • Ziel
  • Filter

Weitere Informationen zu Senken finden Sie unter Senken.

Wenn ein neu eingetroffener Logeintrag die Abfragebedingungen erfüllt, wird dieser Logeintrag an den Zielort weitergeleitet.

Das Skript export.py verwendet die Python-Clientbibliotheken zum Erstellen, Auflisten, Ändern und Löschen von Senken. Führen Sie den folgenden Befehl aus, um die Senke mysink zu erstellen, die alle Logeinträge mit einem Schweregrad von mindestens INFO an den Cloud Storage-Bucket myloggingproject-1 sendet:

python export.py create mysink myloggingproject-1 "severity>=INFO"

Führen Sie das Skript export.py mit der Option list aus, um sich die Senken anzeigen zu lassen:

python export.py list

Das Skript gibt Folgendes zurück:

    mysink: severity>=INFO -> storage.googleapis.com/myloggingproject-1

Zielberechtigungen aktualisieren

Die Berechtigungen des Ziels, in diesem Fall Ihres Cloud Storage-Buckets, werden nicht geändert, wenn Sie mit dem Skript export.py eine Senke erstellen. Sie müssen die Berechtigungseinstellungen Ihres Cloud Storage-Buckets ändern, um der Senke Schreibberechtigung zu erteilen. Informationen zu Dienstkonten, Zugriffsbereichen sowie Rollen der Identitäts- und Zugriffsverwaltung finden Sie unter Dienstkonten.

So aktualisieren Sie die Berechtigungen für Ihren Cloud Storage-Bucket:

  1. Ermitteln Sie die Identität des Autors für die Senke:

    1. Rufen Sie die Seite Log-Router auf:

      Zum "Logs Router"

      Eine Zusammenfassungstabelle Ihrer Senken wird angezeigt.

    2. Suchen Sie die Senke in der Tabelle, wählen Sie Menü und dann Details zur Senke ansehen aus.

    3. Kopieren Sie die Identität des Autors in die Zwischenablage.

  2. Klicken Sie in der Cloud Console auf Storage und wählen Sie Browser aus:

    Browser aufrufen

  3. Klicken Sie zum Öffnen der Detailansicht auf den Namen Ihres Buckets.

  4. Wählen Sie Berechtigungen aus und klicken Sie auf Hinzufügen.

  5. Legen Sie die Rolle auf Storage Object Creator fest und geben Sie die Identität des Autors für die Senke an.

Weitere Informationen finden Sie unter Zielberechtigungen.

Senke validieren

So prüfen Sie, ob die Senke und das Ziel ordnungsgemäß konfiguriert sind:

  1. Schreiben Sie neue Logeinträge in das Log my-log:

    python snippets.py my-log write
    
  2. Sehen Sie sich den Inhalt Ihres Cloud Storage-Buckets an:

    1. Klicken Sie in der Cloud Console auf Storage und wählen Sie Browser aus:

      Browser aufrufen

    2. Klicken Sie zum Öffnen der Detailansicht auf den Namen Ihres Buckets. In der Detailansicht werden die Ordner aufgelistet, die Daten enthalten. Wenn der Bucket keine Daten enthält, wird die folgende Meldung angezeigt:

      There are no live objects in this bucket.

      Wie unter Verfügbarkeit von exportierten Logs beschrieben, kann es zwei bis drei Stunden dauern, bis die ersten Einträge am Ziel angezeigt werden oder bis Sie über einen Konfigurationsfehler benachrichtigt werden.

      Nachdem Ihr Bucket Daten erhalten hat, zeigt die Detailansicht ein Ergebnis wie das folgende an:

      Bucket-Inhalte

    3. Die Daten in jedem Bucket sind in einer Reihe von Ordnern organisiert. Diese sind folgendermaßen benannt: der Ordner auf der obersten Ebene nach dem Lognamen und die Ordner auf den untergeordneten Ebenen anschließend nacheinander nach Jahr, Monat und Tag. Wenn Sie die von Ihrer Senke exportierten Daten sehen möchten, klicken Sie auf den Ordnernamen my-log und dann durch die Unterordner für Jahr, Monat und Tag, bis Sie eine Datei mit der Endung json finden:

      Bucket-Inhalte

    4. Die JSON-Datei enthält die Logeinträge, die in Ihren Cloud Storage-Bucket exportiert wurden. Klicken Sie auf den Namen der JSON-Datei, um den Inhalt anzuzeigen. Der Inhalt sieht etwa so aus:

       {"insertId":"yf1cshfoivz48",
       "logName":"projects/loggingproject-222616/logs/my-log",
       "receiveTimestamp":"2018-11-15T23:06:14.738729911Z",
       "resource":{"labels":{"project_id":"loggingproject-222616"},"type":"global"},
       "severity":"ERROR",
       "textPayload":"Goodbye, world!",
       "timestamp":"2018-11-15T23:06:14.738729911Z"}
      

      Da die Wichtigkeitsstufe ERROR die Wichtigkeitsstufe INFO übersteigt, wird der Log-Eintrag mit dem String "Goodbye, world!" an den Zielort der Senke exportiert. Die anderen geschriebenen Logeinträge wurden nicht an das Ziel exportiert, da ihre Wichtigkeitsstufe auf den Standardwert gesetzt war und die Standard-Wichtigkeitsstufe niedriger als INFO ist.

Fehlerbehebung

Es gibt mehrere Gründe, warum ein Cloud Storage-Bucket möglicherweise leer ist:

  • Der Bucket hat keine Daten empfangen. Es kann zwei bis drei Stunden dauern, bis die ersten Einträge am Ziel vorhanden sind oder Sie über einen Konfigurationsfehler informiert werden. Weitere Informationen darüber, warum Ihre Logs möglicherweise zu spät kommen, finden Sie unter Verfügbarkeit exportierter Logs.

  • Ein Konfigurationsfehler ist aufgetreten. In diesem Fall erhalten Sie eine E-Mail-Nachricht mit einer Betreffzeile ähnlich der folgenden:

     [ACTION REQUIRED] Logging export config error in myloggingproject.

    Der Inhalt des E-Mail-Texts beschreibt das Konfigurationsproblem. Wenn Sie beispielsweise Ihre Zielberechtigungen nicht aktualisieren, wird der folgende Fehlercode in der E-Mail aufgeführt:

     bucket_permission_denied

    Informationen zum Beheben dieser Bedingung finden Sie auf dieser Seite unter Berechtigungen aktualisieren.

  • Nach dem Erstellen der Senke wurden keine Logeinträge geschrieben. Die Senke wird nur auf neue Logeinträge angewendet. Wenn Sie diese Situation korrigieren möchten, schreiben Sie neue Logeinträge:

     python snippets.py my-log write
    

Bereinigen

Mit den folgenden Schritten vermeiden Sie, dass Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen in Rechnung gestellt werden:

  1. (Optional) Löschen Sie die Logeinträge, die Sie erstellt haben. Wenn Sie Ihre Logeinträge nicht löschen, verfallen sie und werden entfernt. Siehe Kontingente und Limits.

    Führen Sie den folgenden Befehl aus, um alle Logeinträge im Log my-log zu löschen:

     python snippets.py my-log delete
    
  2. Löschen Sie Ihr Cloud-Projekt oder löschen Sie Ihre Schnellstartressourcen.

    • Zum Löschen Ihres Cloud-Projekts klicken Sie im Bereich Projektinformationen der Cloud Console auf Zu den Projekteinstellungen und dann auf Herunterfahren.

    • So löschen Sie Ihre Schnellstartressourcen:

      1. Löschen Sie Ihre Senke mit dem folgenden Befehl:

        python export.py delete mysink
        
      2. Löschen Sie den Cloud Storage-Bucket. Wechseln Sie zur Cloud Console und klicken Sie auf Storage > Browser. Klicken Sie das Kästchen neben Ihrem Bucket-Namen an und klicken Sie auf Löschen.

Nächste Schritte

  • Informationen zum Lesen, Schreiben und Konfigurieren von Logs aus Ihren Anwendungen finden Sie unter Cloud Logging API.
  • Informationen zum Log-Explorer finden Sie unter Log-Explorer.
  • Informationen zum Weiterleiten Ihrer Logdaten an unterstützte Ziele finden Sie unter Routing und Speicher.
  • Informationen zum Erfassen von Logeinträgen von Ihren VM-Instanzen finden Sie unter Ops-Agent.
  • Informationen zur Prüfung und Compliance finden Sie unter Cloud-Audit-Logs.