View a markdown version of this page

Configure o OpenTelemetry para o GitHub Copilot - Amazon CloudWatch
Pré-requisitosConfigure o exportador de métricasAdicione identidade e atributos organizacionaisVerifique e visualize

Configure o OpenTelemetry para o GitHub Copilot

O GitHub Copilot emite métricas do OpenTelemetry (OTel) sobre uso de tokens, solicitações, chamadas de ferramentas e latência. Quando você envia essas métricas para o Amazon CloudWatch, elas preenchem a guia GitHub Copilot dos painéis do Coding Agent Insights. Para saber mais sobre o painel, consulte Coding Agent Insights.

O Copilot envia métricas OTLP diretamente para o endpoint de métricas OTLP nativo do CloudWatch e autentica com um token de portador (uma chave de API de métricas do CloudWatch). Nenhum coletor do OpenTelemetry é necessário. O token de portador é o caminho suportado pelo Copilot atualmente.

nota

Este guia aborda somente como emitir as métricas OTel do Copilot para o CloudWatch, o que é independente de como o Copilot chama um modelo para inferência. O Copilot utiliza seus próprios modelos por padrão, mas as empresas podem trazer suas próprias chaves de provedor de modelos, incluindo o Amazon Bedrock. Para obter mais informações, consulte Use suas próprias chaves de API na documentação do GitHub Copilot.

Importante

Os tokens do portador são credenciais de longo prazo. Nós os recomendamos somente quando credenciais de curto prazo da AWS não são viáveis, como laptops de desenvolvedores fora da AWS. Para obter as compensações de segurança e a orientação sobre rotação de chaves, veja Configurar autenticação do token do portador para Metrics.

Pré-requisitos

  • GitHub Copilot instalado em uma versão compatível com a exportação de métricas do OpenTelemetry.

  • Uma assinatura ativa do GitHub Copilot para inferência do modelo. O Copilot usa seus próprios modelos por padrão; para usar o Amazon Bedrock em vez disso, configure uma chave de modelo personalizada conforme descrito em Utilize suas próprias chaves de API na documentação do GitHub Copilot.

  • Uma chave de API de métricas do CloudWatch (token portador), criada através de um usuário do IAM que tem permissões de métricas do CloudWatch. Para o procedimento que cria o usuário do IAM e gera a chave, veja Configurar autenticação do token do portador para Metrics.

Configure o exportador de métricas

Configure o exportador OpenTelemetry do Copilot para enviar métricas para o endpoint de métricas do CloudWatch com seu token portador no cabeçalho Authorization. Configure as seguintes variáveis de ambiente no ambiente em que o Copilot é iniciado. Defina COPILOT_OTEL_ENABLED=true para ativar o OpenTelemetry. O Copilot utiliza as variáveis padrão do OpenTelemetry para todos os sinais; ele não oferece suporte a substituições específicas de métricas. Defina OTEL_EXPORTER_OTLP_ENDPOINT como o endpoint base sem o caminho /v1/metrics — o exportador anexa o caminho do sinal para você.

export COPILOT_OTEL_ENABLED=true
export OTEL_EXPORTER_OTLP_ENDPOINT="https://monitoring.region.amazonaws.com"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer YOUR_API_KEY"
nota

Trate o token de portador como um segredo. Evite confirmá-lo no controle de origem ou em perfis de shell compartilhados e troque a chave periodicamente conforme descrito em Configurar autenticação do token do portador para Metrics.

Adicione identidade e atributos organizacionais

Os painéis do Coding Agent Insights agrupam o uso por desenvolvedor, equipe, departamento e outras dimensões organizacionais. Forneça-os como atributos de recurso do OTel através da variável de ambiente OTEL_RESOURCE_ATTRIBUTES. Configure os valores com base na identidade do seu desenvolvedor e na estrutura da sua organização.

export OTEL_RESOURCE_ATTRIBUTES="\
user.id=alias,\
user.email=developer@example.com,\
user.name=Jane Doe,\
department=engineering,\
team.id=platform,\
cost_center=cc-1234,\
organization=example-corp,\
location=us-seattle,\
role=software-engineer,\
manager=manager@example.com"

Verifique e visualize

Utilize o Copilot para gerar métricas e, em seguida, confirme se os dados chegaram ao CloudWatch.

Para verificar métricas

  1. Utilize o Copilot para realizar algum trabalho que gere telemetria.

  2. No console do CloudWatch, escolha GenAI Observability, Coding Agent Insights e, em seguida, a guia GitHub Copilot. Normalmente, as métricas aparecem em alguns minutos.

  3. Como opção, consulte as métricas diretamente com o PromQL. Para obter mais informações, consulte Consultas do PromQL.