設定 AWS CDK 用量資料報告

這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護，並於 2023 年 6 月 1 日結束支援。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護，並於 2023 年 6 月 1 日結束支援。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

什麼是 CDK 用量資料報告？

AWS Cloud Development Kit (AWS CDK) 應用程式設定為收集和報告用量資料，以深入了解 AWS CDK 的使用方式。CDK 團隊使用此資料執行下列動作：

會收集哪些用量資料？

CDK 收集的用量資料有兩種類別：

一般用量資料收集

CDK 會從 CDK 應用程式收集下列類型的一般使用資料：

其他用量資料收集

從 CDK 2.178.0 版開始，用量資料收集擴展為包含下列其他用量資料：

對於您唯一建立的屬性索引鍵和值，整個物件將會遭到編輯。例如，如果您使用 RestApi InlineApiDefinition定義OpenAPI規格並將其傳遞到建構中，則整個InlineApiDefinition物件將被修訂。

如需其他用量資料收集的詳細資訊，包括其優點和潛在問題，請參閱 aws-cdk 儲存庫中的 CDK 收集其他中繼資料 （在特徵旗標下） #33198 討論。

CDK 如何收集用量資料

在合成時，CDK 會從應用程式收集用量資料，並將其存放在 AWS::CDK::Metadata 資源中。以下是合成 AWS CloudFormation 範本上的範例：

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

Analytics 屬性是堆疊中建構的 gziped、base64 編碼、字首編碼清單。

如何選擇退出或選擇加入用量資料報告

您選擇退出或選擇加入一般用量資料報告和其他用量資料報告的選項，取決於您最初建立應用程式的 CDK 版本。

根據預設，CDK 應用程式會設定為自動選擇加入用量資料報告，如下所示：

選擇退出所有用量資料報告

若要選擇退出所有用量資料報告，您可以使用 AWS Cloud Development Kit (AWS CDK) 命令列界面 (CLI) 或設定專案cdk.json的檔案。

只選擇退出其他用量資料報告

如果您的 CDK 應用程式建立的 CDK 版本早於 2.178.0，即使您選擇加入一般用量資料報告，您也會自動選擇退出其他用量資料報告。您不需要採取任何動作來選擇退出其他用量資料報告。

如果您的 CDK 應用程式是使用 CDK 2.178.0 版或更新版本建立的，您必須選擇退出所有用量資料報告。您無法只選擇退出額外的用量資料報告。

選擇加入用量資料報告

如果您的 CDK 應用程式是使用 CDK 2.178.0 版或更新版本建立的，您可以將 versionReporting設定為 ，以選擇加入所有用量資料報告。 true這是 CDK 應用程式的預設行為。

如果您的 CDK 應用程式建立的 CDK 版本早於 2.178.0，您可以將 versionReporting設定為 以選擇加入一般用量資料報告。 true若要選擇加入其他用量資料報告，您必須啟用功能旗標。

範例

從 CDK 應用程式收集的一般和其他用量資料

以下是 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();

在合成時，會收集、壓縮用量資料，並存放在 AWS::CDK::Metadata 資源中。

以下是使用 2.178.0 以前的 CDK 版本收集的一般使用資料範例：

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

以下是收集的用量資料範例，包括 CDK 2.178.0 版中引入的其他用量資料：

{ 
    "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": "*",
                } 
            } 
        } 
    ] 
}