Nesta página, vamos orientar você nas seguintes etapas:
- Instale os pacotes do OpenTelemetry.
- Configure seu aplicativo para exportar períodos para o Cloud Trace.
- Configure sua plataforma.
Para ver informações sobre a versão, consulte:
Para conferir conteúdo de referência do OpenTelemetry, consulte:
Para ver os detalhes mais recentes sobre o OpenTelemetry para Go, além de documentação e exemplos extras, consulte OpenTelemetry.
Antes de começar
Ative a API necessária.
Como instalar, inicializar e usar o cliente
Consulte as instruções a seguir para instrumentar seus aplicativos Go no Compute Engine e no Google Kubernetes Engine. Para um exemplo geral de como usar o OpenTelemetry, consulte o repositório do OpenTelemetry para Go do GitHub.
Compute Engine
Instale o pacote OpenTelemetry:
go get go.opentelemetry.io/otel
go get github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace
Importe pacotes de exportação do OpenTelemetry e do Cloud Trace:
Crie o exportador e o provedor de trace:
Ao criar o exportador, você fornece informações sobre o
identificador de projeto do Google Cloud. Neste exemplo, o identificador é armazenado na
variável de ambiente GOOGLE_CLOUD_PROJECT
.
O aplicativo de exemplo chama a função WithBatcher
para configurar o provedor de trace
e enviar períodos ao Cloud Monitoring usando um processo em segundo plano.
O exemplo também está configurado para chamar a função Shutdown
do exportador na
saída do aplicativo. Quando Shutdown
é executado, ele envia todos os períodos pendentes para o
Cloud Monitoring. A configuração do exemplo é recomendada
para todos os ambientes operacionais, incluindo o
Cloud Run, em que os contêineres podem ser
encerrados
a qualquer momento.
Você nomeia a instância Tracer
no momento da criação.
No exemplo, o nome é example.com/trace
. Recomendamos que você nomeie
essas instâncias depois que o componente for rastreado, porque essa estratégia
permite várias instâncias.
Quando o exemplo é executado, é criado um único trace chamado foo
.
GKE;
Adicione o seguinte ao seu Dockerfile
:
RUN go get go.opentelemetry.io/otel
RUN go get github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace
Importe pacotes de exportação do OpenTelemetry e do Cloud Trace:
Crie o exportador e o provedor de trace:
Ao criar o exportador, você fornece informações sobre o
identificador de projeto do Google Cloud. Neste exemplo, o identificador é armazenado na
variável de ambiente GOOGLE_CLOUD_PROJECT
.
O aplicativo de exemplo chama a função WithBatcher
para configurar o provedor de trace
e enviar períodos ao Cloud Monitoring usando um processo em segundo plano.
O exemplo também está configurado para chamar a função Shutdown
do exportador na
saída do aplicativo. Quando Shutdown
é executado, ele envia todos os períodos pendentes para o
Cloud Monitoring. A configuração do exemplo é recomendada
para todos os ambientes operacionais, incluindo o
Cloud Run, em que os contêineres podem ser
encerrados
a qualquer momento.
Você nomeia a instância Tracer
no momento da criação.
No exemplo, o nome é example.com/trace
. Recomendamos que você nomeie
essas instâncias depois que o componente for rastreado, porque essa estratégia
permite várias instâncias.
Quando o exemplo é executado, é criado um único trace chamado foo
.
Como criar um período personalizado
É possível adicionar mais informações ao trace criado pelo sistema criando um período personalizado.
Para criar um período personalizado com o nome foo
, adicione ao código-fonte:
Aqui, example.com/trace
refere-se ao nome da instância do rastreador.
Configurar sua plataforma
Você pode usar o Cloud Trace no Google Cloud e em outras plataformas.
Como executar no Google Cloud
Quando seu aplicativo está em execução no Google Cloud, não é necessário fornecer credenciais de autenticação na forma de uma conta de serviço para a biblioteca de cliente. No entanto, você precisa garantir que sua plataforma do Google Cloud tenha o escopo de acesso da API Cloud Trace ativado.
Para uma lista de ambientes do Google Cloud compatíveis, consulte Suporte ao ambiente.
Para as seguintes configurações, as definições de escopo de acesso padrão ativam a API Cloud Trace:
- Ambiente flexível do App Engine
Ambiente padrão do App Engine
Google Kubernetes Engine (GKE)
Compute Engine
Cloud Run
Se você usa escopos de acesso personalizados, verifique se o escopo de acesso da API Cloud Trace está ativado:
Para informações sobre como configurar os escopos de acesso do ambiente usando o console do Google Cloud, consulte Como configurar o projeto do Google Cloud.
Para usuários do
gcloud
, especifique os escopos de acesso usando a sinalização--scopes
e inclua o escopo de acesso da API Cloud Tracetrace.append
. Por exemplo, para criar um cluster do GKE com apenas a API Cloud Trace ativada, faça o seguinte:gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
Execução local e em outro lugar
Se o aplicativo estiver em execução fora do Google Cloud, forneça as credenciais de autenticação na forma de uma conta de serviço para a biblioteca de cliente. A conta de serviço precisa conter o papel de agente do Cloud Trace. Para instruções, consulte Como criar uma conta de serviço.
As bibliotecas de cliente do Google Cloud usam o Application Default Credentials (ADC) para encontrar as credenciais do aplicativo.
É possível fornecer essas credenciais de três maneiras:
Executar
gcloud auth application-default login
Coloque a conta de serviço em um caminho padrão para seu sistema operacional. Veja a seguir os caminhos padrão para Windows e Linux:
Windows:
%APPDATA%/gcloud/application_default_credentials.json
Linux:
$HOME/.config/gcloud/application_default_credentials.json
Defina a variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS
como o caminho para sua conta de serviço:
Linux/macOS
export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
Windows
set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"
Ver traces
No console do Google Cloud, acesse a página Explorador de traces:
Acessar o Explorador de traces
Também é possível encontrar essa página usando a barra de pesquisa.
Solução de problemas
Para informações sobre como solucionar problemas com o Cloud Trace, acesse a página de solução de problemas.