Esta página mostra as etapas a seguir:
- 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 conteúdo de referência do OpenTelemetry, consulte:
Para os detalhes mais recentes sobre o OpenTelemetry para C++, além de outras documentações e exemplos, consulte OpenTelemetry.
Antes de começar
Ative a API Cloud Trace.
Instalar os pacotes do OpenTelemetry
- Configure um ambiente de desenvolvimento em C++.
- Instale a biblioteca de exportação C++ do OpenTelemetry do Google Cloud. Para informações de instalação, consulte o guia de início rápido do OpenTelemetry.
Configurar a exportação de períodos para o Cloud Trace
Para configurar a exportação de dados de trace, chame o
método google::cloud::otel::ConfigureBasicTracing(...)
no método
main()
:
O campo project_id
é o projeto do Google Cloud em que você quer armazenar os
traces.
O método ConfigureBasicTracing(...)
instancia um
objeto TracerProvider
que implementa
um exportador do Cloud Trace. Se o objeto retornado pela chamada para
ConfigureBasicTracing(...)
sair do escopo, o objeto
TracerProvider
anterior será restabelecido, quando existir.
Configurar taxa de amostragem
Os aplicativos podem gerar um grande volume de dados de trace. A amostra a seguir ilustra como configurar a taxa de amostragem:
Exportar para o Cloud Trace com um TracerProvider
personalizado
Você pode ter casos de uso que exigem um objeto TracerProvider
personalizado. Por exemplo, se você quiser usar vários exportadores ao mesmo tempo, será necessário criar um objeto TracerProvider
personalizado. Nesses casos, use o exportador do Cloud Trace diretamente:
Instrumentar o próprio aplicativo
Para ver informações sobre como configurar seu aplicativo para capturar períodos de rastreamento, consulte Rastreamento do OpenTelemetry. Esta página descreve como fazer o seguinte:
- Criar um período
- Criar períodos aninhados
- Definir atributos de período
- Criar períodos com eventos
- Criar períodos com links
Exemplo de aplicativo
Para ver um aplicativo de amostra, consulte o quickstart.
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, é preciso garantir que o Google Cloud Platform 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ê usar 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.
Você pode 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. Esta é a lista dos 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.
Para depurar o exportador do Cloud Trace para C++, consulte a seção Solução de problemas da documentação de referência.
Recursos
- https://opentelemetry.io/
- open-telemetry/opentelemetry-cpp: repositório do GitHub
- google-cloud-cpp biblioteca OpenTelemetry Exporters do GitHub.