Python-Anwendungen für Error Reporting instrumentieren

Mithilfe der Error Reporting-Bibliothek für Python können Sie Fehlerberichte von Python-Anwendungen an Error Reporting senden. Verwenden Sie die Error Reporting-Bibliothek für Python, um Fehlergruppen für die folgenden Fälle zu erstellen:

  • Ein Log-Bucket, der Ihre Logeinträge enthält, hat eine vom Kunden verwaltete Verschlüsselung Schlüssel (CMEK).
  • Der Log-Bucket erfüllt eine der folgenden Anforderungen: <ph type="x-smartling-placeholder">
      </ph>
    • Der Log-Bucket wird in dem Projekt gespeichert, in dem sich auch die Logeinträge befinden entstand.
    • Die Logeinträge wurden an ein Projekt weitergeleitet, das dann in diesem Projekt gespeichert wurde in einem Log-Bucket, der ihm gehört.
  • Sie möchten benutzerdefinierte Fehlerereignisse melden.

Error Reporting ist in einige Google Cloud-Dienste wie Cloud Functions, App Engine, Compute Engine und Google Kubernetes Engine eingebunden. In Error Reporting sehen Sie die in Cloud Logging protokollierten Fehler der auf diesen Diensten ausgeführten Anwendungen. Weitere Informationen finden Sie unter In Google Cloud ausführen Seite.

Sie können Fehlerdaten auch mithilfe von Logging an Error Reporting senden. Informationen zu den Datenformatierungsanforderungen finden Sie unter Fehlermeldungen in Logging formatieren.

Hinweis

  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 Error Reporting 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 Error Reporting API .

    Enable the API

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

    Einrichtungsleitfaden für Python aufrufen

Clientbibliothek installieren

Mit der Error Reporting-Bibliothek für Python können Sie die von Python-Anwendungen, die nahezu überall ausgeführt werden können.

  1. Instanziieren Sie eine virtuelle Umgebung und installieren Sie das Paket mit pip:

    pip install google-cloud-error-reporting --upgrade
    
  2. Importieren Sie die Bibliothek und instanziieren Sie einen Client, um mit der Meldung von Fehlern zu starten:

    Python

    Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Error Reporting zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

    #!/usr/bin/env python
    #
    # Copyright 2022 Google, Inc.
    #
    # Licensed under the Apache License, Version 2.0 (the "License");
    # you may not use this file except in compliance with the License.
    # You may obtain a copy of the License at
    #
    #    http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License.
    
    
    def report_exception():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            raise Exception("Something went wrong")
        except Exception:
            client.report_exception()
    
    
    
    
    def report_manual_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        client.report("An error has occurred.")
    
    
    
    
    if __name__ == "__main__":
        report_exception()
        report_manual_error()
    

Weitere Informationen zur Installation finden Sie in der Dokumentation der Error Reporting-Bibliothek für Python. Probleme können Sie über die Problemverfolgung melden.

Clientbibliothek konfigurieren

Das Verhalten der Error Reporting-Bibliothek für Python kann angepasst werden. Konfigurationsbeispiele finden Sie in der Dokumentation zur Clientbibliothek.

Anwendungen in Google Cloud ausführen

Um Fehlergruppen mithilfe von projects.events.report, Ihr Dienstkonto benötigt die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

Einige Google Cloud-Dienste gewähren automatisch Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) der entsprechenden Dienstkonto. Sie müssen diese Rolle jedoch dem entsprechenden Dienst für einige Dienste.

Flexible App Engine-Umgebung

App Engine gewährt den Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) automatisch mit Ihrem Standarddienstkonto verknüpft.

Die Error Reporting-Bibliothek für Python kann verwendet werden, ohne dass Anmeldedaten explizit angegeben werden müssen.

Error Reporting wird für Anwendungen in flexiblen App Engine-Umgebungen automatisch aktiviert. Es ist keine zusätzliche Einrichtung erforderlich.

Google Kubernetes Engine

Um Error Reporting mit Google Kubernetes Engine zu verwenden, Gehen Sie so vor:

  1. Prüfen Sie, ob das von Ihrem Container zu verwendende Dienstkonto gewährte Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

    Sie können dazu entweder das Compute Engine-Standarddienstkonto verwenden. oder ein benutzerdefiniertes Dienstkonto.

    Informationen zum Gewähren von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten

  2. Cluster erstellen und dem Cluster die cloud-platform Zugriffsbereich.

    Der folgende Befehl zum Erstellen gibt beispielsweise die cloud-platform an. Zugriffsbereich und ein Dienstkonto:

    gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
    

Compute Engine

Um Error Reporting mit Compute Engine-VM-Instanzen zu verwenden, Gehen Sie so vor:

  1. Prüfen Sie, ob das von Ihrer VM-Instanz zu verwendende Dienstkonto gewährte Rolle „Error Reporting-Autor“ (roles/errorreporting.writer):

    Sie können dazu entweder das Compute Engine-Standarddienstkonto verwenden. oder ein benutzerdefiniertes Dienstkonto.

    Informationen zum Gewähren von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten

  2. Rufen Sie in der Google Cloud Console die Seite VM-Instanzen auf:

    Zu Seite VM-Instanzen

    Wenn Sie diese Seite über die Suchleiste finden, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Compute Engine lautet.

  3. Wählen Sie die VM-Instanz aus, die Sie erhalten möchten. cloud-platform Zugriffsbereich.

  4. Klicken Sie auf Beenden und dann auf Bearbeiten.

  5. Wählen Sie im Abschnitt Identität und API-Zugriff ein Dienstkonto aus, das hat die Rolle „Error Reporting-Autor“ (roles/errorreporting.writer).

  6. Gehen Sie im Abschnitt Zugriffsbereiche so vor: Wählen Sie Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus und speichern Sie Ihre Änderungen.

  7. Klicken Sie auf Starten/Fortsetzen.

Cloud Functions

Cloud Run-Funktionen gewähren die Rolle Rolle „Error Reporting-Autor“ (roles/errorreporting.writer) automatisch mit Ihrem Standarddienstkonto verknüpft.

Die Error Reporting-Bibliothek für Python kann verwendet werden, ohne dass Anmeldedaten explizit angegeben werden müssen.

Cloud Run-Funktionen sind für die Verwendung von Error Reporting konfiguriert automatisch. Unverarbeitet JavaScript-Ausnahmen werden in Logging angezeigt und von Error Reporting erstellen können, ohne den Error Reporting-Bibliothek für Python.

Beispiel

Sie können einen Fehler auch manuell melden. Dazu rufen Sie die Methode report wie im folgenden Beispiel gezeigt auf:

Python

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Error Reporting zu authentifizieren. Weitere Informationen finden Sie unter Richten Sie die Authentifizierung ein.

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()




def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")




if __name__ == "__main__":
    report_exception()
    report_manual_error()

Anwendungen in einer lokalen Entwicklungsumgebung ausführen

So verwenden Sie die Error Reporting-Bibliothek für Python in einer lokalen Entwicklungsumgebung: wie das Ausführen der Bibliothek auf Ihrer eigenen Workstation, müssen Sie Ihre Error Reporting-Bibliothek für Python mit den Standardanmeldedaten für Anwendungen. Weitere Informationen finden Sie unter Bei Error Reporting authentifizieren.

Wenn Sie die Python Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, installieren und initialisieren Sie die gcloud CLI und richten dann die Standardanmeldedaten für Anwendungen mit Ihren Nutzeranmeldedaten ein.

  1. Install the Google Cloud CLI.
  2. To initialize the gcloud CLI, run the following command:

    gcloud init
  3. If you're using a local shell, then create local authentication credentials for your user account:

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

Weitere Informationen unter Set up authentication for a local development environment.

Die projects.events.report-Methode unterstützt auch API-Schlüssel. Wenn Sie API-Schlüssel für die Authentifizierung verwenden möchten, müssen Sie keine lokale Datei mit den Standardanmeldedaten für Anwendungen einrichten. Weitere Informationen unter Erstellen eines API-Schlüssels in der Dokumentation zur Google Cloud-Authentifizierung.

Fehlerberichte ansehen

Rufen Sie in der Google Cloud Console die Seite Error Reporting auf:

Error Reporting aufrufen

Sie können diese Seite auch über die Suchleiste finden.

Weitere Informationen finden Sie unter Fehler anzeigen.