Administradores Enterprise precisam monitorar como as equipes usam o GitHub Copilot para gerenciar custos, garantir conformidade e medir o retorno sobre o investimento. Sem uma auditoria adequada, é impossível saber quais usuários estão ativos, quais recursos eles utilizam ou se o Copilot está sendo usado em bases de código aprovadas. O GitHub oferece ferramentas de relatórios integradas nas configurações da conta Enterprise e a API do GitHub para obter dados detalhados de uso. Este artigo explica como acessar o painel de uso do Copilot, exportar logs de atividade e filtrar por organização ou equipe.
Principais Pontos: Como Auditar o Uso do GitHub Copilot
- Enterprise account > Settings > Copilot > Usage: Mostra usuários ativos, sugestões aceitas e linhas de código por organização.
- Endpoint da API do GitHub GET /enterprises/{enterprise}/copilot/usage: Retorna dados brutos de uso para scripts e dashboards personalizados.
- Relatório de atribuição de assentos do Copilot nas Configurações da Organização: Lista usuários atribuídos, data da última atividade e status do assento para gerenciamento de licenças.
Dados de Auditoria do GitHub Copilot Disponíveis em Contas Enterprise
Os dados de uso do GitHub Copilot são armazenados no nível Enterprise quando o Copilot está habilitado para toda a empresa. Os dados incluem o número de usuários ativos por dia, total de sugestões exibidas, sugestões aceitas e linhas de código aceitas. Essas informações são agregadas por organização e por usuário. Os dados de auditoria são retidos por 90 dias para o Copilot Business e 365 dias para o Copilot Enterprise. Você pode acessar esses dados pela interface web do GitHub ou pela API REST. Os pré-requisitos incluem permissões de proprietário Enterprise ou uma função com a permissão “visualizar uso do Copilot”. Se você usa o Copilot Enterprise, também pode recuperar dados de contexto de conclusão de código para ver quais arquivos e repositórios o Copilot referencia.
Passos para Visualizar o Painel de Uso do Copilot na Conta Enterprise
O painel de uso fornece uma visão geral de alto nível da atividade do Copilot em todas as organizações da sua empresa. Use este método para verificações rápidas e relatórios mensais.
- Faça login no GitHub e navegue até sua conta Enterprise
Abra github.com e clique na sua foto de perfil no canto superior direito. Selecione “Suas empresas” no menu suspenso. Clique no nome da conta Enterprise que deseja auditar. - Abra a página de configurações do Copilot
Na barra lateral esquerda, clique em “Settings”. Em seguida, na seção “Policies”, clique em “Copilot”. Isso abre a página de configuração do Copilot para a empresa. - Clique na guia Usage
Na página do Copilot, você verá duas guias: “Policies” e “Usage”. Clique em “Usage”. A página exibe um seletor de intervalo de datas, uma divisão por organização e um cartão de resumo mostrando o total de usuários ativos, sugestões aceitas e taxa de aceitação para o período selecionado. - Selecione um intervalo de datas e filtre por organização
Use o seletor de intervalo de datas para escolher os últimos 7 dias, 30 dias ou um intervalo personalizado. Abaixo do cartão de resumo, uma tabela lista cada organização com seus próprios usuários ativos, sugestões aceitas e linhas de código aceitas. Clique no nome de uma organização para detalhar os dados por usuário. - Exporte os dados
Clique no botão “Export CSV” no canto superior direito da tabela de uso. O arquivo contém linhas para cada organização e data. Abra o CSV no Excel ou no Google Sheets para análise adicional.
Passos para Recuperar Dados de Uso do Copilot pela API do GitHub
Use a API para automatizar auditorias, criar dashboards personalizados ou integrar com ferramentas SIEM. A API retorna dados JSON que incluem métricas por usuário e por organização.
- Gere um token de acesso pessoal com o escopo correto
Vá para GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens. Crie um token com “Read access to Copilot usage data” para a empresa. Alternativamente, use um token com o escopocopilotpara a API REST v3. - Envie uma requisição GET para o endpoint de uso da empresa
Use o seguinte endpoint:GET https://api.github.com/enterprises/{enterprise}/copilot/usage. Substitua{enterprise}pelo slug da sua empresa. Adicione os parâmetros de consultasinceeuntilno formato ISO 8601 (por exemplo,?since=2024-01-01&until=2024-01-31). - Analise a resposta
A resposta contém um array de objetos. Cada objeto incluiday,total_suggestions_count,total_acceptances_count,total_lines_acceptedebreakdown, que lista métricas por organização e por usuário. Salve a saída JSON em um arquivo ou direcione para um script. - Filtre por organização usando o endpoint de nível de organização
Para obter dados de uma única organização, use:GET https://api.github.com/orgs/{org}/copilot/usage. Isso é útil quando você precisa apenas de dados de uma equipe ou unidade de negócios. - Agende a chamada da API com um cron job ou GitHub Actions
Crie um workflow do GitHub Actions que seja executado semanalmente e chame a API. Armazene o token como um segredo do repositório. Anexe os resultados a um arquivo de log ou envie para um serviço de monitoramento.
Se o Painel de Uso Mostrar Dados Incompletos
Dados incompletos geralmente decorrem de permissões incorretas ou de uma assinatura do Copilot mal configurada. Verifique os seguintes pontos antes de escalar.
Copilot Business ou Enterprise não está habilitado para toda a empresa
Se o Copilot estiver habilitado apenas para organizações específicas, o painel de nível Enterprise mostrará dados apenas dessas organizações. Vá para a guia Policies e certifique-se de que “Allow Copilot” esteja definido como “Enabled” para a empresa. Em seguida, confirme que cada organização tem pelo menos um assento atribuído.
Token não tem acesso de leitura no nível Enterprise
Os tokens de acesso pessoal devem ter o escopo read:enterprise e o escopo copilot. Se você usar um token de granularidade fina, deve selecionar “All repositories” ou listar explicitamente a empresa. Regere o token se a API retornar um erro 403 ou 404.
Janela de retenção de dados expirou
O Copilot Business retém dados de uso por 90 dias. O Copilot Enterprise retém dados por 365 dias. Se você precisar de dados mais antigos que o período de retenção, eles não estão mais disponíveis pela interface ou API. Para preservar dados históricos, exporte relatórios CSV mensalmente e armazene-os em um local seguro.
Copilot Business vs Copilot Enterprise: Capacidades de Auditoria Comparadas
| Item | Copilot Business | Copilot Enterprise |
|---|---|---|
| Período de retenção de dados | 90 dias | 365 dias |
| Log de atividade por usuário | Sim, via API e interface | Sim, via API e interface |
| Contexto de conclusão de código | Não disponível | Disponível na resposta da API |
| Detalhamento por organização | Sim | Sim |
| Exportação CSV pela interface | Sim | Sim |
Problemas Comuns ao Auditar o Uso do Copilot
Mesmo com a configuração correta, você pode encontrar problemas específicos. Cada problema abaixo tem uma correção direta.
A guia Copilot Usage está ausente nas configurações da empresa
Isso ocorre quando sua conta não tem permissões de proprietário Enterprise. Peça ao proprietário da empresa para conceder a você a função “View Copilot usage”. Alternativamente, solicite acesso de leitura à empresa através da página Members > Roles.
A API retorna um erro 404 para o endpoint de uso
O slug da empresa diferencia maiúsculas de minúsculas. Verifique o slug observando a URL quando você estiver no painel da empresa. O slug é a parte após https://github.com/enterprises/. Confirme também que o token tem o escopo copilot e não expirou.
A exportação CSV mostra zero usuários ativos
Zero usuários ativos geralmente significa que o intervalo de datas não inclui dias úteis ou que as sugestões do Copilot estão bloqueadas por uma política. Verifique a guia Policies para garantir que “Suggestions matching public code” não esteja definido como “Blocked” para todos os usuários. Verifique também se os usuários realmente abriram arquivos e digitaram código durante o período selecionado.
Conclusão
Agora você pode auditar o uso do GitHub Copilot em sua conta Enterprise usando o painel integrado e a API REST. Comece revisando a guia Usage em Settings > Copilot para obter uma visão geral rápida dos usuários ativos e taxas de aceitação. Para auditorias recorrentes, agende chamadas de API com um workflow do GitHub Actions e exporte relatórios CSV mensalmente para preservar dados além da janela de retenção. Se precisar de insights mais profundos sobre quais repositórios o Copilot referencia, considere atualizar para o Copilot Enterprise para acessar dados de contexto de conclusão de código.