Configuration des rapports sur les données AWS CDK d'utilisation

Ceci est le guide du AWS CDK développeur de la version 2. 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.

Ceci est le guide du AWS CDK développeur de la version 2. 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.

Qu'est-ce que le reporting des données d'utilisation du CDK ?

AWS Cloud Development Kit (AWS CDK) les applications sont configurées pour collecter et générer des rapports sur les données d'utilisation afin de mieux comprendre comment elles AWS CDK sont utilisées. L'équipe CDK utilise ces données pour effectuer les opérations suivantes :

Quelles sont les données d'utilisation collectées ?

Il existe deux catégories de données d'utilisation collectées par le CDK :

Collecte de données d'utilisation générales

Le CDK collecte les types de données d'utilisation générales suivants à partir de vos applications CDK :

Collecte de données d'utilisation supplémentaires

À partir de la version 2.178.0 du CDK, la collecte de données d'utilisation s'est étendue pour inclure les données d'utilisation supplémentaires suivantes :

Pour les clés de propriété et les valeurs que vous créez de manière unique, l'objet entier sera expurgé. Par exemple, si vous utilisez InlineApiDefinition pour définir un OpenAPI spécification et transmettez-la dans une RestApi construction, l'InlineApiDefinitionobjet entier sera expurgé.

Pour plus d'informations sur la collecte de données d'utilisation supplémentaires, y compris ses avantages et ses problèmes potentiels, consultez la discussion sur le CDK Collecting Additional Metadata (under feature flag) #33198 dans le référentiel aws-cdk.

Comment le CDK collecte les données d'utilisation

Lors de la synthèse, le CDK collecte les données d'utilisation de votre application et les stocke dans la AWS::CDK::Metadata ressource. Voici un exemple de cela sur un AWS CloudFormation modèle synthétisé :

CDKMetadata:
  Type: "AWS::CDK::Metadata"
  Properties:
    Analytics: "v2:deflate64:H4sIAND9SGAAAzXKSw5AMBAA0L1b2PdzBYnEAdio3RglglY60zQi7u6TWL/XKmNUlxeQSOKwaPTBqrNhwEWU3hGHiCzK0dWWfAxoL/Fd8mvk+QkS/0X6BdjnCdgmOOQKWz+AqqLDt2Y3YMnLYWwAAAA="

La Analytics propriété est une liste gzippée, codée en base64 et codée par préfixe des constructions de la pile.

Comment refuser ou accepter les rapports sur les données d'utilisation

Les options qui vous permettent de vous désinscrire ou d'accepter les rapports généraux sur les données d'utilisation et les rapports supplémentaires sur les données d'utilisation dépendent de la version du CDK que vous avez utilisée pour créer votre application à l'origine.

Par défaut, les applications CDK sont configurées pour accepter automatiquement les rapports sur les données d'utilisation comme suit :

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

Pour désactiver tous les rapports de données d'utilisation, vous pouvez utiliser l'interface de ligne de AWS Cloud Development Kit (AWS CDK) commande (CLI) ou configurez le cdk.json fichier de votre projet.

Désactiver uniquement les rapports de données d'utilisation supplémentaires

Si votre application CDK a été créée avec une version du CDK antérieure à la version 2.178.0, vous êtes automatiquement désabonné des rapports de données d'utilisation supplémentaires, même si vous êtes abonné aux rapports généraux sur les données d'utilisation. Vous n'avez rien à faire pour refuser de recevoir des rapports supplémentaires sur les données d'utilisation.

Si votre application CDK a été créée avec la version CDK 2.178.0 ou plus récente, vous devez désactiver tous les rapports de données d'utilisation. Vous ne pouvez pas refuser uniquement les rapports de données d'utilisation supplémentaires.

Accepter les rapports sur les données d'utilisation

Si votre application CDK a été créée avec la version CDK 2.178.0 ou plus récente, vous pouvez choisir de recevoir tous les rapports de données d'utilisation en réglant sur. versionReporting true Il s'agit du comportement par défaut des applications CDK.

Si votre application CDK a été créée avec une version du CDK antérieure à la version 2.178.0, vous pouvez choisir de recevoir des rapports généraux sur les données d'utilisation en réglant sur. versionReporting true Pour accepter des rapports supplémentaires sur les données d'utilisation, vous devez activer un indicateur de fonctionnalité.

Exemples

Données d'utilisation générales et supplémentaires collectées à partir d'une application CDK

Voici un exemple d'application CDK :

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';

class MyStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Create an S3 bucket (L2 construct)
    const myBucket = new s3.Bucket(this, 'MyBucket', {
      bucketName: 'my-cdk-example-bucket', // String type
      versioned: true,                    // Boolean type
      removalPolicy: cdk.RemovalPolicy.DESTROY, // ENUM type
      lifecycleRules: [{                  // Array of object type
        expirationDate: new Date('2019-10-01'),
        objectSizeLessThan: 600,
        objectSizeGreaterThan: 500,
      }],
    });

    // Use a method of the L2 construct to define additional properties
    myBucket.addLifecycleRule({
      id: 'ExpireOldObjects',
      enabled: true, // Boolean
      expiration: cdk.Duration.days(90), // Expire objects after 90 days
    });
  }
}

// Define the CDK app and stack
const app = new cdk.App();
new MyStack(app, 'MyStack');
app.synth();

Lors de la synthèse, les données d'utilisation sont collectées, compressées et stockées dans la AWS::CDK::Metadata ressource.

Voici un exemple de données d'utilisation générales collectées avec une version du CDK antérieure à la version 2.178.0 :

{ 
    "fqn": "aws-cdk-lib.aws-s3.Bucket", 
    "version": "v2.170.0" 
}

Voici un exemple de données d'utilisation collectées, y compris les données d'utilisation supplémentaires introduites dans la version 2.178.0 du CDK :

{ 
    "fqn": "aws-cdk-lib.aws_s3.Bucket", 
    "version": "2.170.0", 
    "metadata": [ 
        { 
            "type": "aws:cdk:analytics:construct", 
            "data": { 
                "bucketName": "*", 
                "versioned": true, 
                "removalPolicy": "cdk.RemovalPolicy.DESTROY", 
                "lifecycleRules": [ 
                    { 
                        "expirationDate": "*", 
                        "objectSizeLessThan": "*", 
                        "objectSizeGreaterThan": "*" 
                    } 
                ] 
            } 
        }, 
        { 
            "type": "aws:cdk:analytics:method", 
            "data": { 
                "name": "addLifecycleRule", 
                "prop": { 
                    "id": "*", 
                    "enabled": true, 
                    "expiration": "*",
                } 
            } 
        } 
    ] 
}