AWS CDK 사용량 데이터 보고 구성

v AWS CDK 2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔으며 2023년 6월 1일에 지원이 종료되었습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

v AWS CDK 2 개발자 안내서입니다. 이전 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부터 사용 데이터 수집이 확장되어 다음과 같은 추가 사용 데이터가 포함됩니다.

고유하게 생성한 속성 키 및 값의 경우 전체 객체가 수정됩니다. 예를 들어 InlineApiDefinition를 사용하여 OpenAPI 사양을 정의하고 RestApi 구문으로 전달하면 전체 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 속성은 스택에 있는 구문의 gzip으로 압축되고, base64로 인코딩되고, 접두사로 인코딩된 목록입니다.

사용량 데이터 보고를 옵트아웃하거나 옵트인하는 방법

일반 사용 데이터 보고 및 추가 사용 데이터 보고를 옵트아웃하거나 옵트인하는 옵션은 원래 앱을 생성하는 데 사용한 CDK 버전에 따라 다릅니다.

기본적으로 CDK 애플리케이션은 다음과 같이 사용량 데이터 보고를 자동으로 옵트인하도록 구성됩니다.

모든 사용 데이터 보고 옵트아웃

모든 사용 데이터 보고를 옵트아웃하려면 AWS Cloud Development Kit (AWS CDK) 명령줄 인터페이스(CLI)를 사용하거나 프로젝트 cdk.json 파일을 구성할 수 있습니다.

추가 사용 데이터 보고만 옵트아웃

CDK 앱이 2.178.0보다 오래된 CDK 버전으로 생성된 경우 일반 사용 데이터 보고를 옵트인하더라도 추가 사용 데이터 보고를 자동으로 옵트아웃합니다. 추가 사용 데이터 보고를 옵트아웃하기 위해 아무 조치도 취할 필요가 없습니다.

CDK 앱이 CDK 버전 2.178.0 이상으로 생성된 경우 모든 사용 데이터 보고를 옵트아웃해야 합니다. 추가 사용 데이터 보고만 옵트아웃할 수 없습니다.

사용량 데이터 보고 옵트인

CDK 앱이 CDK 버전 2.178.0 이상으로 생성된 경우를 로 설정하여 모든 사용 데이터 보고를 옵트인versionReporting할 수 있습니다true. CDK 앱의 기본 동작입니다.

CDK 앱이 2.178.0보다 오래된 CDK 버전으로 생성된 경우를 로 설정하여 일반 사용 데이터 보고를 옵트인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": "*",
                } 
            } 
        } 
    ] 
}