Como uso o CloudTrail para registrar em log eventos do Amazon Q Developer fornecidos pelo meu IDE ou CLI?

Breve descrição

Os eventos fornecidos pelo IDE ou pela CLI são eventos de dados do CloudTrail. Por padrão, o CloudTrail não registra em log eventos de dados, então não é possível ver os eventos no histórico de eventos do CloudTrail. Para registrar em log eventos do Amazon Q Developer que seu IDE ou CLI fornece no CloudTrail, crie uma trilha personalizada que registra eventos de dados em log.

Observação: você deve ter uma assinatura do Amazon Q Developer Pro para usar a seguinte resolução. Não é possível usar o nível gratuito para registrar eventos em log no CloudTrail porque você se autentica com o ID do builder AWS e não com uma conta da AWS.

Resolução

Para criar uma trilha de eventos de dados do Amazon Q Developer, conclua as seguintes etapas:

1. Abra o console do CloudTrail.
2. No painel de navegação, selecione Trilhas.
3. Escolha Criar trilha.
4. Insira os seguintes atributos da trilha:
   Nome da trilha
   Bucket do Amazon Simple Storage Service (Amazon S3) para armazenar os logs
   (Opcional) Chave do AWS Key Management Service (AWS KMS) gerenciada pelo cliente
   Observação: para criar uma trilha para todas as contas do AWS Organizations, ative a trilha organizacional. Você deve fazer login na conta de gerenciamento ou de administrador delegado como um usuário ou função que tenha as permissões corretas.
5. Escolha Avançar.
6. Na página Escolher eventos de logs, escolha Eventos de dados.
7. Selecione CodeWhisperer.
8. Escolha Criar trilha.

É possível ver a nova trilha na página Trilhas do console do CloudTrail. Após 5 minutos, o CloudTrail publica arquivos de logs que mostram as chamadas de API da AWS da sua conta. É possível visualizar os arquivos de logs no bucket do S3 especificado.

Também é possível configurar o CloudTrail para enviar arquivos de logs para o Amazon CloudWatch Logs.

Os eventos que seu IDE fornece incluem detalhes sobre userIdentity e userAgent.

Exemplo de evento do IDE:

"userIdentity": {
            "type": "IdentityCenterUser",
            "accountId": "111122223333",
            "onBehalfOf": {
                "userId": "123456789-123456789-123456789-123456789-123456789",
                "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/d-123456789"
            }
        },
"userAgent": "aws-sdk-js/0.0.1 ua/2.0 os/win32# lang/js md/nodejs#18.15.0 api/codewhispererstreaming#0.0.1 AmazonQ-For-VSCode/1.23.0",

Os eventos fornecidos pela CLI incluem detalhes sobre userAgent e userContext.

Exemplo de evento da CLI:

"userAgent": "aws-sdk-rust/1.3.3 api/codewhispererruntime/0.1.1100 os/macos lang/rust/1.80.1 app/AmazonQ-For-CLI",
"userContext": {
    "ideCategory": "CLI",
    "operatingSystem": "MAC",
    "product": "CodeWhisperer",
    "ideVersion": "1.3.0"
}

Observação: os detalhes do prompt em linha ou do bate-papo estão ocultos no CloudTrail. Para capturar detalhes do prompt, use o console do Amazon Q Developer para ativar o atributo de registro de prompts em log.

Informações relacionadas

Como criar um painel de atividades do usuário no Amazon CodeWhisperer

Como consultar eventos de telemetria no Amazon Q Developer

Como habilitar relatórios de atividades do usuário no Amazon Q Developer