Melakukan pemeriksaan kesehatan

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Apigee mendukung dua pendekatan health check. Yang tepat untuk Anda bergantung pada cara traffic klien mencapai Apigee.

• Health check aktif: Untuk arsitektur yang merutekan traffic klien ke Apigee melalui Google Cloud load balancer yang didukung oleh grup instance terkelola (MIG). Load balancer (atau klien Anda) secara aktif menyelidiki salah satu endpoint /healthz/* untuk menentukan kesehatan instance / lingkungan, dan load balancer melakukan failover antar-region. Jika arsitektur Anda menggunakan MIG, terus gunakan health check aktif.
• Pemeriksaan kondisi PSC: Untuk arsitektur yang merutekan traffic klien ke Apigee melalui Private Service Connect (PSC). Apigee memantau instance regional untuk Anda dan memperbarui status respons per region secara otomatis. Tidak diperlukan probe yang dimulai oleh klien atau load balancer. Jika arsitektur Anda menggunakan PSC, aktifkan health check PSC.

Pilih tab untuk mempelajari lebih lanjut.

Pemeriksaan kualitas aktif

Apigee mengekspos pemeriksaan kesehatan aktif di berbagai tingkat, yang dapat Anda manfaatkan bergantung pada kasus penggunaan.

1. Pemeriksaan kondisi tingkat regional / instance Apigee: Menampilkan kondisi instance Apigee secara keseluruhan di suatu region.
2. Health check tingkat lingkungan: Menampilkan kondisi lingkungan tertentu di instance Apigee.
3. Health check kustom melalui proxy API: Untuk kasus penggunaan yang kompleks, Anda dapat mengonfigurasi proxy API khusus sebagai endpoint health check kustom.

Melakukan health check tingkat regional

Apigee menawarkan health check tingkat regional / instance Apigee untuk menilai status kondisi keseluruhan instance Apigee di region tertentu. Pola health check ini, yang banyak digunakan oleh load balancer, menentukan status respons instance Apigee dan melakukan failover regional. Anda dapat melakukan health check tingkat regional dengan menyusun permintaan sebagai berikut:

• Jalur health check: /healthz/ingress
• Tambahkan header permintaan: User-Agent: GoogleHC.

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy

dengan $HOST adalah nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

Catatan: Panggilan API ini untuk menentukan health check tingkat regional tidak akan dihitung dalam penggunaan Apigee secara keseluruhan. Jika instance Apigee responsif, respons "HTTP/2 200" dengan "Apigee Ingress is healthy" akan ditampilkan.

Melakukan health check tingkat lingkungan

Apigee menawarkan health check tingkat lingkungan untuk menilai kondisi lingkungan tertentu yang ditayangkan oleh instance Apigee. Pola health check ini lebih disukai jika Anda ingin melakukan failover regional berdasarkan kondisi lingkungan penting/selektif tertentu. Anda dapat melakukan health check tingkat lingkungan dengan memanggil proxy API yang valid di lingkungan dengan membuat permintaan sebagai berikut:

• Awali dengan /healthz/ ke basepath proxy.
• Tambahkan header permintaan: User-Agent: GoogleHC.

Misalnya, asumsikan bahwa /catalog adalah basepath proxy valid yang di-deploy di lingkungan. Untuk melakukan health check, panggil proxy seperti ini:

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready

dengan $HOST adalah nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

Catatan: Panggilan API proxy ini untuk menentukan health check tingkat lingkungan tidak akan mengeksekusi proxy, dan tidak akan dihitung terhadap penggunaan Apigee secara keseluruhan. Basepath /catalog hanya digunakan untuk merutekan API ke lingkungan yang benar. Jika lingkungan dalam kondisi baik, respons "HTTP/2 200" dengan "Server Ready" akan ditampilkan.

Melakukan health check kustom melalui proxy API

Jika ingin melakukan validasi tambahan, Anda dapat menentukan logika health check kustom di proxy API yang di-deploy ke lingkungan. Misalnya, Anda mungkin gagal melakukan pemeriksaan kondisi saat beberapa lingkungan tidak berfungsi. Atau, Anda dapat menggagalkan health check berdasarkan kondisi atau latensi target.

Dalam hal ini, Anda dapat melakukan pemeriksaan kondisi dengan melakukan panggilan API reguler ke proxy tersebut.

Misalnya, asumsikan bahwa Anda ingin memeriksa kondisi lingkungan yang disebut prod. Deploy proxy API ke lingkungan tersebut dengan basepath /healthcheck-prod. Untuk memeriksa kualitas lingkungan prod yang ditayangkan oleh instance Apigee, panggil proxy seperti ini:

$ curl https://$HOST/healthcheck-prod

dengan $HOST adalah nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

Catatan: Panggilan API dengan pemeriksaan kesehatan kustom akan dihitung berdasarkan penggunaan Apigee Anda secara keseluruhan. Selain itu, Anda tidak perlu memberikan header "User-Agent".

Catatan penggunaan

Untuk health check tingkat regional dan tingkat lingkungan: Jika dilakukan oleh load balancer Google Cloud, load balancer akan menetapkan header User-Agent yang benar. Jika klien Anda sendiri menggunakan panggilan API health check ini, Anda harus memastikan User-Agent yang benar telah ditetapkan.

Untuk Apigee Hybrid: Fitur health check hanya tersedia untuk versi 1.4 dan yang lebih tinggi.

Pemeriksaan kondisi PSC

Pratinjau — BigQuery Connector

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dari Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Apigee mendukung health check dengan Private Service Connect (PSC), yang memungkinkan failover lintas region otomatis untuk deployment multi-region. Jika Anda memiliki beberapa instance Apigee di beberapa region, Anda dapat memilih untuk mengaktifkan health check PSC sehingga traffic otomatis di-failover ke region yang responsif saat instance Apigee di region aktif menjadi tidak responsif. Tidak ada permintaan dari klien atau load balancer Anda yang diperlukan untuk memicu pemeriksaan. Google Cloud memantau instance secara terus-menerus atas nama Anda dan memperbarui status respons secara otomatis.

Fitur health check PSC dikonfigurasi di backend Apigee. Anda tidak perlu men-deploy resource tambahan, menulis kode, atau mengubah proxy API.

Prasyarat

• Anda memiliki organisasi Apigee dengan model Bayar sesuai penggunaan atau Langganan.
• Organisasi Anda memiliki dua atau lebih instance Apigee, yang masing-masing berada di region Google Cloud yang berbeda.
• Traffic klien Anda mencapai Apigee melalui Private Service Connect (PSC).
• Setiap lingkungan, grup lingkungan, proxy API, alur bersama, dan resource di-deploy secara identik di semua instance Apigee yang berpartisipasi dalam failover. Deployment yang tidak konsisten dapat menyebabkan perilaku yang tidak terduga saat traffic dialihkan antar-region.

Cara mengaktifkan

Pemeriksaan kondisi PSC adalah fitur keikutsertaan yang dikelola oleh Google. Untuk meminta pengaktifan bagi organisasi Anda, hubungi tim akun Apigee Anda atau Dukungan Apigee. Jika diaktifkan, failover regional otomatis akan aktif untuk semua instance di organisasi Anda. Tidak diperlukan konfigurasi lebih lanjut.

Rekomendasi pengujian

Karena health check PSC memperkenalkan failover regional otomatis dan langsung yang memengaruhi perutean traffic, sebaiknya Anda menguji fitur ini di lingkungan Apigee non-produksi sebelum mengaktifkannya untuk organisasi produksi Anda. Verifikasi bahwa failover dan pemulihan berperilaku seperti yang diharapkan untuk pola traffic API Anda dan bahwa aplikasi klien Anda menangani transisi secara transparan.

Untuk menyimulasikan skenario failover dan memvalidasi penyiapan Anda, hubungi tim akun Apigee Anda atau Dukungan Apigee. Tim dapat membantu Anda memicu kondisi kegagalan di lingkungan yang terkontrol sehingga Anda dapat mengamati perilaku failover sebelum mengaktifkan fitur di produksi.

Cara kerja failover

Jika health check PSC menentukan bahwa instance Apigee di region aktif Anda tidak responsif, traffic klien akan segera dan otomatis dirutekan ke instance Apigee yang responsif di region lain. Saat instance yang tidak responsif pulih, traffic akan kembali ke region asli. Failover dan pemulihan terjadi secara transparan pada aplikasi klien Anda.

Penting: Failover akan segera dan otomatis setelah health check PSC diaktifkan. Tidak ada penundaan atau tombol yang dapat dikonfigurasi untuk mengontrol waktu failover. Jika instance Apigee di suatu region menjadi tidak responsif, Google Cloud load balancer akan berhenti merutekan traffic ke region tersebut tanpa intervensi tambahan. Pastikan arsitektur Anda mendukung perutean traffic lintas region sebelum memilih untuk mengaktifkannya.

Batasan saat ini

• Health check PSC saat ini hanya mendeteksi gangguan infrastruktur regional yang lengkap. tidak dipicu pada insiden saat traffic masih dapat mengalir, meskipun traffic mengalami penurunan kualitas dalam tingkat error atau latensi. Pemeriksaan kesehatan tingkat komponen yang lebih luas direncanakan untuk rilis mendatang.

Memverifikasi status kondisi di Cloud Logging

Anda dapat mengamati peristiwa status kondisi per region untuk instance Apigee di Cloud Logging. Di Logs Explorer untuk project Google Cloud yang menghosting organisasi Apigee Anda, jalankan filter berikut:

resource.type="compute.googleapis.com/NetworkEndpointGroupV2"

Untuk mengetahui informasi selengkapnya, lihat Memantau log health check gabungan.

Untuk setiap wilayah, lihat kolom healthState pada entri log yang cocok. Nilai HEALTHY menunjukkan bahwa instance Apigee di region tersebut dapat dijangkau dan melayani traffic. Nilai lainnya menunjukkan bahwa pemeriksaan kondisi PSC saat ini tidak merutekan traffic ke region tersebut.

Catatan: Pemeriksaan kondisi PSC tidak menggunakan kuota panggilan Apigee API Anda dan tidak dihitung dalam penggunaan Apigee secara keseluruhan. Untuk mengetahui detailnya, lihat dokumentasi batasan health check gabungan dan Persyaratan Khusus Layanan.