Este é o Guia do desenvolvedor do AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Configurar a telemetria do AWS CDK CLI
O que é a telemetria da CLI do CDK?
Importante
AWS A telemetria do CDK CLI é coletada somente nas versões 2.1100.0 e superiores do AWS CDK CLI.
O AWS Cloud Development Kit (AWS CDK) coleta dados de telemetria sobre o uso da CLI para fornecer padrões de uso agregados e frequências de erro que nos ajudarão a identificar problemas generalizados que afetam a base de usuários da CLI do CDK.
Por padrão, os clientes optam pela coleta de dados de telemetria da CLI. Você pode desativar a telemetria do CDK CLI usando os métodos listados abaixo.
AWS O CDK coleta dados de telemetria pensando na minimização estrita de dados, impedindo a identificação ou atribuição a usuários, contas ou organizações específicos. Uma lista exaustiva das métricas que são coletadas por padrão, com os motivos, é fornecida abaixo. Nenhuma telemetria ou métrica adicional é coletada.
Esteja ciente de que atualmente não estamos coletando mensagens de erro, rastreamento de pilha e registros, e que essa coleta de dados estará disponível em uma versão futura do CDK CLI sob aceitação explícita. Mais informações sobre essas métricas podem ser encontradas na tabela.
Os dados coletados são os seguintes:
| Métrica | Description | Motivo | Exemplo |
|---|---|---|---|
|
Versão CDK CLI |
Versão CLI (x.y.z) |
Coletar isso nos ajudará a dividir nossos dados por versão, o que pode nos ajudar a identificar versões problemáticas. |
"2.1100.0" |
|
ID de instalação |
UUID aleatório armazenado em máquinas locais que executam comandos CLI |
Isso nos ajuda a estimar o número distinto de usuários afetados por um erro. Cada máquina exclusiva terá seu próprio ID de instalação, gerado aleatoriamente por meio do UUID V4. |
"881d3281-2811-4c86-b7b6-4a8a621cf6f2" |
|
ID da sessão |
UUID aleatório gerado em cada invocação de comando CLI |
Isso nos ajuda a identificar todos os eventos originados do mesmo comando. |
"c47e3d55-bc20-406b-a02a-e0285dd63230" |
|
ID do evento |
O ID da sessão mais um contador |
Isso cria um identificador exclusivo para cada evento em uma sessão. |
"c47e3d55-bc20-406b-a02a-e0285dd63230:0" |
|
Região |
Região da AWS |
Isso nos ajudará a dividir nossos dados para problemas específicos da região. |
"us-east-1" |
|
Registro de data e hora |
A hora (gerada pelo cliente) em que os dados são enviados ao nosso terminal de telemetria |
Isso nos ajudará a gerar gráficos de séries temporais. |
"2025-12-12T00:00:00.000Z" |
|
Estado do evento |
O “resultado” do evento. Os valores possíveis são 'SUCESSO', 'FALHA', 'ABORTADO' |
Isso nos ajudará a rastrear as taxas de erro em cada comando da CLI e nos alertará sobre possíveis regressões antes que elas sejam relatadas pelos clientes. |
"SUCCESS" |
|
Tipo de evento |
Um identificador para o tipo de evento que produz os dados |
Essa é uma enumeração que identifica o tipo de evento que ocorreu, pois pode haver vários eventos na execução de um comando. |
"SYNTH" |
|
Caminho de comando |
O comando e as propriedades inseridos na CLI, com qualquer texto livre editado |
Junto com os parâmetros de comando, essas informações ajudam a determinar o comportamento do evento ocorrido, o que nos ajuda a identificar o raio da explosão e a causa dos problemas que surgem. |
["cdk", "deploy", "$STACK1"] |
|
Parâmetros de comando |
Os parâmetros opcionais inseridos na CLI, com qualquer texto livre editado |
Junto com o caminho do comando, essas informações ajudam a determinar o comportamento do evento ocorrido, o que nos ajuda a identificar o raio da explosão e a causa dos problemas que surgem. |
{
all: true,
concurrency: 4
}
|
|
Configuração |
Parâmetros adicionais que podem afetar o comando CLI (ou seja, cdk.context.json ou valores de contexto em |
Isso nos ajudará a facilitar a depuração, fornecendo uma visão abrangente de todos os parâmetros possíveis que podem afetar o comportamento da CLI. |
{ context: { "@aws-cdk/core:explicitStackTags": true } } |
|
Sistema operacional |
O sistema operacional que está sendo usado |
Isso nos ajudará a depurar problemas que afetam apenas sistemas operacionais específicos. |
{
platform: "linux",
release: "5.15.0-1019-aws",
}
|
|
CI/CD |
Se o comando CLI está ou não sendo invocado de um ambiente CI/CD |
Isso nos ajudará a identificar problemas específicos dos CI/CD ambientes. |
false |
|
Versão do Node |
A versão do nó usada no ambiente |
Isso nos ajudará a depurar quaisquer problemas específicos do nó que surgirem. |
"v22.0.0" |
|
Duração |
A duração do evento em milissegundos |
Isso nos ajuda a observar padrões na duração de eventos específicos. |
{ total: 300 }
|
|
Contadores |
Várias métricas de contador derivadas do seu aplicativo CDK e da execução da CLI |
Monitoraremos como estatísticas de contagem, como (mas não limitadas a) contagem de recursos do CFN, afetam a duração da implantação. |
{
resourceCount: 25,
errorCount: 0,
warningCount: 2,
}
|
|
Dependências |
Dependências relevantes da AWS e suas versões |
Planejamos rastrear dependências da AWS que possam afetar o resultado da CLI, aws-cdk-lib como jsii, projen etc. Só coletaremos dependências em bibliotecas específicas de propriedade da AWS. |
[{ "aws-cdk-lib": "2.232.0"}]
|
|
Nomes de erro |
O nome do erro, se ocorrer um erro. |
Registramos somente os nomes de erros que controlamos, o que ajuda a identificar tipos de erros recorrentes. |
"ToolkitError" |
|
As métricas a seguir exigem aceitação explícita e NÃO são coletadas atualmente: |
|||
|
Mensagens de erro |
A mensagem de erro retornada, se ocorrer um erro. Texto de formato livre redigido |
[Requer aceitação] A captura da mensagem de erro nos ajudará a agregar dados sobre quais erros são encontrados em uma taxa maior, além de nos ajudar a depurar o que deu errado em casos de uso individuais. |
Não coletado atualmente |
|
Erro: Stack Trace |
O rastreamento de pilha da mensagem de erro, se ocorrer um erro. Texto de formato livre redigido |
[Requer aceitação] O rastreamento de pilha será útil para fins individuais de depuração e é necessário para que possamos reproduzir os problemas que possam surgir. |
Não coletado atualmente |
|
Logs de erros |
Os registros de um comando CLI com falha, se ocorrer um erro. Texto de formato livre redigido |
[Requer aceitação] Os registros de erros também nos ajudarão a depurar e reproduzir problemas que vemos na CLI. |
Não coletado atualmente |
Como cancelar a telemetria da CLI do CDK
Para visualizar o status atual da telemetria com base nos valores do contexto e nas variáveis do ambiente, execute o comando a seguir:
cdk cli-telemetry --status
Cancelamento usando valores de contexto
Se houver conflitos nos valores de contexto de várias fontes, o CDK usará a ordem de precedência a seguir.
-
Valores de contexto especificados usando um comando da CLI do CDK com a opção
--context -
Valores de contexto em cdk.json
-
Valores de contexto em cdk.context.json
-
Valores de contexto em ~/cdk.json
Para cancelar usando um comando da CLI do CDK
Execute o comando da CLI do CDK a seguir para desabilitar a telemetria:
cdk cli-telemetry --disable
A execução desse comando registra a ação em seu arquivo cdk.context.json local e se aplica somente à aplicação do CDK atual.
Para cancelar usando o arquivo de configuração da aplicação
Defina cli-telemetry: false no arquivo cdk.json da aplicação Isso desabilita a telemetria da aplicação.
Para cancelar usando o arquivo de configuração global
Defina cli-telemetry: false no arquivo ~/.cdk.json para desabilitar a telemetria para todas as aplicações do CDK no mesmo computador. É necessário especificar essa configuração dentro de um elemento de contexto da forma a seguir:
{ "context": { "cli-telemetry": false } }
Cancelamento usando uma variável de ambiente
Defina a variável de ambiente CDK_DISABLE_CLI_TELEMETRY como true para desativar a telemetria da CLI nesse ambiente.
CDK_DISABLE_CLI_TELEMETRY=true
O valor dessa variável de ambiente tem precedência sobre quaisquer valores de contexto que tenham sido definidos.
dica
Adicione essa variável de ambiente ao arquivo de startup do shell, como .bashrc, para desativar a telemetria toda vez que você abrir uma janela de terminal.
Opte por não usar a filtragem de DNS
O endpoint de telemetria é. cdk-cli-telemetry.us-east-1.api.aws/metrics Bloquear esse nome de domínio no firewall desativa a telemetria da CLI e não afeta a funcionalidade da CLI da CDK.
Cancelamento do uso de todos os relatórios de dados de uso
Para desativar todos os relatórios de dados de uso de um único comando, use a opção global --no-version-reporting da CLI. Essa opção desativa a coleta de dados de uso da aplicação e a telemetria da CLI do CDK.
Se você estiver cancelando a coleta de dados de uso da aplicação usando a opção --no-version-reporting, você automaticamente cancelará a telemetria da CLI do CDK para a execução desse comando específico, independentemente dos valores de contexto.
nota
Se você definir analyticsReporting no nível da pilha, isso terá precedência sobre a opção --no-version-reporting somente para a coleta de dados de uso da aplicação.
Envio de dados de telemetria para um arquivo local
Se você optar por continuar aceitando a telemetria da CLI do CDK, será possível decidir enviar seus dados de telemetria para um arquivo local. Em seguida, será possível revisar o arquivo para auditar os dados de telemetria que estivermos coletando.
Use a opção a seguir em qualquer comando da CLI do CDK para enviar dados de telemetria para um arquivo local:
nota
Se você estiver usando uma versão da CLI do AWS CDK abaixo de 2.1100.0, deverá especificar junto com. --unstable=telemetry --telemetry-file
--telemetry-file='path/to/local/file'
Como exemplo, esse deploy comando envia dados de telemetria para um arquivo local:
cdk deploy --telemetry-file='path/to/local/file'
