Configurar o Cloud Logging para Ruby

Pode escrever registos no Cloud Logging a partir de aplicações Ruby através da biblioteca Cloud Logging para Ruby ou da biblioteca cliente Google Cloud Cloud Logging para Ruby diretamente.

Não tem de instalar o agente do Cloud Logging para usar a biblioteca do Cloud Logging para Ruby numa instância de VM do Compute Engine.

Antes de começar

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.

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 (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 Cloud Logging API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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 (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 Cloud Logging API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

1. Instale o Ruby 2.2+ ou superior.

A instalar a biblioteca

Disponibilizamos uma biblioteca do Cloud Logging para Ruby, que oferece uma implementação de registador fácil de usar para frameworks Web Ruby baseados em Rack:

1. Adicione o gem Google Cloud Observability ao seu Gemfile:

   gem "stackdriver"

2. Use o Bundler para instalar o gem:

   bundle install
   

Ativar a biblioteca

Se estiver a usar o Ruby on Rails, o Bundler carrega automaticamente a biblioteca na sua aplicação quando esta é iniciada, o que define o Rails.logger predefinido como uma instância do registador do Cloud Logging.

Outras aplicações baseadas no Rack podem usar o middleware do Rack para substituir o registador do Rack pelo registador do Cloud Logging se a sua framework Web suportar o registador do Rack:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configurar a biblioteca

Pode personalizar o comportamento da biblioteca Cloud Logging para Ruby. Consulte a configuração da biblioteca para ver uma lista de opções de configuração possíveis.

Usar o registador do Cloud Logging

Depois de ativar a biblioteca Cloud Logging para Ruby, pode usar o registador na sua aplicação:

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

Para mais informações sobre a instalação, consulte a documentação da biblioteca Cloud Logging para Ruby. Também pode comunicar problemas através do relatório de erros.

Escreva registos com a biblioteca de cliente do Cloud Logging

Para obter informações sobre a utilização da biblioteca cliente do Cloud Logging para Ruby diretamente, consulte Bibliotecas cliente do Cloud Logging.

Executar em Google Cloud

Para que uma aplicação escreva registos através da biblioteca Cloud Logging para Ruby, a conta de serviço do recurso subjacente tem de ter a função Logs Writer (roles/logging.logWriter) do IAM. A maioria dos Google Cloud ambientes configura automaticamente a conta de serviço predefinida para ter esta função.

App Engine

O Cloud Logging é ativado automaticamente para o App Engine, e a conta de serviço predefinida da sua app tem as autorizações de IAM predefinidas para escrever entradas de registo.

Para mais informações, consulte o artigo Escrever e ver registos.

Google Kubernetes Engine (GKE)

O GKE concede automaticamente à conta de serviço predefinida a função do IAM Logs Writer (roles/logging.logWriter). Se usar a Workload Identity Federation para o GKE com esta conta de serviço predefinida para permitir que as cargas de trabalho acedam a Google Cloud APIs específicas, não é necessária nenhuma configuração adicional. No entanto, se usar a Workload Identity Federation para o GKE com uma conta de serviço do IAM personalizada, certifique-se de que a conta de serviço personalizada tem a função de escritor de registos (roles/logging.logWriter).

Se necessário, também pode usar o seguinte comando para adicionar o logging.write âmbito de acesso ao criar o cluster:

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

Compute Engine

Nota: para usar a biblioteca Cloud Logging para Ruby numa instância de VM do Compute Engine, não precisa de instalar o agente Cloud Logging.

Quando usar instâncias de VM do Compute Engine, adicione o cloud-platform âmbito de acesso a cada instância. Quando cria uma nova instância através da Google Cloud consola, pode fazê-lo na secção Identidade e acesso à API do painel Criar instância. Use a conta de serviço predefinida do Compute Engine ou outra conta de serviço à sua escolha e selecione Permitir acesso total a todas as APIs Cloud na secção Identidade e acesso à API. Qualquer que seja a conta de serviço que selecionar, certifique-se de que lhe foi concedida a função Logs Writer na secção IAM e administrador daGoogle Cloud consola.

Executar localmente e noutro local

Para usar a biblioteca Cloud Logging para Ruby fora do Google Cloud, incluindo a execução da biblioteca na sua própria estação de trabalho, nos computadores do seu centro de dados ou nas instâncias de VMs de outro fornecedor de nuvem, tem de configurar as Credenciais predefinidas da aplicação (ADC) no seu ambiente local para autenticar na biblioteca Cloud Logging para Ruby.

Para mais informações, consulte o artigo Configure o ADC para um ambiente no local ou outro fornecedor de nuvem.

Usando a interface de configuração do Ruby on Rails:

Forneça os parâmetros através da interface de configuração do Ruby on Rails se estiver a usar a 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

Também pode definir a configuração partilhada para todas as gems do Google Cloud Observability através do seguinte comando:

# 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

O registo está ativado por predefinição quando o Rails está em execução no modo de produção. Para ativar o registo no modo de programação, adicione o seguinte:

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

Usar a interface de configuração da instrumentação:

Forneça os parâmetros através da interface de configuração quando usados noutras aplicações baseadas em 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

Também pode definir a configuração partilhada para todas as gems do Google Cloud Observability através do seguinte comando:

require "stackdriver"

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

Ver os registos

Na Google Cloud consola, aceda à página Explorador de registos:

Aceda ao Explorador de registos

Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cuja legenda é Registo.

No Explorador de registos, tem de especificar um ou mais recursos, mas a seleção de recursos pode não ser óbvia. Seguem-se algumas sugestões para ajudar a começar:

• Se estiver a implementar a sua aplicação no App Engine ou a usar as bibliotecas específicas do App Engine, defina o seu recurso como Aplicação GAE.

• Se estiver a implementar a sua aplicação no Compute Engine, defina o recurso como GCE VM Instance.

• Se estiver a implementar a sua aplicação no Google Kubernetes Engine, a configuração de registo do cluster determina o tipo de recurso das entradas de registo. Para uma discussão detalhada sobre o Google Cloud Observability antigo e as soluções de monitorização do Kubernetes do Google Cloud Observability, e como essas opções afetam o tipo de recurso, consulte o artigo Migrar para a monitorização do Kubernetes do Google Cloud Observability.

• Se a sua aplicação estiver a usar a API Cloud Logging diretamente, o recurso depende da API e da sua configuração. Por exemplo, na sua aplicação, pode especificar um recurso ou usar um recurso predefinido.

• Se não vir registos no Explorador de registos, para ver todas as entradas de registo, mude para o modo de consulta avançado e use uma consulta vazia.

  1. Para mudar para o modo de consulta avançado, clique no menu (▾) na parte superior do Explorador de registos e, em seguida, selecione Converter em filtro avançado.
  2. Limpar o conteúdo apresentado na caixa de filtro.
  3. Clique em Enviar filtro.

  Pode examinar as entradas individuais para identificar os seus recursos.

Para mais informações, consulte o artigo Usar o Explorador de registos.