Configurazione della AWS telemetria CLI CDK - AWS Cloud Development Kit (AWS CDK) v2

Questa è la AWS CDK v2 Developer Guide. Il vecchio CDK v1 è entrato in manutenzione il 1° giugno 2022 e ha terminato il supporto il 1° giugno 2023.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configurazione della AWS telemetria CLI CDK

Cos'è la telemetria CDK CLI?

Importante

AWS La telemetria CDK CLI viene raccolta solo nelle versioni AWS CDK CLI 2.1100.0 e successive.

Il AWS Cloud Development Kit (AWS CDK) raccoglie dati di telemetria sull'utilizzo della CLI per fornire modelli di utilizzo aggregati e frequenze di errore che ci aiuteranno a identificare i problemi più diffusi che riguardano la base di utenti della CLI CDK.

Per impostazione predefinita, i clienti hanno attivato la raccolta dei dati di telemetria CLI. È possibile disattivare la telemetria CDK CLI utilizzando i metodi elencati di seguito.

AWS CDK raccoglie i dati di telemetria tenendo presente una rigorosa riduzione al minimo dei dati, impedendo l'identificazione o l'attribuzione a utenti, account o organizzazioni specifici. Di seguito viene fornito un elenco esaustivo delle metriche raccolte per impostazione predefinita, con i relativi motivi. Non vengono raccolti ulteriori dati di telemetria o metriche.

Tieni presente che al momento non stiamo raccogliendo messaggi di errore, stack trace e log e che questa raccolta di dati sarà disponibile in una futura versione della CLI CDK con consenso esplicito. Ulteriori informazioni su queste metriche sono disponibili nella tabella.

I dati raccolti sono i seguenti:

Metrica Description Motivo Esempio

Versione CDK CLI

Versione CLI (x.y.z)

La raccolta di questi dati ci aiuterà a suddividere in due i nostri dati per versione, il che può aiutarci a identificare le versioni problematiche.

"2.1100.0"

ID di installazione

UUID casuale memorizzato su macchine locali che eseguono comandi CLI

Questo ci aiuta a stimare il numero distinto di utenti interessati da un errore. Ogni macchina univoca avrà il proprio ID di installazione generato casualmente tramite UUID V4.

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

ID sessione

UUID casuale generato su ogni chiamata del comando CLI

Questo ci aiuta a identificare tutti gli eventi provenienti dallo stesso comando.

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

ID evento

L'ID della sessione più un contatore

Questo crea un identificatore univoco per ogni evento in una sessione.

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

Region

Regione AWS

Questo ci aiuterà a suddividere in due i nostri dati per problemi specifici della regione.

"us-east-1"

Time stamp

L'ora (generata dal cliente) in cui i dati vengono inviati al nostro endpoint di telemetria

Questo ci aiuterà a generare grafici di serie temporali.

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

Stato dell'evento

Il «risultato» dell'evento. I valori possibili sono 'SUCCESS', 'FAILURE', 'ABORTED'

Questo ci aiuterà a tenere traccia dei tassi di errore su ogni comando CLI e ad avvisarci di potenziali regressioni prima che vengano segnalate dai clienti.

"SUCCESS"

Tipo di evento

Un identificatore per il tipo di evento che produce i dati

Si tratta di un enum che identifica il tipo di evento che si è verificato poiché possono esserci più eventi nell'esecuzione di un comando.

"SYNTH"

Percorso di comando

Il comando e le proprietà inseriti nella CLI, con qualsiasi testo libero redatto

Oltre ai parametri di comando, queste informazioni aiutano a determinare il comportamento dell'evento che si è verificato, il che ci aiuta a identificare il raggio di esplosione e la causa dei problemi che si verificano.

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

Parametri di comando

I parametri opzionali inseriti nella CLI, con qualsiasi testo libero redatto

Oltre al percorso del comando, queste informazioni aiutano a determinare il comportamento dell'evento che si è verificato, il che ci aiuta a identificare il raggio di esplosione e la causa dei problemi che si verificano.

{
  all: true,
  concurrency: 4
}

Configurazione

Parametri aggiuntivi che possono influire sul comando CLI (ad esempio cdk.context.json o valori di contesto incdk.json/), con qualsiasi testo libero oscurato ~/.cdk.json

Questo ci aiuterà a facilitare il debug fornendo una visione completa di tutti i possibili parametri che possono influire sul comportamento della CLI.

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

Sistema operativo

Il sistema operativo utilizzato

Questo ci aiuterà a risolvere i problemi che riguardano solo sistemi operativi specifici.

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

CI/CD

Se il comando CLI viene richiamato o meno da un ambiente CI/CD

Questo ci aiuterà a identificare i problemi specifici degli ambienti. CI/CD

false

Versione del nodo

La versione del nodo utilizzata nell'ambiente

Questo ci aiuterà a risolvere eventuali problemi specifici del nodo che si presentano.

"v22.0.0"

Durata

La durata dell'evento in millisecondi

Questo ci aiuta a notare i modelli relativi alla durata di eventi specifici.

{ total: 300 }

Contatori

Diverse contrometriche derivate dall'esecuzione dell'app CDK e della CLI

Monitoreremo in che modo statistiche di conteggio come (ma non solo) il conteggio delle risorse CFN influiscono sulla durata dell'implementazione.

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

Dipendenze

Dipendenze AWS pertinenti e relative versioni

Abbiamo intenzione di tenere traccia delle dipendenze di AWS che potrebbero influire sul risultato della CLI, aws-cdk-lib come jsii, projen, ecc. Raccoglieremo solo le dipendenze da specifiche librerie di proprietà di AWS.

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

Nomi degli errori

Il nome dell'errore, se si verifica un errore.

Registriamo solo i nomi degli errori che controlliamo, il che aiuta a identificare i tipi di errore ricorrenti.

"ToolkitError"

Le seguenti metriche richiedono un consenso esplicito e NON sono attualmente raccolte:

Messaggi di errore

Il messaggio di errore viene restituito, se si verifica un errore. Testo in formato libero redatto

[Richiede il consenso esplicito] L'acquisizione del messaggio di errore ci aiuterà ad aggregare i dati sugli errori riscontrati con maggiore frequenza, oltre a consentirci di eseguire il debug di ciò che è andato storto nei singoli casi d'uso.

Al momento non sono raccolti

Error Stack Trace

La traccia dello stack del messaggio di errore, se si verifica un errore. Testo in formato libero redatto

[Richiede l'attivazione] La traccia dello stack sarà utile per scopi di debug individuali ed è necessaria per poter riprodurre i problemi che potrebbero sorgere.

Attualmente non raccolto

Log di errore

I log di un comando CLI fallito, se si verifica un errore. Testo in formato libero redatto

[Richiede il consenso esplicito] I log degli errori ci aiuteranno anche a eseguire il debug e a riprodurre i problemi che vediamo nella CLI.

Al momento non sono raccolti

Come disattivare la telemetria CDK CLI

Per visualizzare lo stato attuale della telemetria in base ai valori di contesto e alle variabili di ambiente, esegui il comando seguente:

cdk cli-telemetry --status

Disattiva l'utilizzo dei valori di contesto

In caso di conflitti nei valori di contesto provenienti da varie fonti, il CDK utilizza il seguente ordine di precedenza.

  1. Valori di contesto specificati utilizzando un comando CLI CDK con l'opzione --context

  2. Valori di contesto in cdk.json

  3. Valori di contesto in cdk.context.json

  4. Valori di contesto in ~/.cdk.json

Per disattivare l'utilizzo di un comando CDK CLI

Esegui il seguente comando CDK CLI per disabilitare la telemetria:

cdk cli-telemetry --disable

L'esecuzione di questo comando registra l'azione nel cdk.context.json file locale e si applica solo all'applicazione CDK corrente.

Per annullare l'iscrizione utilizzando il file di configurazione dell'applicazione

Impostato cli-telemetry: false nel cdk.json file di un'applicazione. Ciò disabilita la telemetria per l'applicazione.

Per disattivare l'utilizzo del file di configurazione globale

Imposta cli-telemetry: false nel ~/.cdk.json file per disabilitare la telemetria per tutte le applicazioni CDK sullo stesso computer. È necessario specificare questa impostazione all'interno di un elemento di contesto come segue:

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

Disattiva l'utilizzo di una variabile di ambiente

Imposta la variabile di CDK_DISABLE_CLI_TELEMETRY ambiente su per true disabilitare la telemetria CLI in quell'ambiente.

CDK_DISABLE_CLI_TELEMETRY=true

Il valore di questa variabile di ambiente ha la precedenza su tutti i valori di contesto che sono stati impostati.

Suggerimento

Aggiungi questa variabile di ambiente al file di avvio della shell, ad esempio per disabilitare la telemetria ogni volta che apri una finestra di terminale. .bashrc

Disattiva l'utilizzo del filtro DNS

L'endpoint di telemetria è. cdk-cli-telemetry.us-east-1.api.aws/metrics Il blocco di questo nome di dominio nel firewall disattiva la telemetria CLI e non influisce sulla funzionalità della CLI CDK.

Disattiva tutti i report sui dati di utilizzo

Per disattivare la segnalazione di tutti i dati di utilizzo per un singolo comando, utilizza l'opzione CLI --no-version-reporting globale. Questa opzione disattiva sia la raccolta dei dati sull'utilizzo dell'applicazione che la telemetria CDK CLI.

Se attualmente si sta disattivando la raccolta dei dati sull'utilizzo dell'applicazione utilizzando l'--no-version-reportingopzione, si disattiva automaticamente la telemetria CDK CLI per l'esecuzione di quel comando specifico, indipendentemente dai valori di contesto.

Nota

Se impostata analyticsReporting a livello di stack, ha la precedenza sull'opzione per la sola raccolta dei dati sull'utilizzo dell'applicazione. --no-version-reporting

Invia dati di telemetria a un file locale

Se scegli di rimanere attivo per la telemetria CDK CLI, puoi scegliere di inviare i dati di telemetria a un file locale. Puoi quindi esaminare il file per controllare i dati di telemetria che stiamo raccogliendo.

Utilizzate la seguente opzione su qualsiasi comando CDK CLI per inviare dati di telemetria a un file locale:

Nota

Se si utilizza una versione AWS CDK CLI inferiore alla 2.1100.0, è necessario specificare insieme a. --unstable=telemetry --telemetry-file

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

Ad esempio, questo deploy comando invia dati di telemetria a un file locale:

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