Como configurar o Cloud Logging para Go

Nós fornecemos um pacote de geração de registros compatível com a biblioteca padrão. A biblioteca do Cloud Logging para Go expõe uma camada de nível superior para trabalhar com o Cloud Logging.

O agente do Cloud Logging não precisa ser instalado para usar a biblioteca do Cloud Logging para Go em uma instância de VM do Compute Engine.

Antes de começar

  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.

    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.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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.

Como instalar o pacote

go get cloud.google.com/go/logging

Como usar o logger do Go


// Sample stdlogging writes log.Logger logs to the Cloud Logging.
package main

import (
	"context"
	"log"

	"cloud.google.com/go/logging"
)

func main() {
	ctx := context.Background()

	// Sets your Google Cloud Platform project ID.
	projectID := "YOUR_PROJECT_ID"

	// Creates a client.
	client, err := logging.NewClient(ctx, projectID)
	if err != nil {
		log.Fatalf("Failed to create client: %v", err)
	}
	defer client.Close()

	// Sets the name of the log to write to.
	logName := "my-log"

	logger := client.Logger(logName).StandardLogger(logging.Info)

	// Logs "hello world", log entry is visible at
	// Cloud Logs.
	logger.Println("hello world")
}

Para mais informações sobre a instalação, consulte a documentação da biblioteca do Cloud Logging para Go. Também é possível informar problemas usando o Issue Tracker.

Gravar registros com a biblioteca de cliente do Cloud Logging

Para informações sobre como usar diretamente a biblioteca de cliente do Cloud Logging para Go, consulte Bibliotecas de cliente do Cloud Logging.

Executar no Google Cloud

Para que um aplicativo grave registros usando a biblioteca do Cloud Logging para Go, a conta de serviço do recurso subjacente precisa ter a função do IAM gravador de registros (roles/logging.logWriter). A maioria dos ambientes do Google Cloud configura automaticamente a conta de serviço padrão para ter esse papel.

App Engine

O Cloud Logging é ativado automaticamente para o App Engine, e a conta de serviço padrão do aplicativo tem as permissões do IAM por padrão para gravar entradas de registro.

Saiba mais em Gravar e visualizar registros.

Google Kubernetes Engine (GKE)

O GKE concede automaticamente à conta de serviço padrão o papel do IAM Gravador de registros (roles/logging.logWriter). Se você usar a Federação de identidade da carga de trabalho para o GKE com essa conta de serviço padrão para permitir que as cargas de trabalho acessem APIs específicas do Google Cloud, nenhuma configuração adicional será necessária. No entanto, se você usar a Federação de Identidade da Carga de Trabalho para GKE com uma conta de serviço personalizada do IAM, verifique se a conta de serviço personalizada tem a função de Logs Writer (roles/logging.logWriter).

Se necessário, também é possível usar o seguinte comando para adicionar o escopo de acesso logging.write ao criar o cluster:

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

Compute Engine

Ao usar instâncias de VM do Compute Engine, adicione o escopo de acesso cloud-platform a cada instância. Ao criar uma nova instância no console do Google Cloud, faça isso na seção Identidade e acesso à API do painel Criar instância. Use a conta de serviço padrão do Compute Engine ou outra de sua escolha e selecione Permitir acesso completo a todas as APIs do Cloud na seção Identidade e acesso à API. Seja qual for a conta de serviço selecionada, verifique se ela recebeu o papel de gravador de registros na seção IAM e administrador do Console do Google Cloud.

Execute localmente e em outro lugar

Para usar a biblioteca do Cloud Logging para Go fora do Google Cloud, incluindo a execução da biblioteca na sua própria estação de trabalho, nos computadores do seu data center ou nas instâncias de VM de outro provedor de nuvem, é necessário fornecer o ID do projeto do Google Cloud e as credenciais da conta de serviço adequadas diretamente à biblioteca do Cloud Logging para Go.

Para contas de serviço existentes, faça o seguinte:

  1. Conceda à conta de serviço o papel do IAM de gravador de registros (roles/logging.logWriter). Para mais informações sobre os papéis do IAM, consulte Controle de acesso.

  2. Configure as credenciais padrão do aplicativo.

Se você não tiver uma conta de serviço, crie uma. Para saber mais sobre esse processo, consulte Criar contas de serviço.

Para informações gerais sobre os métodos que podem ser usados para autenticação, consulte Terminologia: contas de serviço.

Visualize os registros

No console do Google Cloud, acesse a página Análise de registros:

Acessar a Análise de registros

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.

No Explorador de registros, é preciso especificar um ou mais recursos, mas a escolha deles pode não ser óbvia. Veja a seguir algumas dicas para ajudar você a começar:

  • Se você estiver implantando seu aplicativo no App Engine ou usando as bibliotecas específicas dele, defina seu recurso como Aplicativo do GAE.

  • Se você estiver implantando seu aplicativo no Compute Engine, defina o recurso como Instância de VM do GCE.

  • Se você estiver implantando seu aplicativo no Google Kubernetes Engine, a configuração de geração de registros do cluster determinará o tipo de recurso das entradas de registro. Para uma discussão detalhada sobre o Legacy Google Cloud Observability e as soluções do Kubernetes Monitoring do Google Cloud Observability, e como essas opções afetam o tipo de recurso, consulte Como migrar para o Kubernetes Monitoring do Google Cloud Observability.

  • Se o aplicativo estiver usando a API Cloud Logging diretamente, o recurso dependerá da API e da configuração. Por exemplo, no seu aplicativo, é possível especificar um recurso ou usar um recurso padrão.

  • Se você não vir registros no Explorador de registros, alterne para o modo de consulta avançada e use uma consulta vazia para ver todas as entradas de registro.

    1. Se quiser alternar para o modo de consulta avançada, clique no menu (▾) na parte superior do Explorador de registros e selecione Converter para filtro avançado.
    2. Limpe o conteúdo que aparece na caixa de filtro.
    3. Clique em Enviar filtro.

    É possível examinar as entradas individuais para identificar seus recursos.

Para mais informações, consulte Como usar o Explorador de registros.