Configurazione di Cloud Logging per Ruby

Puoi scrivere log su Cloud Logging da applicazioni Ruby utilizzando la libreria Cloud Logging per Ruby oppure direttamente la libreria client Cloud di Cloud Logging per Ruby.

Non è necessario installare l'agente Cloud Logging per utilizzare la libreria Cloud Logging per Ruby su un'istanza VM di Compute Engine.

Prima di iniziare

1. Accedi al tuo account Google Cloud. 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 gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

4. Attiva Cloud Logging API.

   Abilita l'API

5. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

7. Attiva Cloud Logging API.

   Abilita l'API

8. Installa Ruby 2.2 o versioni successive.

Installazione della libreria

Forniamo una libreria Cloud Logging per Ruby, che fornisce un'implementazione dellogger di facile utilizzo per i framework web Ruby basati su rack:

1. Aggiungi la gemma di osservabilità di Google Cloud al tuo file Gemfile:

   gem "stackdriver"

2. Usa Bundler per installare la gemma:

   bundle install
   

Attivazione della libreria

Se utilizzi Ruby su Rails, Bundler carica automaticamente la libreria nella tua applicazione all'avvio, impostando il valore predefinito Rails.logger 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 framework web supporta Rack logger:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configurazione della libreria

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

Utilizzo di Cloud Logging Logger

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 relativa alla libreria di Cloud Logging per Ruby. Puoi anche segnalare i problemi utilizzando Issue Tracker.

Scrivere log con la libreria client di Cloud Logging

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

Esegui su Google Cloud

Affinché un'applicazione scriva log utilizzando la libreria Cloud Logging per Ruby, l'account di servizio per la risorsa sottostante deve avere il ruolo Writer log (roles/logging.logWriter) IAM. La maggior parte degli ambienti Google Cloud configura automaticamente l'account di servizio predefinito con questo ruolo.

App Engine

Cloud Logging è abilitato automaticamente per App Engine e l'account di servizio predefinito della tua app dispone per impostazione predefinita delle autorizzazioni IAM per la scrittura di voci di log.

Per ulteriori informazioni, consulta Scrittura e visualizzazione dei log.

Google Kubernetes Engine (GKE)

GKE concede automaticamente all'account di servizio predefinito il ruolo IAM Writer log (roles/logging.logWriter). Se utilizzi Workload Identity con questo account di servizio predefinito per consentire ai carichi di lavoro di accedere a specifiche API Google Cloud, non è necessaria alcuna configurazione aggiuntiva. Tuttavia, se utilizzi Workload Identity con un account di servizio IAM personalizzato, assicurati che l'account di servizio personalizzato abbia il ruolo di Writer log (roles/logging.logWriter).

Se necessario, puoi anche utilizzare il comando seguente 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 di 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 Identità e accesso 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 seleziona, assicurati che gli sia stato concesso il ruolo Writer log nella sezione IAM e amministrazione della console Google Cloud.

Esegui in locale e altrove

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

Per gli account di servizio esistenti:

1. Concedi all'account di servizio il ruolo IAM Writer log (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 questo processo, consulta 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 Ruby on Rails:

Fornisci i parametri tramite l'interfaccia di configurazione 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 una configurazione condivisa per tutte le risorse di osservabilità di Google Cloud 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 abilitare Logging 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 della strumentazione:

Fornisci i parametri tramite l'interfaccia di configurazione quando 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 una configurazione condivisa per tutte le risorse di osservabilità di Google Cloud 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

Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:

Vai a Esplora log

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

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

• Se esegui il deployment della tua applicazione su Compute Engine, imposta la risorsa su Istanza VM GCE.

• Se esegui il deployment della tua 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 legacy di Google Cloud per l'osservabilità e sull'osservabilità di Google Cloud, e su come queste opzioni influiscono sul tipo di risorsa, consulta Migrazione a Google Cloud Observability Kubernetes Monitoring.

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

• Se non vedi log in Esplora log, per vedere tutte le voci di 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, quindi seleziona Converti in filtro avanzato.
  2. Cancella i contenuti visualizzati nella casella dei filtri.
  3. Fai clic su Invia filtro.

  Puoi esaminare le singole voci per identificare le risorse.

Per ulteriori informazioni, consulta Utilizzo di Esplora log.