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.

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 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.

  2. 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.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Logging 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

  5. 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.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Logging 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

    8.
  8. Installa Ruby 2.2 o versioni successive.

Installare la libreria

Forniamo una libreria Cloud Logging per Ruby, che fornisce un'implementazione del 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

Abilitare la libreria

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 framework web supporta il logger Rack:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configurare la libreria

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

Utilizzare il 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 saperne di più 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 Cloud Logging

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

Esegui su Google Cloud

Affinché un'applicazione possa scrivere log utilizzando la libreria Cloud Logging per Ruby, il account di servizio della risorsa sottostante deve avere il ruolo IAM Writer log (roles/logging.logWriter). La maggior parte degli Google Cloud ambienti configura automaticamente il 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 delle autorizzazioni IAM per scrivere voci di log.

Per saperne di più, consulta Scrivere e visualizzare i log.

Google Kubernetes Engine (GKE)

GKE concede automaticamente al account di servizio predefinito il ruolo IAM Writer log (roles/logging.logWriter). Se utilizzi Workload Identity Federation for GKE con questo account di servizio predefinito per consentire ai carichi di lavoro di accedere ad API specifiche Google Cloud , non è necessaria alcuna configurazione aggiuntiva. Tuttavia, se utilizzi Workload Identity Federation for GKE con un account di servizio IAM personalizzato, assicurati che il service account personalizzato abbia il ruolo Writer 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

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

Esegui in locale e altrove

Per utilizzare la libreria Cloud Logging per Ruby al di fuori di Google Cloud, inclusa l'esecuzione della libreria sulla tua workstation, sui computer del tuo data center o sulle istanze VM di un altro provider cloud, devi configurare le Credenziali predefinite dell'applicazione (ADC) nel tuo ambiente locale per autenticare la libreria Cloud Logging per Ruby.

Per saperne di più, consulta Configurare ADC per on-premise o un altro provider cloud.

Utilizzo dell'interfaccia di configurazione di Ruby on Rails:

Se utilizzi 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 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 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 abilitare il 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 viene utilizzata 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 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

Visualizzare i log

Nella Google Cloud console, 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 che ti aiuteranno a iniziare.

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

  • Se esegui il deployment dell'applicazione su Compute Engine, imposta la risorsa su Istanza 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 Legacy Google Cloud Observability e Google Cloud Observability Kubernetes Monitoring e su come queste opzioni influiscono sul tipo di risorsa, consulta Eseguire la migrazione a Google Cloud Observability Kubernetes Monitoring.

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

  • Se non vedi log in Esplora log, per visualizzare 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 e 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 tue risorse.

Per ulteriori informazioni, consulta Utilizzo di Esplora log.