Configurazione di Cloud Logging per Ruby

Puoi scrivere log in Cloud Logging dalle applicazioni Ruby utilizzando la libreria Cloud Logging per Ruby o direttamente la libreria client Cloud Logging per Ruby.

L'agente Cloud Logging non deve essere installato per utilizzare la biblioteca Cloud Logging per Ruby su un'istanza VM Compute Engine.

Prima di iniziare

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.

   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

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.

   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

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

7. Enable the Cloud Logging API.

   Enable the API

8. Installa Ruby 2.2 o versioni successive.

Installazione della libreria

Forniamo una libreria Cloud Logging per Ruby, che offre un'implementazione di logger facile da usare per i framework web Ruby basati su Rack:

1. Aggiungi il gem Google Cloud Observability al tuo Gemfile:

   gem "stackdriver"

2. Utilizza Bundler per installare il gem:

   bundle install
   

Attivazione della raccolta

Se utilizzi Ruby on Rails, Bundler carica automaticamente la libreria nella tua applicazione all'avvio, impostando Rails.logger predefinito su un'istanza del logger Cloud Logging.

Altre applicazioni basate su Rack possono utilizzare il middleware Rack per sostituire il logger Rack con il logger Cloud Logging se il tuo framework web supporta il logger Rack:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configurazione della libreria

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

Utilizzo del logger Cloud Logging

Una volta abilitata la libreria Cloud Logging per Ruby, puoi utilizzare il logger nella tua applicazione:

logger.info "Hello World!"
logger.error "Oh No!"

Per ulteriori informazioni sull'installazione, consulta la documentazione della libreria Cloud Logging per Ruby. Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Scrivere log con la libreria client di Cloud Logging

Per informazioni sull'utilizzo diretto della libreria client di Cloud Logging per Ruby, consulta la sezione Librerie client di Cloud Logging.

Esegui su Google Cloud

Affinché un'applicazione possa scrivere log utilizzando la libreria Cloud Logging per Ruby, l'account di servizio per la risorsa sottostante deve disporre del ruolo IAM Writer di log (roles/logging.logWriter). La maggior parte degli ambienti Google Cloud configura automaticamente l'account di servizio predefinito in modo che abbia questo ruolo.

App Engine

Cloud Logging è abilitato automaticamente per App Engine e il service account predefinito della tua app dispone per impostazione predefinita delle autorizzazioni IAM per scrivere le voci di log.

Per ulteriori informazioni, consulta la sezione Scrittura e visualizzazione dei log.

Google Kubernetes Engine (GKE)

GKE concede automaticamente allo account di servizio predefinito il ruolo IAM Scrittore di log (roles/logging.logWriter). Se utilizzi la federazione delle identità per i carichi di lavoro per GKE con questo account di servizio predefinito per consentire ai carichi di lavoro di accedere ad API Google Cloud specifiche, non è richiesta alcuna configurazione aggiuntiva. Tuttavia, se utilizzi la federazione delle identità per i carichi di lavoro per GKE con un account di servizio IAM personalizzato, assicurati che l'account di servizio personalizzato abbia il ruolo di autore di log (roles/logging.logWriter).

Se necessario, puoi anche utilizzare il seguente comando per aggiungere l'ambito di accesso logging.write durante la creazione del cluster:

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

Compute Engine

Nota: per utilizzare la libreria Cloud Logging per Ruby su un'istanza VM Compute Engine, non è necessario installare l'agente Cloud Logging.

Quando utilizzi le istanze VM di Compute Engine, aggiungi l'ambito di accesso cloud-platform a ogni istanza. Quando crei una nuova istanza tramite la console Google Cloud, puoi farlo nella sezione Accesso a identità e API del riquadro Crea istanza. Utilizza l'account di servizio predefinito di Compute Engine o un altro account di servizio a tua scelta e seleziona Consenti l'accesso completo a tutte le API Cloud nella sezione Identità e accesso API. Qualunque account di servizio tu selezioni, assicurati che sia stato concesso il ruolo Scrittore di log nella sezione IAM e amministrazione della console Google Cloud.

Eseguire in locale e altrove

Per utilizzare la libreria Cloud Logging per Ruby al di fuori di Google Cloud, incluso l'esecuzione della libreria sulla tua workstation, sui computer del tuo data center o sulle istanze VM di un altro provider cloud, devi fornire l'ID progetto Google Cloud e le credenziali dell'account di servizio appropriato direttamente alla libreria Cloud Logging per Ruby.

Per gli account di servizio esistenti:

1. Concedi all'account di servizio il ruolo IAM Logs Writer (roles/logging.logWriter). Per ulteriori informazioni sui ruoli IAM, consulta Controllo dell'accesso.

2. Configura le credenziali predefinite dell'applicazione.

Se non hai un account di servizio, creane uno. Per informazioni su questa procedura, vedi Creare account di servizio.

Per informazioni generali sui metodi che puoi utilizzare per l'autenticazione, consulta Terminologia: account di servizio.

Utilizzo dell'interfaccia di configurazione di Ruby on Rails:

Fornisci i parametri tramite l'interfaccia di configurazione di Ruby on Rails se utilizzi il framework Ruby on Rails:

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

Puoi anche impostare la configurazione condivisa per tutti i gem di Google Cloud Observability utilizzando:

# 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

Il logging è abilitato per impostazione predefinita quando Rails è in esecuzione in modalità di produzione. Per attivare la registrazione in modalità di sviluppo, aggiungi quanto segue:

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

Utilizzo dell'interfaccia di configurazione dell'instrumentazione:

Fornisci i parametri tramite l'interfaccia di configurazione se utilizzati in altre applicazioni basate su rack:

require "google/cloud/logging"

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

Puoi anche impostare la configurazione condivisa per tutti i gem di Google Cloud Observability utilizzando:

require "stackdriver"

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

Visualizza i log

Nella console Google Cloud, vai alla pagina Esplora log:

Vai a Esplora log

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

In Esplora log devi specificare una o più risorse, ma la selezione delle risorse potrebbe non essere ovvia. Ecco alcuni suggerimenti per iniziare:

• Se esegui il deployment dell'applicazione in App Engine o utilizzi le librerie specifiche di App Engine, imposta la risorsa su App GAE.

• Se stai eseguendo il deployment dell'applicazione su Compute Engine, imposta la risorsa su Istanzia VM GCE.

• Se esegui il deployment dell'applicazione su Google Kubernetes Engine, la configurazione di logging del cluster determina il tipo di risorsa delle voci di log. Per una discussione dettagliata sulle soluzioni di monitoraggio Kubernetes di Google Cloud Observability precedenti e di Google Cloud Observability e su come queste opzioni influiscono sul tipo di risorsa, consulta Eseguire la migrazione al monitoraggio Kubernetes di Google Cloud Observability.

• Se la tua applicazione utilizza direttamente l'API Cloud Logging, la risorsa dipende dall'API e dalla tua configurazione. Ad esempio, nella tua applicazione puoi specificare una risorsa o utilizzare una risorsa predefinita.

• Se non vedi nessun log in Esplora log, per visualizzare tutte le voci dei log, passa alla modalità di query avanzata e utilizza una query vuota.

  1. Per passare alla modalità di query avanzata, fai clic su menu (▾) nella parte superiore di Esplora log e poi seleziona Converti in filtro avanzato.
  2. Cancella i contenuti visualizzati nella casella del filtro.
  3. Fai clic su Invia filtro.

  Puoi esaminare le singole voci per identificare le risorse.

Per ulteriori informazioni, consulta Utilizzare Esplora log.