Configurer la AWS télémétrie CDK CLI - AWS Kit de développement Cloud (AWS CDK) v2

Ceci est le guide du développeur du AWS CDK v2. L'ancien CDK v1 est entré en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configurer la AWS télémétrie CDK CLI

Qu'est-ce que la télémétrie CDK CLI ?

Important

AWS La télémétrie de la CLI CDK n'est collectée que dans les versions 2.1100.0 et supérieures de la AWS CLI CDK.

Le AWS Cloud Development Kit (AWS CDK) collecte des données de télémétrie sur l'utilisation de la CLI afin de fournir des modèles d'utilisation agrégés et des fréquences d'erreur qui nous aideront à identifier les problèmes courants affectant la base d'utilisateurs de la CLI CDK.

Les clients sont autorisés par défaut à participer à la collecte de données de télémétrie par CLI. Vous pouvez désactiver la télémétrie CDK CLI en utilisant les méthodes répertoriées ci-dessous.

AWS CDK collecte les données de télémétrie dans un souci de minimisation stricte des données, en empêchant l'identification ou l'attribution à des utilisateurs, des comptes ou des organisations spécifiques. Une liste exhaustive des mesures collectées par défaut, avec les raisons pour lesquelles elles sont collectées, est fournie ci-dessous. Aucune autre télémétrie ou métrique n'est collectée.

Sachez que nous ne collectons pas actuellement de messages d'erreur, de traces de pile et de journaux, et que cette collecte de données sera disponible dans une future version de la CLI CDK sous forme d'opt-in explicite. Vous trouverez plus d'informations sur ces métriques dans le tableau.

Les données collectées sont les suivantes :

Métrique Description Raison Exemple

Version de la CLI du CDK

Version de la CLI (x.y.z)

La collecte de ces informations nous aidera à diviser nos données en deux par version, ce qui peut nous aider à identifier les versions problématiques.

"2.1100.0"

ID d'installation

UUID aléatoire stocké sur des machines locales exécutant des commandes CLI

Cela nous permet d'estimer le nombre distinct d'utilisateurs concernés par une erreur. Chaque machine unique aura son propre identifiant d'installation généré aléatoirement via l'UUID V4.

"881d3281-2811-4c86-b7b6-4a8a621cf6f2"

ID de session

UUID aléatoire généré à chaque appel de commande CLI

Cela nous permet d'identifier tous les événements provenant d'une même commande.

"c47e3d55-bc20-406b-a02a-e0285dd63230"

ID de l’événement

L'identifiant de session plus un compteur

Cela crée un identifiant unique pour chaque événement d'une session.

"c47e3d55-bc20-406b-a02a-e0285dd63230:0"

Région

Région AWS

Cela nous aidera à diviser nos données en deux pour les problèmes spécifiques à chaque région.

"us-east-1"

Horodatage

L'heure (générée par le client) à laquelle les données sont envoyées à notre terminal de télémétrie

Cela nous aidera à générer des graphiques de séries chronologiques.

"2025-12-12T00:00:00.000Z"

État de l'événement

Le « résultat » de l'événement. Les valeurs possibles sont « SUCCESS », « FAILURE », « ABORTED »

Cela nous aidera à suivre les taux d'erreur sur chaque commande de la CLI et à nous avertir des régressions potentielles avant qu'elles ne soient signalées par les clients.

"SUCCESS"

Type d’événement

Un identifiant pour le type d'événement qui produit les données

Il s'agit d'une énumération qui identifie le type d'événement qui s'est produit car il peut y avoir plusieurs événements lors de l'exécution d'une commande.

"SYNTH"

Chemin de commande

La commande et les propriétés saisies dans la CLI, avec tout texte libre expurgé

Outre les paramètres de commande, ces informations aident à déterminer le comportement de l'événement qui s'est produit, ce qui nous aide à identifier le rayon d'explosion et la cause des problèmes survenus.

["cdk", "deploy", "$STACK1"]

Paramètres de commande

Les paramètres optionnels saisis dans la CLI, avec tout texte libre expurgé

Outre le chemin de commande, ces informations aident à déterminer le comportement de l'événement qui s'est produit, ce qui nous aide à identifier le rayon d'explosion et la cause des problèmes qui surviennent.

{
  all: true,
  concurrency: 4
}

Configuration

Paramètres supplémentaires susceptibles d'affecter la commande CLI (par exemple cdk.context.json ou les valeurs de contexte danscdk.json/~/.cdk.json), avec tout texte libre expurgé

Cela nous aidera à faciliter le débogage en fournissant une vue complète de tous les paramètres possibles susceptibles d'affecter le comportement de la CLI.

{
  context: {
    "@aws-cdk/core:explicitStackTags": true
  }
}

Système d’exploitation

Le système d'exploitation utilisé

Cela nous aidera à résoudre les problèmes qui n'affectent que des systèmes d'exploitation spécifiques.

{
  platform: "linux",
  release: "5.15.0-1019-aws",
}

CI/CD

Si la commande CLI est invoquée ou non depuis un CI/CD environnement

Cela nous aidera à identifier les problèmes spécifiques aux CI/CD environnements.

false

Version du nœud

Version du nœud utilisée dans l'environnement

Cela nous aidera à résoudre tout problème spécifique au nœud qui pourrait survenir.

"v22.0.0"

Duration

Durée de l'événement en millisecondes

Cela nous aide à observer des tendances quant à la durée de certains événements.

{ total: 300 }

Compteurs

Diverses mesures de comptage dérivées de l'exécution de votre application CDK et de votre CLI

Nous surveillerons comment les statistiques de comptage telles que (mais sans s'y limiter) le nombre de ressources CFN affectent la durée du déploiement.

{
  resourceCount: 25,
  errorCount: 0,
  warningCount: 2,
}

Dépendances

Dépendances AWS pertinentes et leurs versions

Nous prévoyons de suivre les dépendances AWS susceptibles d'affecter le résultat de la CLI aws-cdk-lib, comme jsii, projen, etc. Nous collecterons uniquement les dépendances relatives à des bibliothèques spécifiques appartenant à AWS.

[{ "aws-cdk-lib": "2.232.0"}]

Noms des erreurs

Le nom de l'erreur, si une erreur se produit.

Nous enregistrons uniquement les noms des erreurs que nous contrôlons, ce qui permet d'identifier les types d'erreurs récurrents.

"ToolkitError"

Les statistiques suivantes nécessitent une inscription explicite et ne sont PAS collectées actuellement :

Messages d'erreur

Le message d'erreur renvoyé en cas d'erreur. Texte en forme libre expurgé

[Nécessite une inscription] La capture du message d'erreur nous aidera à agréger plus rapidement les données sur les erreurs rencontrées, ainsi qu'à résoudre les problèmes rencontrés dans des cas d'utilisation individuels.

Non collecté actuellement

Erreur Stack Trace

La trace du message d'erreur, en cas d'erreur. Texte en forme libre expurgé

[Nécessite une inscription] Le stack trace sera utile à des fins de débogage individuel et est nécessaire pour que nous puissions reproduire les problèmes susceptibles de survenir.

Non collecté actuellement

Journaux d'erreurs

Les journaux d'une commande CLI ayant échoué, en cas d'erreur. Texte en forme libre expurgé

[Nécessite une inscription] Les journaux d'erreurs nous aideront également à déboguer et à reproduire les problèmes rencontrés dans la CLI.

Non collecté actuellement

Comment désactiver la télémétrie CDK CLI

Pour afficher l'état actuel de votre télémétrie en fonction des valeurs contextuelles et des variables d'environnement, exécutez la commande suivante :

cdk cli-telemetry --status

Désinscription à l'aide de valeurs contextuelles

En cas de conflit entre les valeurs de contexte provenant de différentes sources, le CDK utilise l'ordre de priorité suivant.

  1. Valeurs de contexte spécifiées à l'aide d'une commande CDK CLI avec l'option --context

  2. Valeurs de contexte dans cdk.json

  3. Valeurs de contexte dans cdk.context.json

  4. Valeurs de contexte dans ~/.cdk.json

Pour vous désinscrire à l'aide d'une commande CDK CLI

Exécutez la commande CDK CLI suivante pour désactiver la télémétrie :

cdk cli-telemetry --disable

L'exécution de cette commande enregistre l'action dans votre cdk.context.json fichier local et ne s'applique qu'à l'application CDK actuelle.

Pour vous désinscrire à l'aide du fichier de configuration de l'application

cli-telemetry: falseDéfini dans le cdk.json fichier d'une application. Cela désactive la télémétrie pour l'application.

Pour vous désinscrire à l'aide du fichier de configuration global

Définissez cli-telemetry: false dans le ~/.cdk.json fichier pour désactiver la télémétrie pour toutes les applications CDK sur le même ordinateur. Vous devez spécifier ce paramètre dans un élément de contexte comme suit :

{
  "context": {
    "cli-telemetry": false
  }
}

Désinscription à l'aide d'une variable d'environnement

Définissez la variable d'CDK_DISABLE_CLI_TELEMETRYenvironnement sur true pour désactiver la télémétrie CLI dans cet environnement.

CDK_DISABLE_CLI_TELEMETRY=true

La valeur de cette variable d'environnement a priorité sur toutes les valeurs de contexte définies.

Astuce

Ajoutez cette variable d'environnement au fichier de démarrage de votre shell, par exemple .bashrc pour désactiver la télémétrie chaque fois que vous ouvrez une fenêtre de terminal.

Désinscription à l'aide du filtrage DNS

Le point de terminaison de télémétrie est. cdk-cli-telemetry.us-east-1.api.aws/metrics Le blocage de ce nom de domaine dans votre pare-feu désactive la télémétrie de la CLI et n'affecte pas les fonctionnalités de la CLI CDK.

Désactiver tous les rapports de données d'utilisation

Pour désactiver tous les rapports de données d'utilisation pour une seule commande, utilisez l'option CLI --no-version-reporting globale. Cette option désactive à la fois la collecte des données d'utilisation des applications et la télémétrie CDK CLI.

Si vous désactivez actuellement la collecte de données d'utilisation des applications à l'aide de --no-version-reporting cette option, vous êtes automatiquement désactivée de la télémétrie CDK CLI pour l'exécution de cette commande spécifique, quelles que soient les valeurs de contexte.

Note

Si vous le définissez analyticsReporting au niveau de la pile, il a priorité sur l'--no-version-reportingoption de collecte des données d'utilisation des applications uniquement.

Envoyer des données de télémétrie vers un fichier local

Si vous choisissez de rester abonné à la télémétrie CDK CLI, vous pouvez choisir d'envoyer vos données de télémétrie vers un fichier local. Vous pouvez ensuite consulter le fichier pour auditer les données de télémétrie que nous collectons.

Utilisez l'option suivante sur n'importe quelle commande CDK CLI pour envoyer des données de télémétrie vers un fichier local :

Note

Si vous utilisez une version de CLI AWS CDK inférieure à 2.1100.0, vous devez spécifier --unstable=telemetry avec. --telemetry-file

--telemetry-file='path/to/local/file'

Par exemple, cette deploy commande envoie des données de télémétrie vers un fichier local :

cdk deploy --telemetry-file='path/to/local/file'