OpenTelemetry (OTel) é uma estrutura de observabilidade código aberto. Ele fornece uma maneira padrão de coletar eventos e métricas de telemetria e exportá-los para ferramentas de observabilidade compatíveis. Para obter mais informações, consulte o que é OpenTelemetry? no site da OTel.
Ao habilitar o monitoramento OTel, você pode enviar dados dos clientes Copilot dos usuários para um backend compatível com OTel. Isso permite que você analise as sessões do agente e entenda o uso do agente em sua empresa.
Que dados Copilot envia?
Copilot envia três tipos de dados:
- Os rastreamentos mostram o fluxo de uma sessão de agente e conectam cada etapa, incluindo chamadas de modelo e uso de ferramentas. Por exemplo, um rastreamento pode mostrar um agente chamando um modelo, usando a
readFileferramenta e chamando o modelo novamente para produzir uma resposta. - As métricas são medidas numéricas que ajudam a identificar padrões ao longo do tempo. Por exemplo, as métricas de uso de token acompanham o número de tokens de entrada e saída usados em chamadas de modelo.
- Os eventos registram ações individuais em um ponto específico no tempo. Por exemplo, um evento de feedback de edição registra se um usuário aceitou ou rejeitou uma edição feita por um agente.
Por padrão, os dados não incluem atributos diretamente identificáveis, prompts, respostas, argumentos de ferramenta, resultados da ferramenta ou detalhes brutos da política. Os administradores corporativos podem habilitar de forma independente as seguintes classes de captura por meio de configurações gerenciadas:
- A identidade adiciona o nome da conta autenticada Copilot , a conta do sistema operacional local e o nome do computador. Isso permite que você atribua atividade sem coletar conteúdo da conversa ou de ferramentas.
- Os prompts incluem o conteúdo do prompt do usuário, do sistema e do desenvolvedor e a entrada do modelo associado.
- As respostas incluem resposta do assistente e conteúdo de raciocínio com suporte.
- Os argumentos da ferramenta incluem argumentos brutos, comandos, esquemas de ferramentas e identificadores para ferramentas, servidores MCP, plug-ins e ganchos.
- Saída da ferramenta inclui os resultados da ferramenta e os detalhes do erro de execução.
- Os detalhes da política incluem informações de política irrestritas, como caminhos brutos do sistema de arquivos de área restrita. A postura limitada da política e os resultados permanecem disponíveis quando essa classe é desabilitada.
Há suporte para controles refinados de captura em Copilot CLI, nas sessões GitHub Copilot app e VS Code usando o Host do Agente. O harness do agente local de VS Code dá suporte à captura de identidade e à configuração herdada de captura de conteúdo tudo ou nada, mas não aplica independentemente as cinco classes de captura de conteúdo.
O conteúdo capturado pode conter informações confidenciais, incluindo código-fonte, conteúdo do arquivo, prompts do usuário, comandos, resultados da ferramenta e caminhos do workspace ou do perfil do usuário. Habilite apenas as classes necessárias para o caso de uso.
Habilitando o OpenTelemetry
Para coletar dados do OTel dos clientes dos usuários Copilot:
- Configure um back-end de observabilidade. Escolha um back-end seguro que dê suporte ao Protocolo OpenTelemetry (OTLP). Alguns back-ends podem receber dados OTLP diretamente. Para outros back-ends, implante um Coletor OpenTelemetry para receber, processar e encaminhar os dados. Para ver exemplos, consulte Usar com backends de observabilidade na documentação de VS Code.
- Configure os clientes dos usuários. Defina valores de configuração para habilitar o OTel em cada cliente e configure-o para enviar dados para o ponto de extremidade OTLP configurando o ponto de extremidade, os cabeçalhos e o token de autenticação.
- Interpretar dados. Use os dados coletados para analisar sessões e identificar tendências. Para ver um exemplo de implementação, consulte Monitor AI coding agents with Grafana na documentação da Microsoft.
Configurando os clientes dos usuários
As empresas podem aplicar a configuração do OTel em todos os clientes compatíveis usando configurações gerenciadas. Valores gerenciados explícitos têm precedência sobre configurações locais, configuração do SDK e variáveis de ambiente. A propriedade telemetry inclui chaves para habilitar e rotear o OpenTelemetry e controlar independentemente a identidade e a captura de conteúdo confidencial.
Para obter mais informações, consulte Introdução às configurações gerenciadas pela empresa e Configurações gerenciadas pela empresa.
Documentação do cliente
Para obter mais detalhes de como o OpenTelemetry é usado entre clientes, consulte: