Strumentare le app Ruby per Error Reporting

Puoi inviare eventi di errore a Error Reporting dalle applicazioni Ruby utilizzando la libreria Error Reporting per Ruby. Utilizza la libreria Error Reporting per Ruby per creare gruppi di errori nei seguenti casi:

• Un bucket di log che contiene le voci di log ha chiavi di crittografia gestite dal cliente (CMEK).
• Il bucket di log soddisfa una delle seguenti condizioni:
  • Il bucket di log è archiviato nello stesso progetto in cui sono state create le voci di log.
  • Le voci di log sono state instradate a un progetto, che le ha archiviate in un bucket di log di sua proprietà.
• Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni Google Cloud servizi, come Cloud Run Functions e App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting mostra gli eventi di errore registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per saperne di più, vai a Esecuzione su Google Cloud in questa pagina.

Puoi anche inviare eventi di errore a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattare una voce di log per segnalare eventi di errore.

Prima di iniziare

Accedi al tuo Google Cloud account. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei carichi di lavoro.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

1. Installa Ruby 2.2+ o versioni successive.

Installa la libreria client

La libreria Error Reporting per Ruby consente di monitorare e visualizzare gli eventi di errore segnalati dalle applicazioni Ruby in esecuzione praticamente ovunque.

1. Aggiungi il gem google-cloud-error_reporting al tuo Gemfile:

   gem "google-cloud-error_reporting"

2. Utilizza Bundler per installare il gem:

   bundle install

Abilitare la libreria

Se utilizzi Ruby on Rails, Bundler carica automaticamente la libreria nella tua applicazione all'avvio.

Altre applicazioni basate su Rack possono utilizzare il middleware Rack fornito dalla libreria:

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

Per saperne di più sull'installazione, consulta la documentazione della libreria Error Reporting per Ruby. Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Configurare la libreria client

Puoi personalizzare il comportamento della libreria Error Reporting per Ruby. Consulta la configurazione della libreria per un elenco delle possibili opzioni di configurazione.

Eseguire app su Google Cloud

Per creare gruppi di errori utilizzando projects.events.report, il tuo account di servizio deve avere il ruolo Writer di Error Reporting (roles/errorreporting.writer).

Alcuni Google Cloud servizi concedono automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al account di servizio appropriato. Tuttavia, devi concedere questo ruolo al service account appropriato per alcuni servizi.

Cloud Run e Cloud Run Functions

Il account di servizio predefinito utilizzato da Cloud Run dispone delle autorizzazioni del ruolo Writer di Error Reporting (roles/errorreporting.writer).

La libreria Error Reporting per Ruby può essere utilizzata senza dover fornire esplicitamente le credenziali.

Cloud Run è configurato per utilizzare Error Reporting automaticamente. Le eccezioni JavaScript non gestite verranno visualizzate in Logging ed elaborate da Error Reporting senza dover utilizzare la libreria Error Reporting per Ruby.

Nota: Error Reporting crea automaticamente un evento di errore quando una voce di log contiene un'analisi dello stack e il livello di gravità della voce di log non è impostato o è impostato su almeno ERROR.

Utilizzare l'interfaccia di configurazione di Ruby on Rails

Per utilizzare la libreria Error Reporting per Ruby con il framework Ruby on Rails, fornisci i parametri tramite l'interfaccia di configurazione di Ruby on Rails:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

Puoi anche impostare una configurazione condivisa per tutti i gem Stackdriver utilizzando quanto segue:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

Error Reporting è abilitato per impostazione predefinita quando Rails è in esecuzione in modalità di produzione. Per abilitare Error Reporting in modalità di sviluppo, aggiungi quanto segue:

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

Utilizzare l'interfaccia di configurazione della strumentazione

Per utilizzare la libreria Error Reporting per Ruby in altre applicazioni basate su Rack, fornisci i parametri tramite l'interfaccia di configurazione:

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

Puoi anche impostare una configurazione condivisa per tutti i gem di Google Cloud Observability utilizzando quanto segue:

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

La libreria Error Reporting per Ruby può essere utilizzata senza dover fornire esplicitamente le credenziali.

Error Reporting è abilitato automaticamente per le applicazioni dell'ambiente flessibile di App Engine. Non è richiesta nessuna ulteriore configurazione.

Nota: le voci di log degli errori scritte in stderr vengono elaborate automaticamente da Error Reporting, senza dover utilizzare direttamente la libreria Error Reporting per Ruby.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine:

1. Assicurati che al account di servizio da utilizzare dal container sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Crea il cluster e concedi al cluster l' cloud-platform ambito di accesso.

   Ad esempio, il seguente comando di creazione specifica l'ambito di accesso cloud-platform e un account di servizio:

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

Nota: dopo aver creato un cluster, non puoi modificarne il service account.

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine:

1. Assicurati che al account di servizio da utilizzare dall'istanza VM sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Nella Google Cloud console, vai alla pagina Istanze VM.

   Vai a Istanze VM

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Compute Engine.

3. Seleziona l'istanza VM a cui vuoi concedere l' cloud-platform ambito di accesso.

4. Fai clic su Arresta e poi su Modifica.

5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer di Error Reporting (roles/errorreporting.writer).

6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud e salva le modifiche.

7. Fai clic su Avvia/Riprendi.

Esempio

Segnalare errori nei framework basati su Rack

La libreria Error Reporting per Ruby semplifica l'integrazione di Error Reporting nei framework web Ruby basati su Rack più diffusi, come Ruby on Rails e Sinatra. Quando la libreria è abilitata, segnala automaticamente le eccezioni acquisite dallo stack Rack dell'applicazione.

Segnalare gli errori manualmente

Puoi segnalare manualmente un errore chiamando il metodo report, come mostrato nell'esempio seguente:

require "google/cloud/error_reporting"

begin
  raise "Something went wrong"
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

Eseguire app in un ambiente di sviluppo locale

Per utilizzare la libreria Error Reporting per Ruby in un ambiente di sviluppo locale, ad esempio eseguendola sulla tua workstation, devi fornire alla libreria Error Reporting per Ruby le credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Autenticarsi a Error Reporting.

Per utilizzare gli esempi di Ruby in questa pagina in un ambiente di sviluppo locale, installa e inizializza gcloud CLI, quindi configura Credenziali predefinite dell'applicazione con le tue credenziali utente.

1. Installa Google Cloud CLI.

2. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

3. Se utilizzi una shell locale, crea le credenziali di autenticazione locali per il tuo account utente:

   gcloud auth application-default login

   Non devi eseguire questa operazione se utilizzi Cloud Shell.

   Nota: se gcloud CLI stampa un avviso che indica che il tuo account non dispone dell'autorizzazione serviceusage.services.use, alcuni comandi gcloud CLI e librerie client potrebbero non funzionare. Chiedi a un amministratore di concederti il ruolo IAM Consumer di Service Usage (roles/serviceusage.serviceUsageConsumer), quindi esegui il seguente comando:

   gcloud auth application-default set-quota-project PROJECT_ID

   Se viene restituito un errore di autenticazione e utilizzi un provider di identità (IdP) esterno, verifica di aver acceduto a gcloud CLI con la tua identità federata.

Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

Il metodo projects.events.report supporta anche le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non devi configurare un file di Credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Crea una chiave API nella Google Cloud documentazione sull'autenticazione di.

Utilizzare l'interfaccia di configurazione di Ruby on Rails

Per utilizzare la libreria Error Reporting per Ruby con il framework Ruby on Rails, fornisci i parametri tramite l'interfaccia di configurazione di Ruby on Rails:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

Puoi anche impostare una configurazione condivisa per tutti i gem Stackdriver utilizzando quanto segue:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

Error Reporting è abilitato per impostazione predefinita quando Rails è in esecuzione in modalità di produzione. Per abilitare Error Reporting in modalità di sviluppo, aggiungi quanto segue:

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

Utilizzare l'interfaccia di configurazione della strumentazione

Per utilizzare la libreria Error Reporting per Ruby in altre applicazioni basate su Rack, fornisci i parametri tramite l'interfaccia di configurazione:

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

Puoi anche impostare una configurazione condivisa per tutti i gem di Google Cloud Observability utilizzando quanto segue:

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

Visualizzare i gruppi di errori

Nella Google Cloud console, vai alla pagina Error Reporting.

Vai a Error Reporting

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Per saperne di più, consulta Visualizzare e filtrare i gruppi di errori.