Implemente o coletor OpenTelemetry criado pela Google no Google Kubernetes Engine

Este documento descreve como executar o coletor OpenTelemetry integrado na Google no Google Kubernetes Engine para recolher registos, métricas e rastreios OTLP de aplicações instrumentadas e, em seguida, exportar esses dados para o Google Cloud.

Antes de começar

A execução do coletor OpenTelemetry criado pela Google requer os seguintes recursos:

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 Telemetry, Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.

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 APIs

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 Telemetry, Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.

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 APIs

1. Um cluster do Kubernetes. Se não tiver um cluster do Kubernetes, siga as instruções no Início rápido do GKE.

2. As seguintes ferramentas de linha de comandos:

   • gcloud
   • kubectl

   As ferramentas gcloud e kubectl fazem parte da CLI gcloud. Para ver informações sobre a instalação, consulte o artigo Faça a gestão dos componentes da CLI Google Cloud. Para ver os componentes da CLI gcloud que tem instalados, execute o seguinte comando:

           gcloud components list
           

Configure as autorizações para o coletor

Se tiver desativado o Workload Identity do GKE, pode ignorar esta secção.

Para garantir que a conta de serviço do Kubernetes do OpenTelemetry Collector tem as autorizações necessárias para exportar a telemetria, peça ao seu administrador para conceder à conta de serviço do Kubernetes do OpenTelemetry Collector as seguintes funções de IAM no seu projeto:

Importante: tem de conceder estas funções à conta de serviço do Kubernetes do OpenTelemetry Collector e não à sua conta de utilizador. Se não conceder as funções ao principal correto, podem ocorrer erros de autorização.
• Monitoring Metric Writer (roles/monitoring.metricWriter)
• Logging Log Writer (roles/logging.logWriter)
• Agente do Cloud Trace (roles/cloudtrace.agent)

Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

O seu administrador também pode conseguir conceder à conta de serviço do Kubernetes do OpenTelemetry Collector as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

Para configurar as autorizações, use os seguintes comandos: add-iam-policy-binding

gcloud projects add-iam-policy-binding projects/PROJECT_ID \
    --role=roles/logging.logWriter \
    --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector
gcloud projects add-iam-policy-binding projects/PROJECT_ID \
    --role=roles/monitoring.metricWriter \
    --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector
gcloud projects add-iam-policy-binding projects/PROJECT_ID \
    --role=roles/cloudtrace.agent \
    --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector

Antes de executar os comandos, substitua as seguintes variáveis:

• PROJECT_ID: o identificador do projeto.
• PROJECT_NUMBER: o Google Cloud número do projeto.

Implemente o coletor

O pipeline do coletor pode ser implementado diretamente a partir dos exemplos validados fornecidos pelo repositório de ingestão do Kubernetes OTLP autogerido. Pode implementar diretamente a partir do GitHub com os seguintes comandos depois de substituir PROJECT_ID pelo ID do seu projeto Google Cloud :

export GOOGLE_CLOUD_PROJECT=PROJECT_ID
export PROJECT_NUMBER=PROJECT_NUMBER
kubectl kustomize https://github.com/GoogleCloudPlatform/otlp-k8s-ingest.git/k8s/base | envsubst | kubectl apply -f -

Antes de executar os comandos, substitua as seguintes variáveis:

• PROJECT_ID: o identificador do projeto.
• PROJECT_NUMBER: o identificador numérico do projeto.

Configure o coletor

Fornecemos uma configuração do OpenTelemetry Collector para usar com o coletor criado pela Google. Esta configuração foi concebida para fornecer volumes elevados de métricas, registos e rastreios OTLP com metadados do GKE e do Kubernetes anexados de forma consistente. Esta configuração também foi concebida para evitar problemas comuns de carregamento. Pode adicionar elementos à configuração, mas recomendamos vivamente que não remova elementos.

Esta secção descreve a configuração fornecida, os componentes principais, como exportadores, processadores, recetores e outros componentes disponíveis.

Configuração do coletor fornecida

Pode encontrar a configuração do coletor para ambientes Kubernetes no repositório otlp-k8s-ingest:
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

exporters:
  googlecloud:
    log:
      default_log_name: opentelemetry-collector
    user_agent: Google-Cloud-OTLP manifests:0.5.0 OpenTelemetry Collector Built By Google/0.131.0 (linux/amd64)
  googlemanagedprometheus:
    user_agent: Google-Cloud-OTLP manifests:0.5.0 OpenTelemetry Collector Built By Google/0.131.0 (linux/amd64)
  # The otlphttp exporter is used to send traces to Google Cloud Trace using OTLP http/proto
  # The otlp exporter could also be used to send them using OTLP grpc
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com
    # Use the googleclientauth extension to authenticate with Google credentials
    auth:
      authenticator: googleclientauth


extensions:
  health_check:
    endpoint: ${env:MY_POD_IP}:13133
  googleclientauth:


processors:
  filter/self-metrics:
    metrics:
      include:
        match_type: strict
        metric_names:
        - otelcol_process_uptime
        - otelcol_process_memory_rss
        - otelcol_grpc_io_client_completed_rpcs
        - otelcol_googlecloudmonitoring_point_count
  batch:
    send_batch_max_size: 200
    send_batch_size: 200
    timeout: 5s

  k8sattributes:
    extract:
      metadata:
      - k8s.namespace.name
      - k8s.deployment.name
      - k8s.statefulset.name
      - k8s.daemonset.name
      - k8s.cronjob.name
      - k8s.job.name
      - k8s.replicaset.name
      - k8s.node.name
      - k8s.pod.name
      - k8s.pod.uid
      - k8s.pod.start_time
    passthrough: false
    pod_association:
    - sources:
      - from: resource_attribute
        name: k8s.pod.ip
    - sources:
      - from: resource_attribute
        name: k8s.pod.uid
    - sources:
      - from: connection

  memory_limiter:
    check_interval: 1s
    limit_percentage: 65
    spike_limit_percentage: 20

  metricstransform/self-metrics:
    transforms:
    - action: update
      include: otelcol_process_uptime
      operations:
      - action: add_label
        new_label: version
        new_value: Google-Cloud-OTLP manifests:0.5.0 OpenTelemetry Collector Built By Google/0.131.0 (linux/amd64)

  resourcedetection:
    detectors: [gcp]
    timeout: 10s

  transform/collision:
    metric_statements:
    - context: datapoint
      statements:
      - set(attributes["exported_location"], attributes["location"])
      - delete_key(attributes, "location")
      - set(attributes["exported_cluster"], attributes["cluster"])
      - delete_key(attributes, "cluster")
      - set(attributes["exported_namespace"], attributes["namespace"])
      - delete_key(attributes, "namespace")
      - set(attributes["exported_job"], attributes["job"])
      - delete_key(attributes, "job")
      - set(attributes["exported_instance"], attributes["instance"])
      - delete_key(attributes, "instance")
      - set(attributes["exported_project_id"], attributes["project_id"])
      - delete_key(attributes, "project_id")

  # The relative ordering of statements between ReplicaSet & Deployment and Job & CronJob are important.
  # The ordering of these controllers is decided based on the k8s controller documentation available at
  # https://kubernetes.io/docs/concepts/workloads/controllers.
  # The relative ordering of the other controllers in this list is inconsequential since they directly
  # create pods.
  transform/aco-gke:
    metric_statements:
    - context: datapoint
      statements:
      - set(attributes["top_level_controller_type"], "ReplicaSet") where resource.attributes["k8s.replicaset.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.replicaset.name"]) where resource.attributes["k8s.replicaset.name"] != nil
      - set(attributes["top_level_controller_type"], "Deployment") where resource.attributes["k8s.deployment.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.deployment.name"]) where resource.attributes["k8s.deployment.name"] != nil
      - set(attributes["top_level_controller_type"], "DaemonSet") where resource.attributes["k8s.daemonset.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.daemonset.name"]) where resource.attributes["k8s.daemonset.name"] != nil
      - set(attributes["top_level_controller_type"], "StatefulSet") where resource.attributes["k8s.statefulset.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.statefulset.name"]) where resource.attributes["k8s.statefulset.name"] != nil
      - set(attributes["top_level_controller_type"], "Job") where resource.attributes["k8s.job.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.job.name"]) where resource.attributes["k8s.job.name"] != nil
      - set(attributes["top_level_controller_type"], "CronJob") where resource.attributes["k8s.cronjob.name"] != nil
      - set(attributes["top_level_controller_name"], resource.attributes["k8s.cronjob.name"]) where resource.attributes["k8s.cronjob.name"] != nil

  # When sending telemetry to the GCP OTLP endpoint, the gcp.project_id resource attribute is required to be set to your project ID.
  resource/gcp_project_id:
    attributes:
    - key: gcp.project_id
      # MAKE SURE YOU REPLACE THIS WITH YOUR PROJECT ID
      value: ${GOOGLE_CLOUD_PROJECT}
      action: insert
  # The metricstarttime processor is important to include if you are using the prometheus receiver to ensure the start time is set properly.
  # It is a no-op otherwise.
  metricstarttime:
    strategy: subtract_initial_point

receivers:
  # This collector is configured to accept OTLP metrics, logs, and traces, and is designed to receive OTLP from workloads running in the cluster.
  otlp:
    protocols:
      grpc:
        endpoint: ${env:MY_POD_IP}:4317
      http:
        cors:
          allowed_origins:
          - http://*
          - https://*
        endpoint: ${env:MY_POD_IP}:4318
  otlp/self-metrics:
    protocols:
      grpc:
        endpoint: ${env:MY_POD_IP}:14317

service:
  extensions:
  - health_check
  - googleclientauth
  pipelines:
    logs:
      exporters:
      - googlecloud
      processors:
      - k8sattributes
      - resourcedetection
      - memory_limiter
      - batch
      receivers:
      - otlp
    metrics/otlp:
      exporters:
      - googlemanagedprometheus
      processors:
      - k8sattributes
      - memory_limiter
      - metricstarttime
      - resourcedetection
      - transform/collision
      - transform/aco-gke
      - batch
      receivers:
      - otlp
    metrics/self-metrics:
      exporters:
      - googlemanagedprometheus
      processors:
      - filter/self-metrics
      - metricstransform/self-metrics
      - k8sattributes
      - memory_limiter
      - resourcedetection
      - batch
      receivers:
      - otlp/self-metrics
    traces:
      exporters:
      - otlphttp
      processors:
      - k8sattributes
      - memory_limiter
      - resource/gcp_project_id
      - resourcedetection
      - batch
      receivers:
      - otlp
  telemetry:
    logs:
      encoding: json
    metrics:
      readers:
      - periodic:
          exporter:
            otlp:
              protocol: grpc
              endpoint: ${env:MY_POD_IP}:14317

Exportadores

A configuração do coletor inclui os seguintes exportadores:

• googlecloud exportador, para registos e rastreios. Este exportador está configurado com um nome de registo predefinido.

• googlemanagedprometheus exportador, para métricas. Este exportador não requer nenhuma configuração, mas existem opções de configuração. Para obter informações sobre as opções de configuração do exportador googlemanagedprometheus, consulte o artigo Introdução ao OpenTelemetry Collector na documentação do Google Cloud Managed Service for Prometheus.

Processadores

A configuração do coletor inclui os seguintes processadores:

• batch: Configurado para processar pedidos de telemetria em lote ao Google Cloud número máximo de entradas por pedido ou ao Google Cloud intervalo mínimo de 5 segundos (conforme o que ocorrer primeiro).

• memory_limiter: Limita a utilização de memória do coletor para evitar falhas de memória insuficiente ao rejeitar pontos de dados quando o limite é excedido.

• resourcedetection: Deteta automaticamente Google Cloud etiquetas de recursos, como project_id e cluster_name.

• k8sattributes: Mapeia automaticamente os atributos dos recursos do Kubernetes para etiquetas de telemetria.

• transform: Muda o nome das etiquetas de métricas que entram em conflito com as etiquetas nos Google Cloud recursos monitorizados.

Recetores

A configuração do coletor inclui apenas o recetor otlp. Para obter informações sobre a instrumentação das suas aplicações para enviar rastreios OTLP e métricas para o ponto final OTLP do coletor, consulte a secção Escolha uma abordagem de instrumentação.

Componentes disponíveis

O coletor OpenTelemetry criado pela Google contém os componentes de que a maioria dos utilizadores vai precisar para ativar uma experiência avançada no Google Cloud Observability. Para ver uma lista completa dos componentes disponíveis, consulte o artigo Componentes no repositório opentelemetry-operations-collector.

Para pedir alterações ou adições aos componentes disponíveis, abra um pedido de funcionalidade. no repositório opentelemetry-operations-collector.

Gere telemetria

Esta secção descreve a implementação de uma aplicação de exemplo e a indicação dessa aplicação para o ponto final OTLP do coletor, bem como a visualização da telemetria noGoogle Cloud. A aplicação de exemplo é um pequeno gerador que exporta rastreios, registos e métricas para o coletor.

Se já tiver uma aplicação instrumentada com um SDK OpenTelemetry, pode direcionar a aplicação para o ponto final do coletor.

Para implementar a aplicação de exemplo, execute o seguinte comando:

kubectl apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/otlp-k8s-ingest/main/sample/app.yaml

Para direcionar as aplicações existentes que usam o SDK OpenTelemetry para o ponto final do coletor, defina a variável de ambiente OTEL_EXPORTER_OTLP_ENDPOINT como http://opentelemetry-collector.opentelemetry.svc.cluster.local:4317.

Após alguns minutos, a telemetria gerada pela aplicação começa a fluir através do coletor para a Google Cloud consola para cada sinal.

Ver telemetria

O coletor OpenTelemetry criado pela Google envia métricas, registos e rastreios das suas aplicações instrumentadas para o Google Cloud Observability. O coletor também envia métricas de auto-observabilidade. As secções seguintes descrevem como ver esta telemetria.

Veja as suas métricas

O coletor OpenTelemetry criado pela Google recolhe métricas do Prometheus que pode ver através do Explorador de métricas. As métricas recolhidas dependem da instrumentação da app, embora o coletor criado pela Google também escreva algumas métricas próprias.

Para ver as métricas recolhidas pelo Google-Built OpenTelemetry Collector, faça o seguinte:

1. Na Google Cloud consola, aceda à página  Explorador de métricas:

   Aceda ao Metrics Explorer

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
3. No elemento Métrica, expanda o menu Selecionar uma métrica, introduza Prometheus Target na barra de filtros e, de seguida, use os submenus para selecionar um tipo de recurso e uma métrica específicos:
   1. No menu Recursos ativos, selecione Alvo do Prometheus.
   2. Para selecionar uma métrica, use os menus Categorias de métricas ativas e Métricas ativas. As métricas recolhidas pelo Google-Built OpenTelemetry Collector têm o prefixo prometheus.googleapis.com.
   3. Clique em Aplicar.

4. Para adicionar filtros que removem séries cronológicas dos resultados da consulta, use o elemento Filter.

5. Configure a forma como os dados são vistos.
   

   Quando as medições de uma métrica são cumulativas, o explorador de métricas normaliza automaticamente os dados medidos pelo período de alinhamento, o que resulta na apresentação de uma taxa no gráfico. Para mais informações, consulte o artigo Tipos, tipos e conversões.

   Quando são medidos valores inteiros ou duplos, como com as métricas counter, o explorador de métricas soma automaticamente todas as séries cronológicas. Para alterar este comportamento, defina o primeiro menu da entrada Agregação como Nenhuma.

   Para mais informações sobre como configurar um gráfico, consulte o artigo Selecione métricas quando usar o explorador de métricas.

Veja os seus rastreios

Para ver os dados de rastreio, faça o seguinte:

1. Na Google Cloud consola, aceda à página Explorador de rastreios:

   Aceda ao Explorador de rastreios

   Também pode encontrar esta página através da barra de pesquisa.

2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião ou o projeto de gestão do App Hub.
3. Na secção da tabela da página, selecione uma linha.

4. No gráfico de Gantt no painel Detalhes do rastreio, selecione um intervalo.

   É aberto um painel que apresenta informações sobre o pedido rastreado. Estes detalhes incluem o método, o código de estado, o número de bytes e o agente do utilizador do autor da chamada.

5. Para ver os registos associados a este rastreio, selecione o separador Registos e eventos.

   O separador mostra registos individuais. Para ver os detalhes da entrada do registo, expanda a entrada do registo. Também pode clicar em Ver registos e ver o registo através do Explorador de registos.

Para mais informações sobre como usar o explorador do Cloud Trace, consulte o artigo Encontre e explore rastreios.

Veja os seus registos

No Explorador de registos, pode inspecionar os seus registos e também ver rastreios associados, quando existirem.

1. 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.

2. Localize uma entrada de registo na sua app instrumentada. Para ver os detalhes, expanda a entrada de registo.

3. Clique em Rastreios numa entrada de registo com uma mensagem de rastreio e, de seguida, selecione Ver detalhes do rastreio.

   É aberto um painel Detalhes do rastreio que apresenta o rastreio selecionado.

Para mais informações sobre a utilização do Explorador de registos, consulte o artigo Veja registos através do Explorador de registos.

Observe e depure o coletor

O Google-Built OpenTelemetry Collector fornece automaticamente métricas de autoobservabilidade para ajudar a monitorizar o respetivo desempenho e garantir o tempo de atividade contínuo do pipeline de carregamento do OTLP.

Para monitorizar o coletor, instale o painel de controlo de exemplo para o coletor. Este painel de controlo oferece estatísticas rápidas sobre várias métricas do coletor, incluindo tempo de atividade, utilização de memória e chamadas API para o Google Cloud Observability.

Para instalar o painel de controlo, faça o seguinte:

1. Na Google Cloud consola, aceda à página  Painéis de controlo:

   Aceda a Painéis de controlo

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

2. Clique em Modelos de painéis de controlo.
3. Pesquise o painel de controlo do OpenTelemetry Collector.
4. Opcional: para pré-visualizar o painel de controlo, selecione-o.

5. Clique em Adicionar painel de controlo à sua lista e, em seguida, conclua a caixa de diálogo.

   A caixa de diálogo permite-lhe selecionar o nome do painel de controlo e adicionar etiquetas ao painel de controlo.

Para mais informações sobre a instalação de painéis de controlo, consulte o artigo Instale um modelo de painel de controlo.