Esta es la guía para desarrolladores de AWS CDK v2. La primera versión del CDK pasó a la etapa de mantenimiento el 1.° de junio de 2022 y no cuenta con soporte desde el 1.° de junio de 2023.
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Configurar la telemetría CLI de AWS CDK
¿Qué es la telemetría de la CLI de CDK?
importante
AWS La telemetría de CDK CLI solo se recopila en las versiones 2.1100.0 y posteriores de CDK AWS CLI.
El AWS Cloud Development Kit (AWS CDK) recopila datos de telemetría sobre el uso de la CLI para proporcionar patrones de uso agregados y frecuencias de error que nos ayudarán a identificar los problemas generalizados que afectan a la base de usuarios de la CLI de CDK.
Los clientes optan por la recopilación de datos de telemetría CLI de forma predeterminada. Puede excluirse de la telemetría CLI de CDK mediante los métodos que se indican a continuación.
AWS CDK recopila los datos de telemetría teniendo en cuenta una estricta minimización de los datos, lo que impide su identificación o atribución a usuarios, cuentas u organizaciones específicos. A continuación, se proporciona una lista exhaustiva de las métricas que se recopilan de forma predeterminada y las razones por las que se recopilan. No se recopilan más datos telemétricos ni métricas.
Tenga en cuenta que actualmente no recopilamos mensajes de error, rastreos de pila ni registros, y que esta recopilación de datos estará disponible en una versión futura de CDK CLI con una suscripción explícita. Puede encontrar más información sobre estas métricas en la tabla.
Los datos que se recopilan son los siguientes:
| Métrica | Description (Descripción) | Motivo | Ejemplo |
|---|---|---|---|
|
Versión CDK CLI |
Versión CLI (x.y.z) |
Recopilar esto nos ayudará a dividir los datos por versión, lo que puede ayudarnos a identificar las versiones problemáticas. |
"2.1100.0" |
|
ID de instalación |
UUID aleatorio almacenado en máquinas locales que ejecutan comandos CLI |
Esto nos ayuda a estimar el número concreto de usuarios afectados por un error. Cada máquina única tendrá su propio identificador de instalación que se generará aleatoriamente mediante el UUID V4. |
"881d3281-2811-4c86-b7b6-4a8a621cf6f2" |
|
ID de sesión |
UUID aleatorio generado en cada invocación de comando CLI |
Esto nos ayuda a identificar todos los eventos que se originan en el mismo comando. |
"c47e3d55-bc20-406b-a02a-e0285dd63230" |
|
ID de evento |
El ID de sesión más un contador |
Esto crea un identificador único para cada evento de una sesión. |
"c47e3d55-bc20-406b-a02a-e0285dd63230:0" |
|
Region |
Región de AWS |
Esto nos ayudará a dividir nuestros datos en busca de problemas específicos de la región. |
"us-east-1" |
|
Timestamp |
La hora (generada por el cliente) en que los datos se envían a nuestro punto final de telemetría |
Esto nos ayudará a generar gráficos de series temporales. |
"2025-12-12T00:00:00.000Z" |
|
Estado del evento |
El «resultado» del evento. Los valores posibles son «ÉXITO», «FRACASO», «ABORTADO» |
Esto nos ayudará a realizar un seguimiento de las tasas de error en cada comando de la CLI y nos alertará sobre posibles regresiones antes de que los clientes las notifiquen. |
"SUCCESS" |
|
Tipo de evento |
Un identificador del tipo de evento que produce los datos |
Se trata de una enumeración que identifica el tipo de evento que se produjo, ya que puede haber varios eventos en la ejecución de un comando. |
"SYNTH" |
|
Ruta de comandos |
El comando y las propiedades ingresados en la CLI, con cualquier texto libre redactado |
Junto con los parámetros de los comandos, esta información ayuda a determinar el comportamiento del evento que se ha producido, lo que nos ayuda a identificar el radio de la explosión y la causa de los problemas que se produzcan. |
["cdk", "deploy", "$STACK1"] |
|
Parámetros de comando |
Los parámetros opcionales ingresados en la CLI, con cualquier texto libre redactado |
Junto con la ruta de comandos, esta información ayuda a determinar el comportamiento del evento que se ha producido, lo que nos ayuda a identificar el radio de la explosión y la causa de los problemas que se producen. |
{
all: true,
concurrency: 4
}
|
|
Configuración |
Parámetros adicionales que pueden afectar al comando CLI (es decir, cdk.context.json o valores de contexto en |
Esto nos ayudará a facilitar la depuración al proporcionar una visión completa de todos los parámetros posibles que pueden afectar al comportamiento de la CLI. |
{ context: { "@aws-cdk/core:explicitStackTags": true } } |
|
Sistema operativo |
El sistema operativo que se está utilizando |
Esto nos ayudará a depurar problemas que solo afectan a sistemas operativos específicos. |
{
platform: "linux",
release: "5.15.0-1019-aws",
}
|
|
CI/CD |
Si el comando CLI se invoca o no desde un CI/CD entorno |
Esto nos ayudará a identificar los problemas específicos de los CI/CD entornos. |
false |
|
Versión de nodo |
La versión del nodo utilizada en el entorno |
Esto nos ayudará a depurar cualquier problema específico de los nodos que surja. |
"v22.0.0" |
|
Duración |
La duración del evento en milisegundos |
Esto nos ayuda a detectar patrones en la duración de eventos específicos. |
{ total: 300 }
|
|
Contadores |
Diversas métricas de contador derivadas de la aplicación CDK y la ejecución de CLI |
Supervisaremos cómo las estadísticas de conteo, como (entre otras) el recuento de recursos de CFN, afectan a la duración de la implementación. |
{
resourceCount: 25,
errorCount: 0,
warningCount: 2,
}
|
|
Dependencias |
Dependencias relevantes de AWS y sus versiones |
Planeamos realizar un seguimiento de las dependencias de AWS que puedan afectar al resultado de la CLI aws-cdk-lib, como jsii, projen, etc. Solo recopilaremos las dependencias de bibliotecas específicas propiedad de AWS. |
[{ "aws-cdk-lib": "2.232.0"}]
|
|
Nombres de error |
El nombre del error, si se produce un error. |
Solo registramos los nombres de los errores que controlamos, lo que ayuda a identificar los tipos de errores que se repiten. |
"ToolkitError" |
|
Las siguientes métricas requieren una suscripción explícita y NO se recopilan actualmente: |
|||
|
Mensajes de error |
Si se produce un error, se devuelve el mensaje de error. Texto en formato libre redactado |
[Requiere una suscripción opcional] Capturar el mensaje de error nos ayudará a agrupar los datos sobre los errores encontrados a un ritmo mayor, así como a depurar los errores en casos de uso individuales. |
No se recopilan actualmente |
|
Error: Stack Trace |
El seguimiento de la pila del mensaje de error, si se produce un error. Texto en formato libre redactado |
[Requiere una suscripción opcional] El seguimiento de la pila será útil para la depuración individual y es necesario para que podamos reproducir los problemas que puedan surgir. |
No está recopilada actualmente |
|
Registros de errores |
Los registros de un comando CLI fallido, si se produce un error. Texto en formato libre redactado |
[Requiere suscripción voluntaria] Los registros de errores también nos ayudarán a depurar y reproducir los problemas que vemos en la CLI. |
No se recopilan actualmente |
Cómo optar por no ser incluido en la telemetría de la CLI de CDK
Ejecute el siguiente comando para ver el estado de la telemetría actual en función de los valores de contexto y las variables de entorno:
cdk cli-telemetry --status
Deshabilite el uso de valores de contexto
Si hay conflictos en los valores de contexto de varias fuentes, el CDK utiliza el siguiente orden de prioridad.
-
Valores de contexto especificados mediante un comando de la CLI de CDK con la opción
--context -
Valores de contexto en cdk.json
-
Valores de contexto en cdk.json
-
Valores de contexto en cdk.json
Para excluirse con un comando de la CLI de CDK
Ejecute el siguiente comando de la CLI de CDK para deshabilitar la telemetría:
cdk cli-telemetry --disable
Al ejecutar este comando, se graba la acción en el archivo local cdk.context.json y solo se aplica a la aplicación de CDK actual.
Para deshabilitar, utilice el archivo de configuración de la aplicación
Se establece cli-telemetry: false en el archivo cdk.json de una aplicación. Esto deshabilita la telemetría de la aplicación.
Para excluirse, utilice el archivo de configuración global
cli-telemetry: falseConfigúrelo en el archivo ~/.cdk.json para deshabilitar la telemetría en todas las aplicaciones de CDK del mismo equipo. Debe especificar esta configuración dentro de un elemento de contexto de esta manera:
{ "context": { "cli-telemetry": false } }
Use una variable de entorno
Establezca la variable de entorno CDK_DISABLE_CLI_TELEMETRY en true para deshabilitar la telemetría CLI en ese entorno.
CDK_DISABLE_CLI_TELEMETRY=true
El valor de esta variable de entorno tiene prioridad sobre cualquier valor de contexto que se haya configurado.
sugerencia
Añada esta variable de entorno al archivo de startup del shell, por ejemplo .bashrc, para deshabilitar la telemetría cada vez que abra una ventana de terminal.
Opte por no utilizar el filtrado de DNS
El punto final de telemetría es. cdk-cli-telemetry.us-east-1.api.aws/metrics El bloqueo de este nombre de dominio en el firewall desactiva la telemetría de la CLI y no afecta a la funcionalidad de la CLI de CDK.
Excluya todos los informes de datos de uso
Para excluirse de todos los informes de datos de uso para un solo comando, utilice la opción global de la CLI --no-version-reporting. Esta opción desactiva la recopilación de datos de uso de la aplicación y la telemetría de la CLI de CDK.
Si actualmente opta por no participar en la recopilación de datos de uso de la aplicación mediante la opción --no-version-reporting, se excluirá automáticamente de la telemetría de la CLI de CDK para la ejecución de ese comando específico, independientemente de los valores del contexto.
nota
Si se establece analyticsReporting en el nivel de pila, prevalecerá sobre la opción --no-version-reporting de recopilar únicamente los datos de uso de las aplicaciones.
Envíe los datos de telemetría a un archivo local
Si opta por seguir utilizando la telemetría de la CLI de CDK, puede optar por enviar los datos de telemetría a un archivo local. Luego, puede revisar el archivo para auditar los datos de telemetría que estamos recopilando.
Utilice la siguiente opción en cualquier comando CLI de CDK para enviar datos de telemetría a un archivo local:
nota
Si utiliza una versión de AWS CDK CLI inferior a la 2.1100.0, debe especificarla junto con. --unstable=telemetry --telemetry-file
--telemetry-file='path/to/local/file'
Por ejemplo, este deploy comando envía los datos de telemetría a un archivo local:
cdk deploy --telemetry-file='path/to/local/file'
