Este é o Guia do Desenvolvedor AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
O que são relatórios de dados de uso do CDK?
AWS Cloud Development Kit (AWS CDK) os aplicativos são configurados para coletar e relatar dados de uso para obter informações sobre como eles estão AWS CDK sendo usados. A equipe do CDK usa esses dados para fazer o seguinte:
-
Comunique-se com os clientes — identifique pilhas usando uma construção com problemas conhecidos de segurança ou confiabilidade e envie comunicações sobre tópicos que afetam o cliente.
-
Informe o desenvolvimento do CDK — Obtenha informações sobre o uso do CDK para melhor informar o desenvolvimento do CDK.
-
Investigue problemas do CDK — Quando os bugs são relatados, os dados de uso fornecem informações valiosas para a equipe do CDK na solução de problemas.
Quais dados de uso são coletados?
Há duas categorias de dados de uso coletados pelo CDK:
-
Dados gerais de uso
-
Dados de uso adicionais
Coleta de dados de uso geral
O CDK coleta os seguintes tipos de dados de uso geral de seus aplicativos CDK:
-
Versões das bibliotecas CDK usadas.
-
Nomes de construções usadas nos seguintes
NPMmódulos:-
AWS CDK módulos principais
-
AWS Construir módulos de biblioteca
-
AWS Módulo Solutions Constructs
-
AWS Módulo do kit de implantação do Render Farm
-
nota
Antes da versão 1.93.0, eles AWS CDK relatavam os nomes e versões dos módulos carregados durante a síntese, em vez das construções usadas na pilha.
Coleta adicional de dados de uso
A partir da versão 2.178.0 do CDK, a coleta de dados de uso foi expandida para incluir os seguintes dados de uso adicionais:
-
Chaves de propriedade definidas pelo CDK — Quando você usa uma propriedade integrada de uma construção L2, a chave da propriedade será coletada. Isso inclui chaves de propriedade integradas aninhadas em objetos de dicionário.
-
Valores de propriedade booleanos e enumerados de chaves de propriedade definidas pelo CDK — Para chaves de propriedade definidas pelo CDK, valores de propriedade somente dos tipos booleano e enum serão coletados. Todos os outros tipos, como valores de string ou referências de construção, serão redigidos.
-
Nome do método, chaves e valores de propriedade dos tipos booleano e enum — Quando você usa um método de construção L2, coletamos o nome do método, as chaves de propriedade e os valores de propriedade dos tipos booleano e enum.
Para chaves de propriedade e valores que você cria de forma exclusiva, o objeto inteiro será redigido. Por exemplo, se você usar InlineApiDefinition para definir um OpenAPI especifique e passe-a para uma RestApi construção, todo o InlineApiDefinition objeto será redigido.
Para obter mais informações sobre a coleta adicional de dados de uso, incluindo seus benefícios e possíveis preocupações, consulte a discussão #33198 sobre CDK Coletando metadados adicionais (sob a bandeira de recursos)
Como o CDK coleta dados de uso
Na síntese, o CDK coleta dados de uso do seu aplicativo e os armazena no AWS::CDK::Metadata recurso. Veja a seguir um exemplo disso em um modelo sintetizado AWS CloudFormation :
CDKMetadata:
Type: "AWS::CDK::Metadata"
Properties:
Analytics: "v2:deflate64:H4sIAND9SGAAAzXKSw5AMBAA0L1b2PdzBYnEAdio3RglglY60zQi7u6TWL/XKmNUlxeQSOKwaPTBqrNhwEWU3hGHiCzK0dWWfAxoL/Fd8mvk+QkS/0X6BdjnCdgmOOQKWz+AqqLDt2Y3YMnLYWwAAAA="A propriedade Analytics é uma lista compactada com gzip, codificada em base64 e codificada por prefixo dos constructos na pilha.
Como desativar ou optar por não receber relatórios de dados de uso
Suas opções de desativar ou optar por receber relatórios gerais de dados de uso e relatórios adicionais de dados de uso dependem da versão do CDK que você usou para criar seu aplicativo originalmente.
Por padrão, os aplicativos CDK são configurados para ativar automaticamente os relatórios de dados de uso da seguinte forma:
-
Todos os aplicativos CDK — Optou por receber relatórios de dados de uso geral.
-
Aplicativos CDK criados com uma versão anterior à v2.178.0 — Não optaram automaticamente por receber relatórios adicionais de dados de uso.
-
Aplicativos CDK criados com a versão v2.178.0 ou mais recente — optou por receber relatórios adicionais de dados de uso.
Atenção
Se você optar por não participar, o CDK não conseguirá identificar se você foi afetado por problemas de segurança e não enviará notificações sobre eles.
Opte por não receber todos os relatórios de dados de uso
Para desativar todos os relatórios de dados de uso, você pode usar a interface de linha de AWS Cloud Development Kit (AWS CDK) comando (CLI) ou configure o cdk.json arquivo do seu projeto.
Para optar por não receber todos os relatórios de dados de uso usando o CDK CLI
-
Use a
--no-version-reportingopção com qualquer CDK CLI comando para optar por não receber um único comando. Este é um exemplo de recusa durante a síntese do modelo:$cdk synth --no-version-reportingComo o CDK sintetiza modelos automaticamente quando você executa
cdk deploy, você também deve usar--no-version-reportingcom o comando.cdk deploy
Para desativar todos os relatórios de dados de uso configurando o arquivo cdk.json
-
Defina
versionReportingcomofalseem./cdk.jsonou~/.cdk.json. Isso exclui você por padrão. Veja um exemplo a seguir:{ "app": "...", "versionReporting": false } -
Após a configuração, você pode substituir esse comportamento e optar por participar especificando
--version-reportingem um comando individual.
Opte por não receber apenas os relatórios adicionais de dados de uso
Se seu aplicativo CDK foi criado com uma versão do CDK anterior à 2.178.0, você automaticamente desativará os relatórios adicionais de dados de uso, mesmo que opte pelos relatórios de dados de uso geral. Você não precisa fazer nada para optar por não receber relatórios adicionais de dados de uso.
Se seu aplicativo CDK foi criado com o CDK versão 2.178.0 ou mais recente, você deve optar por não receber todos os relatórios de dados de uso. Você não pode optar por não receber apenas os relatórios adicionais de dados de uso.
Opte por receber relatórios de dados de uso
Se seu aplicativo CDK foi criado com o CDK versão 2.178.0 ou mais recente, você pode optar por receber todos os relatórios de dados de uso configurando como. versionReporting true Esse é o comportamento padrão dos aplicativos CDK.
Se seu aplicativo CDK foi criado com uma versão CDK anterior à 2.178.0, você pode optar por receber relatórios de dados de uso geral configurando como. versionReporting true Para optar por receber relatórios adicionais de dados de uso, você deve ativar um sinalizador de recurso.
Para optar por receber relatórios adicionais de dados de uso
nota
Essas etapas são para aplicativos CDK originalmente criados com uma versão anterior à 2.178.0
-
Verifique se agora você está usando o CDK versão 2.178.0 ou mais recente.
-
No arquivo de configuração do CDK, especifique
@aws-cdk/core:enableAdditionalMetadataCollectioncomotrue. Veja um exemplo a seguir:{ "context": { "@aws-cdk/core:enableAdditionalMetadataCollection": "true" } } -
Você também pode usar o
ENABLE_ADDITIONAL_METADATA_COLLECTIONvalor com aFeatureFlagsclasse. Veja um exemplo a seguir:import * as cdk from 'aws-cdk-lib'; import { FeatureFlags } from 'aws-cdk-lib'; import * as cx_api from 'aws-cdk-lib/cx-api'; import { Construct } from 'constructs'; export class MyStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // Set the feature flag ENABLE_ADDITIONAL_METADATA_COLLECTION to true FeatureFlags.of(this).add(cx_api.ENABLE_ADDITIONAL_METADATA_COLLECTION, true); // Your stack resources go here new cdk.aws_s3.Bucket(this, 'MyBucket'); } } const app = new cdk.App(); new MyStack(app, 'MyStack');
Exemplos
Dados de uso gerais e adicionais coletados de um aplicativo CDK
Veja a seguir um exemplo de um aplicativo 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();Na síntese, os dados de uso são coletados, compactados e armazenados no AWS::CDK::Metadata recurso.
Veja a seguir um exemplo de dados de uso geral coletados com uma versão do CDK anterior à 2.178.0:
{
"fqn": "aws-cdk-lib.aws-s3.Bucket",
"version": "v2.170.0"
}Veja a seguir um exemplo dos dados de uso coletados, incluindo os dados de uso adicionais introduzidos na versão 2.178.0 do 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": "*",
}
}
}
]
}