View a markdown version of this page

Configure o OpenAI Codex com um token de portador - Amazon CloudWatch
Pré-requisitosConfigure o exportador de métricasAdicione identidade e atributos organizacionaisVerifique e visualize

Configure o OpenAI Codex com um token de portador

Nesse caminho, o OpenAI Codex envia as métricas do OpenTelemetry (OTel) diretamente para o endpoint de métricas OTLP nativo do Amazon CloudWatch e as autentica com um token de portador (uma chave de API de métricas do CloudWatch). Nenhum coletor do OpenTelemetry é necessário. Essa é a forma mais rápida para um desenvolvedor individual ou uma pequena equipe inserir as métricas do Codex nos painéis do Coding Agent Insights.

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. Organizações que federam identidades por meio de SSO corporativo devem usar a implantação corporativa ao invés disso. Consulte Configure o OpenAI Codex para uma implementação corporativa.

Pré-requisitos

  • OpenAI Codex instalado na máquina do desenvolvedor.

  • Uma forma funcional do Codex chamar um modelo para inferência. Essa configuração de telemetria é independente da inferência, então você pode utilizar uma conta OpenAI (o provedor padrão do Codex) ou o Amazon Bedrock. Para usar o Amazon Bedrock para inferência, veja Amazon Bedrock na documentação do OpenAI Codex.

  • Uma chave de API de métricas do CloudWatch (token de 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

O Codex lê sua configuração em ~/.codex/config.toml. Adicione uma seção [otel.metrics_exporter] que aponte para o endpoint OTLP de métricas do CloudWatch e envie seu token de portador no cabeçalho Authorization. Inclua o caminho /v1/metrics completo; o Codex não o acrescenta para você.

[otel]
environment = "production"

[otel.metrics_exporter]
otlp-http = { endpoint = "https://monitoring.region.amazonaws.com/v1/metrics", protocol = "binary", headers = { "Authorization" = "Bearer YOUR_API_KEY" } }
nota

Algumas versões do Codex não expandem as variáveis de ambiente dentro dos valores do cabeçalho, então a chave de API é mostrada em linha. Trate config.toml como segredo: restrinja suas permissões de arquivo (por exemplo, chmod 600 ~/.codex/config.toml) e não o confirme no controle de origem.

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 recursos OTel através da variável de ambiente OTEL_RESOURCE_ATTRIBUTES no shell que inicia o Codex. 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"
nota

Defini-los como atributos de recursos (em vez de atributos por ponto de dados) corresponde à forma esperada pelos painéis, para que você possa agrupar por @resource.team.id, @resource.department e rótulos semelhantes. O Codex marca dimensões de nível métrico de maneira automática, como model e token_type, nas métricas.

Verifique e visualize

Execute o Codex por alguns turnos para gerar métricas e, em seguida, confirme se os dados chegaram ao CloudWatch.

Para verificar métricas

  1. Execute uma sessão do Codex que realize algum trabalho (por exemplo, peça que ele execute um comando e edite um arquivo).

  2. No console do CloudWatch, escolha GenAI Observability, Coding Agent Insights e, em seguida, a guia Codex. 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.

Para obter a orientação completa e continuamente atualizada, veja a orientação do Codex no Amazon Bedrock no GitHub.