Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 wurde am 1. Juni 2022 gewartet und der Support wurde am 1. Juni 2023 eingestellt.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
AWS CDK-CLI-Telemetrie konfigurieren
Was ist CDK-CLI-Telemetrie?
Wichtig
AWS CDK-CLI-Telemetrie wird nur in den AWS CDK-CLI-Versionen 2.1100.0 und höher erfasst.
Das AWS Cloud Development Kit (AWS CDK) sammelt Telemetriedaten zur CLI-Nutzung, um aggregierte Nutzungsmuster und Fehlerhäufigkeiten bereitzustellen, die uns helfen, weit verbreitete Probleme zu identifizieren, die die CDK-CLI-Benutzerbasis betreffen.
Kunden haben sich standardmäßig für die Erfassung von CLI-Telemetrie-Daten entschieden. Sie können die CDK-CLI-Telemetrie mit den unten aufgeführten Methoden deaktivieren.
AWS CDK erfasst Telemetriedaten unter strikter Berücksichtigung der Datenminimierung und verhindert so die Identifizierung oder Zuordnung zu bestimmten Benutzern, Konten oder Organisationen. Im Folgenden finden Sie eine vollständige Liste der standardmäßig gesammelten Metriken mit Begründungen. Es werden keine weiteren Telemetriedaten oder Messwerte erfasst.
Bitte beachten Sie, dass wir derzeit keine Fehlermeldungen, Stack-Trace und Protokolle sammeln und dass diese Datenerfassung in einer future CDK-CLI-Version unter ausdrücklicher Zustimmung verfügbar sein wird. Weitere Informationen zu diesen Metriken finden Sie in der Tabelle.
Die gesammelten Daten lauten wie folgt:
| Metrik | Description | Grund | Beispiel |
|---|---|---|---|
|
CDK-CLI-Version |
CLI-Version (x.y.z) |
Das Sammeln dieser Daten hilft uns, unsere Daten nach Version zu unterteilen, was uns helfen kann, problematische Versionen zu identifizieren. |
"2.1100.0" |
|
ID der Installation |
Zufällige UUID, die auf lokalen Computern gespeichert ist, die CLI-Befehle ausführen |
Auf diese Weise können wir die genaue Anzahl der Benutzer abschätzen, die von einem Fehler betroffen sind. Jeder einzelne Computer hat seine eigene Installations-ID, die nach dem Zufallsprinzip über UUID V4 generiert wird. |
"881d3281-2811-4c86-b7b6-4a8a621cf6f2" |
|
Sitzungs-ID |
Zufällige UUID, die bei jedem CLI-Befehlsaufruf generiert wird |
Dies hilft uns, alle Ereignisse zu identifizieren, die auf denselben Befehl zurückzuführen sind. |
"c47e3d55-bc20-406b-a02a-e0285dd63230" |
|
Ereignis-ID |
Die Sitzungs-ID plus ein Zähler |
Dadurch wird für jedes Ereignis in einer Sitzung eine eindeutige Kennung erstellt. |
"c47e3d55-bc20-406b-a02a-e0285dd63230:0" |
|
Region |
AWS-Region |
Dies hilft uns, unsere Daten für regionsspezifische Probleme zu unterteilen. |
"us-east-1" |
|
Zeitstempel |
Die Uhrzeit (vom Client generiert), zu der die Daten an unseren Telemetrieendpunkt gesendet werden |
Dies wird uns helfen, Zeitreihendiagramme zu erstellen. |
"2025-12-12T00:00:00.000Z" |
|
Status des Ereignisses |
Das „Ergebnis“ des Ereignisses. Mögliche Werte sind 'SUCCESS', 'FAILURE', 'ABORTED' |
Auf diese Weise können wir die Fehlerquoten bei jedem CLI-Befehl verfolgen und uns auf mögliche Regressionen aufmerksam machen, bevor sie von Kunden gemeldet werden. |
"SUCCESS" |
|
Ereignistyp |
Eine Kennung für den Ereignistyp, der die Daten erzeugt |
Dies ist eine Aufzählung, die die Art des Ereignisses identifiziert, das eingetreten ist, da bei einer Befehlsausführung mehrere Ereignisse auftreten können. |
"SYNTH" |
|
Befehlspfad |
Der Befehl und die Eigenschaften, die in die CLI eingegeben wurden, wobei der freie Text redigiert wurde |
Zusammen mit den Befehlsparametern helfen uns diese Informationen dabei, das Verhalten des eingetretenen Ereignisses zu bestimmen. Auf diese Weise können wir den Explosionsradius und die Ursache der aufgetretenen Probleme ermitteln. |
["cdk", "deploy", "$STACK1"] |
|
Befehls-Parameter |
Die optionalen Parameter, die in die CLI eingegeben wurden, wobei der freie Text redigiert wurde |
Zusammen mit dem Befehlspfad helfen uns diese Informationen dabei, das Verhalten des eingetretenen Ereignisses zu bestimmen. Auf diese Weise können wir den Explosionsradius und die Ursache der auftretenden Probleme ermitteln. |
{
all: true,
concurrency: 4
}
|
|
Konfiguration |
Zusätzliche Parameter, die sich auf den CLI-Befehl auswirken können (d. h. cdk.context.json oder Kontextwerte in |
Dies wird uns helfen, das Debuggen zu erleichtern, indem wir einen umfassenden Überblick über alle möglichen Parameter bieten, die das Verhalten der CLI beeinflussen können. |
{ context: { "@aws-cdk/core:explicitStackTags": true } } |
|
Betriebssystem |
Das verwendete Betriebssystem |
Dies hilft uns beim Debuggen von Problemen, die nur bestimmte Betriebssysteme betreffen. |
{
platform: "linux",
release: "5.15.0-1019-aws",
}
|
|
CI/CD |
Ob der CLI-Befehl von einer CI/CD Umgebung aus aufgerufen wird oder nicht |
Dies hilft uns, umgebungsspezifische Probleme zu identifizieren CI/CD . |
false |
|
Knotenversion |
Die in der Umgebung verwendete Knotenversion |
Dies hilft uns beim Debuggen aller auftretenden knotenspezifischen Probleme. |
"v22.0.0" |
|
Dauer |
Die Länge des Ereignisses in Millisekunden |
Auf diese Weise können wir Muster darin erkennen, wie lange bestimmte Ereignisse dauern. |
{ total: 300 }
|
|
Zähler |
Verschiedene Zählermetriken, die aus Ihrer CDK-App und der CLI-Ausführung abgeleitet wurden |
Wir werden beobachten, wie sich Zählstatistiken wie (aber nicht beschränkt auf) die Anzahl der CFN-Ressourcen auf die Dauer der Bereitstellung auswirken. |
{
resourceCount: 25,
errorCount: 0,
warningCount: 2,
}
|
|
Abhängigkeiten |
Relevante AWS-Abhängigkeiten und ihre Versionen |
Wir planen, AWS-Abhängigkeiten zu verfolgen, die sich auf das CLI-Ergebnis auswirken könnten aws-cdk-lib, wie jsii, projen usw. Wir werden nur Abhängigkeiten von bestimmten AWS-eigenen Bibliotheken sammeln. |
[{ "aws-cdk-lib": "2.232.0"}]
|
|
Fehlernamen |
Der Name des Fehlers, falls ein Fehler auftritt. |
Wir zeichnen nur Fehlernamen auf, die wir kontrollieren, was uns hilft, wiederkehrende Fehlertypen zu identifizieren. |
"ToolkitError" |
|
Die folgenden Kennzahlen erfordern eine ausdrückliche Zustimmung und werden derzeit NICHT erfasst: |
|||
|
Fehlermeldungen |
Die Fehlermeldung wird zurückgegeben, wenn ein Fehler auftritt. Freiformtext redigiert |
[Opt-In erforderlich] Das Erfassen der Fehlermeldung hilft uns dabei, Daten darüber zu sammeln, welche Fehler häufiger aufgetreten sind, und hilft uns, Fehler zu debuggen, was in einzelnen Anwendungsfällen schief gelaufen ist. |
Derzeit nicht erfasst |
|
Fehler Stack Trace |
Der Stack-Trace der Fehlermeldung, falls ein Fehler auftritt. Freiformtext redigiert |
[Opt-In erforderlich] Der Stack-Trace ist für individuelle Debugging-Zwecke hilfreich und ist notwendig, damit wir eventuell auftretende Probleme reproduzieren können. |
Derzeit nicht gesammelt |
|
Fehlerprotokolle |
Die Protokolle eines fehlgeschlagenen CLI-Befehls, falls ein Fehler auftritt. Freiformtext redigiert |
[Opt-In erforderlich] Fehlerprotokolle helfen uns auch dabei, Probleme, die wir in der CLI sehen, zu debuggen und zu reproduzieren. |
Derzeit nicht erfasst |
So deaktivieren Sie die CDK-CLI-Telemetrie
Führen Sie den folgenden Befehl aus, um Ihren aktuellen Telemetriestatus anhand von Kontextwerten und Umgebungsvariablen anzuzeigen:
cdk cli-telemetry --status
Mithilfe von Kontextwerten deaktivieren
Wenn es Konflikte zwischen den Kontextwerten aus verschiedenen Quellen gibt, verwendet das CDK die folgende Rangfolge.
-
Kontextwerte, die mit einem CDK-CLI-Befehl mit der
--contextOption angegeben wurden -
Kontextwerte in cdk.json
-
Kontextwerte in cdk.context.json
-
Kontextwerte in ~/.cdk.json
So melden Sie sich mit einem CDK-CLI-Befehl ab
Führen Sie den folgenden CDK-CLI-Befehl aus, um die Telemetrie zu deaktivieren:
cdk cli-telemetry --disable
Wenn Sie diesen Befehl ausführen, wird die Aktion in Ihrer lokalen cdk.context.json Datei aufgezeichnet und gilt nur für die aktuelle CDK-Anwendung.
So melden Sie sich mithilfe der Anwendungskonfigurationsdatei ab
Wird cli-telemetry: false in der cdk.json Datei einer Anwendung festgelegt. Dadurch wird die Telemetrie für die Anwendung deaktiviert.
Um sich mithilfe der globalen Konfigurationsdatei abzumelden
cli-telemetry: falseIn der ~/.cdk.json Datei festlegen, dass Telemetrie für alle CDK-Anwendungen auf demselben Computer deaktiviert wird. Sie müssen diese Einstellung in einem Kontextelement wie folgt angeben:
{ "context": { "cli-telemetry": false } }
Verwenden Sie eine Umgebungsvariable, um sich abzumelden
Setzen Sie die CDK_DISABLE_CLI_TELEMETRY Umgebungsvariable auf, true um die CLI-Telemetrie in dieser Umgebung zu deaktivieren.
CDK_DISABLE_CLI_TELEMETRY=true
Der Wert dieser Umgebungsvariablen hat Vorrang vor allen festgelegten Kontextwerten.
Tipp
Fügen Sie diese Umgebungsvariable zu Ihrer Shell-Startdatei hinzu.bashrc, um beispielsweise die Telemetrie bei jedem Öffnen eines Terminalfensters zu deaktivieren.
Melden Sie sich mithilfe der DNS-Filterung ab
Der Telemetrieendpunkt istcdk-cli-telemetry.us-east-1.api.aws/metrics. Wenn Sie diesen Domainnamen in Ihrer Firewall blockieren, wird die CLI-Telemetrie deaktiviert und die CDK-CLI-Funktionalität nicht beeinträchtigt.
Melden Sie sich von allen Berichten über Nutzungsdaten ab
Verwenden Sie die --no-version-reporting globale CLI-Option, um die gesamte Berichterstattung über Nutzungsdaten für einen einzelnen Befehl zu deaktivieren. Diese Option deaktiviert sowohl die Erfassung von Anwendungsnutzungsdaten als auch die CDK-CLI-Telemetrie.
Wenn Sie derzeit die Erfassung von Anwendungsnutzungsdaten mithilfe dieser --no-version-reporting Option deaktivieren, werden Sie unabhängig von den Kontextwerten automatisch von der CDK-CLI-Telemetrie für diese bestimmte Befehlsausführung abgemeldet.
Anmerkung
Wenn Sie dies auf analyticsReporting Stack-Ebene festlegen, hat dies Vorrang vor der --no-version-reporting Option, nur Daten zur Anwendungsnutzung zu sammeln.
Sendet Telemetriedaten an eine lokale Datei
Wenn Sie die CDK-CLI-Telemetrie weiterhin nutzen möchten, können Sie wählen, ob Sie Ihre Telemetriedaten an eine lokale Datei senden möchten. Anschließend können Sie die Datei überprüfen, um die von uns gesammelten Telemetriedaten zu überprüfen.
Verwenden Sie die folgende Option für jeden CDK-CLI-Befehl, um Telemetriedaten an eine lokale Datei zu senden:
Anmerkung
Wenn Sie eine AWS CDK-CLI-Version unter 2.1100.0 verwenden, müssen Sie zusammen mit angeben--unstable=telemetry. --telemetry-file
--telemetry-file='path/to/local/file'
Dieser deploy Befehl sendet beispielsweise Telemetriedaten an eine lokale Datei:
cdk deploy --telemetry-file='path/to/local/file'