Mithilfe der Error Reporting-Bibliothek für Ruby können Sie Fehlerberichte von Ruby-Anwendungen an Error Reporting senden. Mit der Error Reporting-Bibliothek für Ruby können Sie Fehlergruppen für die folgenden Fälle erstellen:
- Ein Protokoll-Bucket, der Ihre Protokolleinträge enthält, hat vom Kunden verwaltete Verschlüsselungsschlüssel (CMEK).
- Der Log-Bucket erfüllt eine der folgenden Bedingungen:
- Der Protokoll-Bucket wird im selben Projekt gespeichert, aus dem die Protokolleinträge stammen.
- Die Logeinträge wurden an ein Projekt weitergeleitet und dann in einem zugehörigen Log-Bucket gespeichert.
- 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 auf dieser Seite im Abschnitt In Google Cloud ausführen.
Sie können Fehlerdaten auch mithilfe von Logging an Error Reporting senden. Informationen zu den Datenformatierungsanforderungen finden Sie unter Fehlermeldungen in Logging formatieren.
Hinweise
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Error Reporting API .
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Error Reporting API .
- Installieren Sie Ruby 2.2 oder höher.
Clientbibliothek installieren
Mit der Error Reporting-Bibliothek für Ruby können Sie die von Ruby-Anwendungen gemeldeten Fehler im Blick behalten und abrufen. Dabei ist es in den meisten Fällen unerheblich, wo die Anwendungen ausgeführt werden.
-
Fügen Sie das
google-cloud-error_reporting
-Gem in Ihr Gemfile ein:gem "google-cloud-error_reporting"
-
Installieren Sie das Gem mit Bundler:
bundle install
Bibliothek aktivieren
Wenn Sie Ruby on Rails verwenden, wird die Bibliothek beim Start Ihrer Anwendung automatisch von Bundler geladen.
Andere rackbasierte Anwendungen können die Rack-Middleware aus der Bibliothek verwenden:
Weitere Informationen zur Installation finden Sie in der Dokumentation der Error Reporting-Bibliothek für Ruby. Probleme können Sie über die Problemverfolgung melden.
Clientbibliothek konfigurieren
Das Verhalten der Error Reporting-Bibliothek für Ruby kann angepasst werden. Die Konfiguration der Bibliothek enthält eine Liste der Konfigurationsoptionen.
Apps in Google Cloud ausführen
Wenn Sie mit projects.events.report
Fehlergruppen erstellen möchten, benötigt Ihr Dienstkonto die Rolle Error Reporting Writer (roles/errorreporting.writer
).
Einigen Google Cloud-Diensten wird dem entsprechenden Dienstkonto automatisch die Rolle „Autor für Fehlerberichte“ (roles/errorreporting.writer
) zugewiesen. Bei einigen Diensten müssen Sie diese Rolle jedoch dem entsprechenden Dienstkonto zuweisen.
Cloud Run und Cloud Run-Funktionen
Das von Cloud Run verwendete Standarddienstkonto hat die Berechtigungen der Rolle Error Reporting-Autor (roles/errorreporting.writer
).
Die Error Reporting-Bibliothek für Ruby kann verwendet werden, ohne dass Anmeldedaten explizit angegeben werden müssen.
Cloud Run ist für die automatische Verwendung von Error Reporting konfiguriert. Unverarbeitete JavaScript-Ausnahmen werden in Logging angezeigt und von Error Reporting verarbeitet, ohne dass dafür die Error Reporting-Bibliothek für Ruby angewendet werden muss.
Konfigurationsoberfläche von Ruby on Rails verwenden
Wenn Sie die Error Reporting-Bibliothek für Ruby mit dem Ruby on Rails-Framework verwenden möchten, geben Sie die Parameter über die Konfigurationsoberfläche von Ruby on Rails an:
Wenn Sie Folgendes eingeben, können Sie eine gemeinsame Konfiguration für alle Stackdriver-Gems festlegen:
Error Reporting ist standardmäßig aktiviert, wenn Rails im Produktionsmodus ausgeführt wird. Fügen Sie Folgendes hinzu, um Error Reporting im Entwicklungsmodus zu aktivieren:
Konfigurationsschnittstelle für Instrumentierung verwenden
Wenn Sie die Error Reporting-Bibliothek für Ruby in anderen rackbasierten Anwendungen verwenden möchten, geben Sie die Parameter über die Konfigurationsoberfläche an:
Sie können eine gemeinsame Konfiguration für alle Google Cloud Observability-Gems festlegen, wenn Sie Folgendes eingeben:
Flexible App Engine-Umgebung
In der App Engine wird Ihrem Standarddienstkonto automatisch die Rolle Error Reporting-Autor (roles/errorreporting.writer
) zugewiesen.
Die Error Reporting-Bibliothek für Ruby 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
So verwenden Sie Error Reporting mit der Google Kubernetes Engine:
Dem Dienstkonto, das von Ihrem Container verwendet werden soll, muss die Rolle Error Reporting-Autor (
roles/errorreporting.writer
) zugewiesen sein.Sie können entweder das Compute Engine-Standarddienstkonto oder ein benutzerdefiniertes Dienstkonto verwenden.
Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.
Erstellen Sie Ihren Cluster und gewähren Sie ihm den Zugriffsbereich
cloud-platform
.Im folgenden Beispiel wird mit dem Befehl „create“ der
cloud-platform
-Zugriffsbereich und ein Dienstkonto angegeben:gcloud container clusters create CLUSTER_NAME --service-account SERVICE_ACCT_NAME --scopes=cloud-platform
Compute Engine
So verwenden Sie Error Reporting mit Compute Engine-VM-Instanzen:
Dem Dienstkonto, das von Ihrer VM-Instanz verwendet werden soll, muss die Rolle Error Reporting-Autor (
roles/errorreporting.writer
) zugewiesen sein.Sie können entweder das Compute Engine-Standarddienstkonto oder ein benutzerdefiniertes Dienstkonto verwenden.
Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.
-
Rufen Sie in der Google Cloud Console die Seite VM-Instanzen auf:
Wenn Sie diese Seite über die Suchleiste finden, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Compute Engine lautet.
Wählen Sie die VM-Instanz aus, für die Sie den
cloud-platform
Zugriffsbereich erhalten möchten.Klicken Sie auf Beenden und dann auf Bearbeiten.
Wählen Sie im Abschnitt Identität und API-Zugriff ein Dienstkonto mit der Rolle „Error Reporting-Autor“ (
roles/errorreporting.writer
) aus.Wählen Sie im Bereich Zugriffsbereiche die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus und speichern Sie die Änderungen.
Klicken Sie auf Starten/Fortsetzen.
Beispiel
Fehler in rackbasierten Frameworks melden
Mit der Error Reporting-Bibliothek für Ruby lässt sich Error Reporting problemlos in gängige rackbasierte Ruby-Web-Frameworks wie Ruby on Rails und Sinatra einbinden: Wenn die Bibliothek aktiviert ist, werden die im Rackstack der Anwendung erfassten Ausnahmen automatisch gemeldet.
Fehler manuell melden
Sie können einen Fehler auch manuell melden. Dazu rufen Sie die Methodereport
wie im folgenden Beispiel gezeigt auf:
Apps in einer lokalen Entwicklungsumgebung ausführen
Wenn Sie die Error Reporting-Bibliothek für Ruby in einer lokalen Entwicklungsumgebung verwenden möchten, z. B. um die Bibliothek auf Ihrem eigenen Workstation auszuführen, müssen Sie die Standardanmeldedaten für die lokale Anwendung angeben. Weitere Informationen finden Sie unter Bei Error Reporting authentifizieren.
Wenn Sie die Ruby 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.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
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.
Konfigurationsoberfläche von Ruby on Rails verwenden
Wenn Sie die Error Reporting-Bibliothek für Ruby mit dem Ruby on Rails-Framework verwenden möchten, geben Sie die Parameter über die Konfigurationsoberfläche von Ruby on Rails an:
Wenn Sie Folgendes eingeben, können Sie eine gemeinsame Konfiguration für alle Stackdriver-Gems festlegen:
Error Reporting ist standardmäßig aktiviert, wenn Rails im Produktionsmodus ausgeführt wird. Fügen Sie Folgendes hinzu, um Error Reporting im Entwicklungsmodus zu aktivieren:
Konfigurationsschnittstelle für Instrumentierung verwenden
Wenn Sie die Error Reporting-Bibliothek für Ruby in anderen rackbasierten Anwendungen verwenden möchten, geben Sie die Parameter über die Konfigurationsoberfläche an:
Sie können eine gemeinsame Konfiguration für alle Google Cloud Observability-Gems festlegen, wenn Sie Folgendes eingeben:
Fehlerberichte ansehen
Rufen Sie in der Google Cloud Console die Seite Fehlerberichte auf:
Sie können diese Seite auch über die Suchleiste finden.
Weitere Informationen finden Sie unter Fehler anzeigen.