Escolha uma abordagem de instrumentação

Esta página contém recomendações para instrumentar a sua app em diferentes Google Cloud plataformas, como o Google Kubernetes Engine (GKE) e o Cloud Run. Se a sua app ainda não estiver instrumentada, use estas recomendações como orientação sobre como instrumentar a sua app para enviar dados de telemetria para Google Cloud. As recomendações nesta página não são as únicas soluções, e outras abordagens podem funcionar. Para receber orientações adicionais, contacte o Google Cloud apoio técnico.

Existem recomendações para o seguinte:

Para ver informações sobre exemplos de instrumentação, consulte os documentos indicados na secção Exemplos de código.

GKE

Para obter informações gerais sobre o GKE, consulte o artigo Vista geral do GKE.

Tipo Recomendação
Métrica

Recomendamos que use o serviço gerido do Google Cloud para o Prometheus.

Para a instrumentação, faça um dos seguintes procedimentos:

Rastreios

Faça o seguinte:

  1. Use o SDK OpenTelemetry e o exportador OTLP para o seu idioma.
  2. Configure o coletor do OpenTelemetry para enviar rastreios OTLP para Google Cloud.
Registos

Configure a sua app para gerar registos estruturados em JSON para stdout e stderr. Para ver uma lista de frameworks, consulte o artigo Frameworks de registo recomendados.

O GKE recolhe automaticamente registos escritos em stdout e stderr. Para mais informações, consulte o artigo Acerca dos registos do GKE.

Compute Engine

Para obter informações gerais sobre o Compute Engine, consulte o artigo Instâncias de máquinas virtuais.

Tipo Recomendação
Métricas e rastreios

Faça o seguinte:

  1. Use o SDK OpenTelemetry e o exportador OTLP para o seu idioma.
  2. Use o agente de operações para recolher métricas e rastreios. Para ver um exemplo, consulte Recolha métricas e rastreios do protocolo OpenTelemetry (OTLP).

Em alternativa, se quiser configurar a recolha apenas para métricas no formato Prometheus, pode usar o recetor Prometheus do agente de operações para recolher métricas instrumentadas através das bibliotecas de cliente Prometheus ou do SDK OpenTelemetry.

Registos

Faça o seguinte:

  1. Configure a sua app para gerar registos estruturados em JSON num ficheiro. Para ver uma lista de frameworks, consulte o artigo Frameworks de registo recomendados.
  2. Instale o agente de operações e configure um recetor. Para ver um exemplo, consulte Registo de recetores.

Cloud Run

Para obter informações gerais sobre o Cloud Run, consulte o artigo O que é o Cloud Run.

Tipo Recomendação
Métricas e rastreios

Faça o seguinte:

  1. Use o SDK OpenTelemetry e o exportador OTLP para o seu idioma.
  2. Configure o sidecar do OpenTelemetry para recolher métricas e rastreios. Para ver um exemplo, consulte o artigo Escreva métricas OTLP usando um sidecar do OpenTelemetry.
  3. Defina a CPU para ser sempre atribuída no Cloud Run. Uma vez que a instrumentação do OpenTelemetry faz o processamento em segundo plano, recomendamos que os serviços do Cloud Run instrumentados usem uma CPU sempre alocada. Para mais informações, consulte Alocação de CPU (serviços).

Em alternativa, se quiser configurar a recolha apenas para métricas no formato Prometheus, pode usar o sidecar do Prometheus para o Cloud Run para recolher métricas instrumentadas através das bibliotecas de cliente do Prometheus ou do SDK OpenTelemetry.

Registos

Configure a sua app para gerar registos estruturados em JSON para stdout e stderr. Para ver uma lista de frameworks, consulte o artigo Frameworks de registo recomendados.

O Cloud Run recolhe automaticamente os registos escritos em stdout e stderr. Para mais informações, consulte o artigo Escreva registos de contentores.

Funções do Cloud Run

Para informações gerais sobre as funções do Cloud Run, consulte o artigo Vista geral das funções do Cloud Run.

Tipo Recomendação
Métrica A escrita direta de métricas não é suportada em funções do Cloud Run. Para gerar métricas, recomendamos que use métricas baseadas em registos.
Rastreios Use o SDK e o exportador do Cloud Trace para o seu idioma.
Registos

Configure a sua app para gerar registos estruturados em JSON para stdout e stderr. Para ver uma lista de frameworks, consulte o artigo Frameworks de registo recomendados.

As funções do Cloud Run recolhem automaticamente os registos escritos no stdout e no stderr. Para mais informações, consulte o artigo Veja e escreva registos de funções do Cloud Run.

App Engine

Para ver informações gerais sobre o App Engine, consulte o artigo Uma vista geral do App Engine.

Tipo Recomendação
Métrica Use o SDK e o exportador do Cloud Monitoring para o seu idioma.
Rastreios Use o SDK e o exportador do Cloud Trace para o seu idioma.
Registos

Configure a sua app para gerar registos estruturados em JSON para stdout e stderr. Para ver uma lista de frameworks, consulte o artigo Frameworks de registo recomendados.

O App Engine recolhe automaticamente os registos escritos em stdout e stderr. Para mais informações, consulte o artigo Escrever e ver registos.

Frameworks de registo recomendados

Para recolher registos, recomendamos que use uma framework que possa ser configurada para gerar objetos JSON serializados para stdout, stderr ou para um ficheiro. O agente de registo, quer esteja integrado ou instalado, extrai o ficheiro e escreve registos estruturados para o Cloud Logging. Para escrever dados de registo, recomendamos o seguinte:

Exemplos de código

Para ver exemplos de código que ilustram como instrumentar a sua aplicação para enviar telemetria para o Google Cloud, consulte o seguinte:

Referências ao OpenTelemetry

Esta secção fornece links para o SDK OpenTelemetry e os exportadores para OTLP, Cloud Trace e Cloud Monitoring.

Referências gerais:

Ir

Java

JavaScript

Python