Ini adalah Panduan Pengembang AWS CDK v2. CDK v1 yang lebih lama memasuki pemeliharaan pada 1 Juni 2022 dan mengakhiri dukungan pada 1 Juni 2023.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Konfigurasikan AWS telemetri CDK CLI
Apa itu telemetri CDK CLI?
penting
AWS Telemetri CDK CLI hanya dikumpulkan dalam AWS CDK CLI versi 2.1100.0 dan yang lebih tinggi.
AWS Cloud Development Kit (AWS CDK) mengumpulkan data telemetri tentang penggunaan CLI untuk menyediakan pola penggunaan agregat dan frekuensi kesalahan yang akan membantu kami mengidentifikasi masalah luas yang memengaruhi basis pengguna CDK CLI.
Pelanggan dipilih untuk pengumpulan data telemetri CLI secara default. Anda dapat memilih keluar dari telemetri CDK CLI menggunakan metode yang tercantum di bawah ini.
AWS CDK mengumpulkan data telemetri dengan mempertimbangkan minimalisasi data yang ketat, mencegah identifikasi atau atribusi ke pengguna, akun, atau organisasi tertentu. Daftar lengkap metrik yang dikumpulkan secara default, dengan alasan mengapa, disediakan di bawah ini. Tidak ada telemetri atau metrik lebih lanjut yang dikumpulkan.
Perlu diketahui bahwa saat ini kami tidak mengumpulkan pesan kesalahan, jejak tumpukan, dan log, dan bahwa pengumpulan data ini akan tersedia dalam versi CDK CLI masa depan di bawah opt-in eksplisit. Informasi lebih lanjut tentang metrik ini dapat ditemukan di tabel.
Data yang dikumpulkan adalah sebagai berikut:
| Metrik | Deskripsi | Alasan | Contoh |
|---|---|---|---|
|
Versi CDK CLI |
Versi CLI (xyz) |
Mengumpulkan ini akan membantu kami membagi data kami berdasarkan versi, yang dapat membantu kami mengidentifikasi versi yang bermasalah. |
"2.1100.0" |
|
ID Instalasi |
UUID acak disimpan pada mesin lokal yang menjalankan perintah CLI |
Ini membantu kami memperkirakan jumlah pengguna yang berbeda yang terpengaruh oleh kesalahan. Setiap mesin unik akan memiliki ID Instalasi sendiri yang dihasilkan secara acak melalui UUID V4. |
"881d3281-2811-4c86-b7b6-4a8a621cf6f2" |
|
ID Sesi |
UUID acak yang dihasilkan pada setiap pemanggilan perintah CLI |
Ini membantu kami mengidentifikasi semua peristiwa yang berasal dari perintah yang sama. |
"c47e3d55-bc20-406b-a02a-e0285dd63230" |
|
ID peristiwa |
ID Sesi ditambah penghitung |
Ini menciptakan pengenal unik untuk setiap acara dalam satu sesi. |
"c47e3d55-bc20-406b-a02a-e0285dd63230:0" |
|
Region |
Wilayah AWS |
Ini akan membantu kami membagi dua data kami untuk masalah khusus wilayah. |
"us-east-1" |
|
Stempel Waktu |
Waktu (dihasilkan oleh klien) data dikirim ke titik akhir telemetri kami |
Ini akan membantu kami menghasilkan grafik deret waktu. |
"2025-12-12T00:00:00.000Z" |
|
Negara Acara |
“Hasil” dari acara tersebut. Nilai yang mungkin adalah 'SUKSES', 'KEGAGALAN', 'DIBATALKAN' |
Ini akan membantu kami melacak tingkat kesalahan pada setiap perintah CLI dan mengingatkan kami tentang potensi regresi sebelum dilaporkan oleh pelanggan. |
"SUCCESS" |
|
Jenis Acara |
Pengidentifikasi untuk jenis peristiwa yang menghasilkan data |
Ini adalah enum yang mengidentifikasi jenis peristiwa yang terjadi karena mungkin ada beberapa peristiwa dalam eksekusi perintah. |
"SYNTH" |
|
Jalur Perintah |
Perintah dan properti yang dimasukkan ke dalam CLI, dengan teks gratis apa pun yang disunting |
Seiring dengan parameter perintah, informasi ini membantu menentukan perilaku peristiwa yang terjadi, yang membantu kami mengidentifikasi radius ledakan dan penyebab masalah yang muncul. |
["cdk", "deploy", "$STACK1"] |
|
Parameter Perintah |
Parameter opsional dimasukkan ke dalam CLI, dengan teks gratis apa pun yang disunting |
Seiring dengan jalur perintah, informasi ini membantu menentukan perilaku peristiwa yang terjadi, yang membantu kami mengidentifikasi radius ledakan dan penyebab masalah yang terjadi. |
{
all: true,
concurrency: 4
}
|
|
Konfigurasi |
Parameter tambahan yang dapat memengaruhi perintah CLI (yaitu cdk.context.json atau nilai konteks di |
Ini akan membantu kami memfasilitasi debugging dengan memberikan pandangan komprehensif dari semua parameter yang mungkin yang dapat memengaruhi perilaku CLI. |
{ context: { "@aws-cdk/core:explicitStackTags": true } } |
|
Sistem Operasi |
Sistem operasi yang sedang digunakan |
Ini akan membantu kami men-debug masalah yang hanya memengaruhi sistem operasi tertentu. |
{
platform: "linux",
release: "5.15.0-1019-aws",
}
|
|
CI/CD |
Apakah perintah CLI sedang dipanggil dari lingkungan atau tidak CI/CD |
Ini akan membantu kami mengidentifikasi masalah khusus untuk CI/CD lingkungan. |
false |
|
Versi Node |
Versi node yang digunakan di lingkungan |
Ini akan membantu kami men-debug masalah spesifik node yang muncul. |
"v22.0.0" |
|
Durasi |
Panjang acara dalam milidetik |
Ini membantu kita memperhatikan pola berapa lama peristiwa tertentu berlangsung. |
{ total: 300 }
|
|
Penghitung |
Berbagai metrik penghitung yang berasal dari aplikasi CDK dan eksekusi CLI Anda |
Kami akan memantau bagaimana penghitungan statistik seperti (tetapi tidak terbatas pada) jumlah sumber daya CFN memengaruhi durasi penerapan. |
{
resourceCount: 25,
errorCount: 0,
warningCount: 2,
}
|
|
Dependensi |
Dependensi AWS yang relevan dan versinya |
Kami berencana untuk melacak dependensi AWS yang mungkin memengaruhi hasil CLI, seperti, jsii, aws-cdk-lib proyen, dll. Kami hanya akan mengumpulkan dependensi pada pustaka khusus yang dimiliki AWS. |
[{ "aws-cdk-lib": "2.232.0"}]
|
|
Nama Kesalahan |
Nama kesalahan, jika terjadi kesalahan. |
Kami hanya mencatat nama kesalahan yang kami kontrol, yang membantu mengidentifikasi jenis kesalahan yang terjadi kembali. |
"ToolkitError" |
|
Metrik berikut memerlukan keikutsertaan eksplisit dan TIDAK dikumpulkan saat ini: |
|||
|
Pesan Kesalahan |
Pesan kesalahan dikembalikan, jika terjadi kesalahan. Teks formulir gratis disunting |
[Memerlukan keikutsertaan] Menangkap pesan kesalahan akan membantu kami mengumpulkan data di mana kesalahan ditemui pada tingkat yang lebih besar, serta membantu kami men-debug apa yang salah dalam kasus penggunaan individual. |
Saat ini belum dikumpulkan |
|
Kesalahan Stack Trace |
Jejak tumpukan pesan kesalahan, jika terjadi kesalahan. Teks formulir gratis disunting |
[Memerlukan keikutsertaan] Jejak tumpukan akan membantu untuk tujuan debugging individu dan diperlukan bagi kami untuk dapat mereproduksi masalah yang mungkin timbul. |
Saat ini belum dikumpulkan |
|
Log Kesalahan |
Log dari perintah CLI gagal, jika terjadi kesalahan. Teks formulir gratis disunting |
[Memerlukan keikutsertaan] Log kesalahan juga akan membantu kami men-debug dan mereproduksi masalah yang kami lihat di CLI. |
Saat ini belum dikumpulkan |
Cara memilih keluar dari telemetri CDK CLI
Untuk melihat status telemetri Anda saat ini berdasarkan nilai konteks dan variabel lingkungan, jalankan perintah berikut:
cdk cli-telemetry --status
Memilih keluar menggunakan nilai konteks
Jika ada konflik dalam nilai konteks dari berbagai sumber, CDK menggunakan urutan prioritas berikut.
-
Nilai konteks ditentukan menggunakan perintah CDK CLI dengan opsi
--context -
Nilai konteks di cdk.json
-
Nilai konteks di cdk.context.json
-
Nilai konteks di ~/.cdk.json
Untuk memilih keluar menggunakan perintah CDK CLI
Jalankan perintah CDK CLI berikut untuk menonaktifkan telemetri:
cdk cli-telemetry --disable
Menjalankan perintah ini merekam tindakan ke cdk.context.json file lokal Anda dan hanya berlaku untuk aplikasi CDK saat ini.
Untuk memilih keluar menggunakan file konfigurasi aplikasi
Ditetapkan cli-telemetry: false dalam cdk.json file aplikasi. Ini menonaktifkan telemetri untuk aplikasi.
Untuk memilih keluar menggunakan file konfigurasi global
Atur cli-telemetry: false dalam ~/.cdk.json file untuk menonaktifkan telemetri untuk semua aplikasi CDK di komputer yang sama. Anda harus menentukan pengaturan ini di dalam elemen konteks sebagai berikut:
{ "context": { "cli-telemetry": false } }
Memilih keluar menggunakan variabel lingkungan
Setel variabel CDK_DISABLE_CLI_TELEMETRY lingkungan true untuk menonaktifkan telemetri CLI di lingkungan itu.
CDK_DISABLE_CLI_TELEMETRY=true
Nilai variabel lingkungan ini lebih diutamakan daripada nilai konteks apa pun yang telah ditetapkan.
Tip
Tambahkan variabel lingkungan ini ke file startup shell Anda, seperti.bashrc, untuk menonaktifkan telemetri setiap kali Anda membuka jendela terminal.
Memilih keluar menggunakan pemfilteran DNS
Titik akhir telemetri adalah. cdk-cli-telemetry.us-east-1.api.aws/metrics Memblokir nama domain ini di firewall Anda menonaktifkan telemetri CLI dan tidak memengaruhi fungsionalitas CDK CLI.
Menyisih dari semua pelaporan data penggunaan
Untuk memilih keluar dari semua pelaporan data penggunaan untuk satu perintah, gunakan opsi CLI --no-version-reporting global. Opsi ini mematikan pengumpulan data penggunaan aplikasi dan telemetri CDK CLI.
Jika saat ini Anda memilih keluar dari pengumpulan data penggunaan aplikasi menggunakan --no-version-reporting opsi, Anda secara otomatis memilih keluar dari telemetri CDK CLI untuk eksekusi perintah tertentu, terlepas dari nilai konteksnya.
catatan
Jika Anda mengatur analyticsReporting pada tingkat tumpukan, itu lebih diutamakan daripada --no-version-reporting opsi untuk pengumpulan data penggunaan aplikasi saja.
Kirim data telemetri ke file lokal
Jika Anda memilih untuk tetap memilih telemetri CDK CLI, Anda dapat memilih untuk mengirim data telemetri Anda ke file lokal. Anda kemudian dapat meninjau file untuk mengaudit data telemetri yang kami kumpulkan.
Gunakan opsi berikut pada perintah CDK CLI apa pun untuk mengirim data telemetri ke file lokal:
catatan
Jika Anda menggunakan versi AWS CDK CLI di bawah 2.1100.0, Anda harus menentukan bersama dengan. --unstable=telemetry --telemetry-file
--telemetry-file='path/to/local/file'
Sebagai contoh, deploy perintah ini mengirimkan data telemetri ke file lokal:
cdk deploy --telemetry-file='path/to/local/file'