Cloud Code dapat Anda gunakan untuk men-debug aplikasi yang di-deploy ke cluster Google Kubernetes Engine (GKE) dengan memanfaatkan skaffold debug
.
Anda dapat men-debug aplikasi di cluster lokal (seperti minikube atau Docker Desktop), GKE, atau penyedia cloud lainnya.
Dengan dukungan proses debug Cloud Code, Anda tidak perlu menyelesaikan penyiapan manual seperti menyiapkan penerusan port atau memasukkan argumen debug khusus bahasa. Proses debug memerlukan aplikasi GKE
yang mendukung Cloud Code yang mencakup file konfigurasi
skaffold.yaml
dan konfigurasi peluncuran cloudcode.kubernetes
.
Men-debug aplikasi GKE
Untuk mulai men-debug aplikasi GKE, ikuti langkah-langkah berikut:
Di status bar Cloud Code, klik nama project yang aktif.
Di menu Pilihan Cepat yang muncul, pilih Debug di Kubernetes.
Jika aplikasi Anda tidak memiliki konfigurasi Skaffold atau konfigurasi peluncuran
cloudcode.kubernetes
yang diperlukan, Cloud Code akan membantu Anda menyiapkannya.Konfirmasi apakah akan menggunakan konteks Kubernetes saat ini untuk menjalankan aplikasi (atau beralih ke yang lebih disukai).
Jika memilih cluster jarak jauh sebagai konteks, saat diminta, pilih registry image untuk mengirim gambar. Jika menggunakan Container Registry, Anda dapat menjelajahi registry yang ada atau menentukan nama registry yang akan dibuat. Jika project Anda mengaktifkan Artifact Registry API dan memiliki setidaknya satu repositori Artifact Registry, Anda dapat menjelajahi dan memilih repositori Artifact Registry yang ada.
Contoh berikut menunjukkan cara menentukan tempat image container disimpan untuk beberapa registry umum:
Artifact Registry {region}-docker.pkg.dev/{project_id}/{repo-name} Container Registry gcr.io/{project_id} Docker Hub docker.io/{account}
Pastikan Anda diautentikasi dengan benar jika menggunakan repositori Docker Hub pribadi.Untuk membuat nama akhir repositori gambar, Cloud Code menyambungkan registry image ini dengan nama image yang ditentukan dalam manifes Kubernetes. Pilihan ini disimpan dalam konfigurasi peluncuran
cloudcode.kubernetes
Anda (ditemukan di.vscode/launch.json
).Untuk mengetahui informasi selengkapnya, lihat panduan penanganan registry gambar.
Cloud Code mem-build container Anda, mengirimnya ke registry, menerapkan konfigurasi Kubernetes ke cluster, dan menunggu peluncuran.
Setelah peluncuran, Cloud Code secara otomatis meneruskan semua port container yang dideklarasikan ke mesin Anda dan menampilkan URL di jendela output sehingga Anda dapat menjelajahi aplikasi live Anda.
Untuk setiap penampung yang dapat di-debug dalam aplikasi Anda, konfirmasi atau masukkan direktori dalam penampung jarak jauh tempat program yang ingin Anda debug berada.
Atau, Anda dapat menekan ESC untuk melewati proses debug penampung.
Cloud Code melampirkan sesi debug untuk setiap penampung yang dapat di-debug dalam aplikasi.
Kini Anda dapat melakukan tugas yang sama seperti yang biasa dilakukan saat men-debug kode lokal, seperti menyetel titik henti sementara dan menelusuri kode, terhadap cluster Kubernetes live.
Secara default, saat perubahan pada aplikasi Anda disimpan otomatis, Cloud Code akan men-deploy ulang aplikasi Anda dan menyiapkan sesi debug baru. Anda dapat mengalihkan fitur ini dengan flag
watch
dalam konfigurasi peluncuran project.Untuk memeriksa variabel dan info stack, gunakan Sidebar Debug. Untuk berinteraksi dengan sesi proses debug, gunakan Konsol Debug di debugger panel bawah.
Setelah sesi selesai, Anda dapat menggunakan perintah menu kontekstual berikut:
- Buka Log Deployment: Membuka log aplikasi dari deployment tertentu dengan penjelajah log Cloud Code.
- Open Service URL: Membuka URL layanan aplikasi dari layanan tertentu di browser web
Jika Anda telah menonaktifkan mode tonton dalam konfigurasi peluncuran dan ingin melakukan perubahan pada aplikasi serta membangun ulang dan men-deploy ulang aplikasi, di panel Development session, jeda pada tindakan run, lalu klik Rebuild and redeploy the application.
Untuk mengakhiri sesi proses debug, klik Stop di Toolbar Debug.
Setelah Anda mengakhiri sesi proses debug, semua resource Kubernetes yang di-deploy akan dihapus dari cluster.
Detail konfigurasi
Cloud Code, yang didukung oleh Skaffold, secara otomatis menangani detail konfigurasi berikut untuk semua bahasa yang didukung:
- Port yang meneruskan port debug sehingga debugger dapat dipasang.
- Memasang debugger ke satu atau beberapa penampung yang dapat di-debug dalam aplikasi Anda.
Jika aplikasi Anda memiliki beberapa penampung yang dapat di-debug (penampung yang bahasanya didukung oleh debug Cloud Code) yang dikonfigurasi dalam
skaffold.yaml
, debugger akan dipasang ke setiap penampung yang dapat di-debug. - Mempertahankan definisi pemetaan sumber di seluruh sesi; Anda dapat menyesuaikan definisi ini dengan mengedit file
.vscode/launch.json
secara langsung.
Cloud Code juga menangani detail konfigurasi khusus bahasa berikut:
Node.js
Menulis ulang titik entri yang akan dipanggil:
node --inspect=localhost:9229
Python
Menginstal modul ptvsd
menggunakan Container Init dan menulis ulang titik entri untuk memanggil:
python -m ptvsd --host localhost --port 5678
Go
Menginstal
debugger dlv
menggunakan Penampung Init dan menulis ulang titik entri sehingga sesi debug yang diluncurkan
hanya berjalan dengan server debug (dalam mode headless), akan melanjutkan
proses yang di-debug saat dimulai, menerima beberapa koneksi klien, dan memproses di
localhost:56268
:
dlv exec --headless --continue --accept-multiclient --listen=localhost:56268 --api-version=2, <app> --
Java
Menambahkan lingkungan JAVA_TOOLS_OPTIONS
dengan konfigurasi Java Debug
Wire Protocol (JDWP) yang sesuai sehingga agen proses debug JDWP memproses
koneksi soket pada port 5005 dan memungkinkan VM untuk mulai mengeksekusi
sebelum debugger dipasang:
jdwp=transport=dt_socket,server=y,suspend=n,address=5005,quiet=y
Untuk detail selengkapnya tentang proses debug yang didukung Skaffold, lihat
dokumentasi skaffold debug
.
Siapkan penampung Anda
Guna menyiapkan penampung untuk proses debug, ikuti petunjuk untuk bahasa yang Anda gunakan:
Node.js
- Mulai aplikasi Node.js dengan
--inspect=<debugPort>
yang menggunakandebugPort
dari konfigurasi lampiran. Contoh:CMD ["node", "--inspect=9229", "index.js"]
Python
- Pastikan Anda telah
menginstal modul
ptvsd
di mesin dan di container. - Mulai aplikasi Python melalui
ptvsd
. Cocokkan port yang ditentukan dengan kolomdebugPort
dalam konfigurasi lampirkan. Contoh:CMD ["python", "-m", "ptvsd", "--port", "
" , "app.py"]
Go
- Pastikan Anda telah
menginstal paket
dlv
di komputer dan container Go Anda. Mulai aplikasi Go Anda melalui
dlv debug
.Port yang ditentukan dalam perintah awal harus sama dengan nilai atribut
debugPort
dalam konfigurasi lampirkan. Contoh:CMD ["dlv", "debug", "--headless", "--listen=:<debugPort>", "--log"]
Tips Pemecahan Masalah: Saat men-debug aplikasi Go, aplikasi akan berhenti dan menunggu debugger terpasang. Memasang debugger untuk layanan yang akan dimulai.
Java
- Pastikan JVM diinstal pada komputer Anda.
Mulai aplikasi Java dengan opsi berikut, dengan
debugPort
berasal dari konfigurasi lampiran.-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=
,quiet=y Misalnya, untuk memulai aplikasi Java dalam mode debug dan memproses port
debugPort
untuk koneksi:ENTRYPOINT ["java","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<debugPort>,quiet=y", "-jar", "my-app-1.0.jar"]
.NET Core
Pastikan Anda telah menginstal
vsdbg
, debugger command line .NET Core dari Microsoft, di container Kubernetes.Contoh:
RUN apt-get update
&& apt-get install -y --no-install-recommends unzip
&& apt-get install -y procps
&& rm -rf /var/lib/apt/lists/*
&& curl -sSL https://aka.ms/getvsdbgsh | bash /dev/stdin -v latest -l /dbg/netcore/vsdbg
Siapkan konfigurasi pelampiran Anda
Untuk melampirkan ke penampung yang dapat di-debug, Anda harus memiliki
lampiran konfigurasi
jenis cloudcode.kubernetes
.
Menambahkan file .vscode/launch.json
Jika project Anda tidak memiliki file launch.json
di folder .vscode
-nya, Anda dapat menambahkannya menggunakan panel Debug.
Untuk membuka panel Debug, klik Debug di panel Aktivitas.
Pilih Add Configuration dari menu drop-down.
Pilih Cloud Code: Kubernetes sebagai lingkungan.
Pilih opsi Attach to Kubernetes Pod.
Pilih bahasa pemrograman yang Anda gunakan.
Tindakan ini akan membuat dan membuka file
launch.json
untuk project Anda, serta membuat konfigurasi lampiran untuk Anda.Perbarui atribut konfigurasi dalam file
launch.json
agar cocok dengan atribut project Anda. Untuk informasi selengkapnya tentang atribut konfigurasi, lihat Atribut konfigurasi.
Menambahkan konfigurasi lampiran ke file .vscode/launch.json Anda
Untuk menambahkan konfigurasi lampiran baru ke file .vscode/launch.json
yang ada:
- Buka file
launch.json
. - Untuk memanggil cuplikan Intellisense, klik Add Configuration.
- Untuk menambahkan konfigurasi lampiran, pilih cuplikan Cloud Code: Attach to Kubernetes Pod untuk bahasa yang Anda gunakan.
- Perbarui atribut dalam konfigurasi agar cocok dengan atribut project Anda. Untuk informasi selengkapnya tentang atribut konfigurasi, lihat Atribut konfigurasi.
Atribut konfigurasi
Atribut | Deskripsi |
---|---|
debugPort | Port debug yang digunakan pada penampung. |
podSelector | Kumpulan key-value pair yang digunakan untuk memilih pod debug. Untuk mengetahui informasi
selengkapnya, lihat
panduan tentang pemilih).
Contoh berikut menunjukkan podSelector standar:
"podSelector": {
"app": <deployment-name>
}
|
localRoot | Jalur ke direktori lokal yang berisi program yang sedang di-debug. Default-nya adalah ${workspaceFolder}. |
remoteRoot | Jalur absolut ke direktori jarak jauh yang berisi program yang sedang di-debug (di container Kubernetes). |
Memasang debugger ke pod Kubernetes
Cloud Code untuk Cloud Shell mendukung penyertaan debugger ke pod Kubernetes untuk Node.js, Python, Go, Java, dan .NET. Yang Anda perlukan hanyalah container yang dapat di-debug dan konfigurasi lampiran jenis cloudcode.kubernetes
.
Untuk mengetahui informasi tentang perbedaan antara melampirkan ke pod Kubernetes dan men-debug aplikasi Kubernetes, lihat Perbedaan melampirkan debugger ke pod dengan men-debug aplikasi Kubernetes.
Untuk memasang debugger ke pod Kubernetes, lakukan tugas berikut:
- Untuk membuka panel Debug, klik Debug di panel Aktivitas.
Pilih dan luncurkan konfigurasi dengan menekan
F5
.localhost:${debugPort}
diteruskan melalui port kedebugPort
di penampung saat proses debug.
Sesi proses debug kini berhasil disiapkan. Anda dapat melakukan tugas yang biasa Anda lakukan saat men-debug kode lokal, seperti menyetel titik henti sementara dan melewati kode.
Untuk memeriksa variabel dan info stack, gunakan Sidebar Debug. Untuk berinteraksi dengan sesi proses debug, gunakan Konsol Debug di debugger panel bawah.
Untuk mengakhiri sesi proses debug, klik Stop di Toolbar Debug.
Perbedaan cara memasang debugger ke pod dengan men-debug aplikasi Kubernetes
Melampirkan ke pod Kubernetes | Men-debug aplikasi Kubernetes |
---|---|
Men-debug satu pod Kubernetes. | Men-debug semua container yang dapat di-debug dalam aplikasi. |
Aplikasi harus berjalan di pod Kubernetes sebelum proses debug. | Menjalankan aplikasi di cluster Kubernetes dan memasang debugger. |
Menggunakan konfigurasi (.vscode/launch.json) jenis cloudcode.kubernetes dan meminta attach .
|
Menggunakan konfigurasi (.vscode/launch.json) jenis cloudcode.kubernetes dan meminta launch .Untuk informasi selengkapnya, lihat Konfigurasi peluncuran versus lampirkan. |
Contoh Konfigurasi:
{ "name": "Attach to Kubernetes Pod (NodeJS)", "type": "cloudcode.kubernetes", "request": "attach", "language": "Node", "debugPort": 9229, "podSelector": { "app": "hello-world" }, "localRoot": "${workspaceFolder}", "remoteRoot": "/app" } |
Contoh Konfigurasi:
{ "name": "Run/Debug on Kubernetes", "type": "cloudcode.kubernetes", "request": "launch", "skaffoldConfig": "${workspaceFolder}/skaffold.yaml", "watch": true, "cleanUp": true, "portForward": true } |
Konfigurasi ini tidak dapat digunakan untuk menjalankan aplikasi. | Konfigurasi ini dapat digunakan untuk menjalankan atau men-debug aplikasi. |
Konfigurasi ini spesifik per bahasa. | Konfigurasi ini tidak spesifik bahasa. |
Tidak ada perintah khusus. | Perintah Debug di Kubernetes. |
Langkah selanjutnya
- Gunakan sinkronisasi file dan hot reload untuk mempercepat pengembangan.
- Siapkan lingkungan pengembangan berkelanjutan di Cloud Code.
- Lihat log Kubernetes di Cloud Code.