Melakukan health check

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Apigee mengekspos health check di berbagai tingkat, yang dapat Anda manfaatkan bergantung pada kasus penggunaan.

1. Health check instance Apigee / level regional: Menampilkan kondisi keseluruhan instance Apigee di sebuah region.
2. Health tingkat lingkungan: Menampilkan kondisi lingkungan tertentu dalam 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 membuat 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 mewakili nama host yang ditentukan dalam grup lingkungan Apigee yang disalurkan oleh load balancer.

Catatan: Panggilan API untuk menentukan health check tingkat regional ini tidak akan diperhitungkan terhadap penggunaan Apigee Anda 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 kesehatan lingkungan tertentu yang disalurkan oleh instance Apigee. Pola health check ini lebih disukai jika Anda ingin melakukan failover regional berdasarkan kondisi lingkungan kritis/selektif tertentu. Anda dapat menjalankan health check tingkat lingkungan dengan memanggil proxy API yang valid di suatu lingkungan dengan membuat permintaan sebagai berikut:

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

Misalnya, asumsikan /catalog adalah jalur dasar proxy yang 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 mewakili nama host yang ditentukan dalam grup lingkungan Apigee yang disalurkan oleh load balancer.

Catatan: Panggilan API proxy ini untuk menentukan health check tingkat lingkungan tidak akan menjalankan proxy, dan tidak akan diperhitungkan terhadap penggunaan Apigee Anda secara keseluruhan. /catalog basepath hanya digunakan untuk mengarahkan API ke lingkungan yang benar. Jika lingkungan tersebut sehat, 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 suatu lingkungan. Misalnya, Anda mungkin gagal dalam healthcheck saat beberapa lingkungan tidak berfungsi. Atau, Anda dapat menggagalkan health check berdasarkan kondisi atau latensi target.

Dalam hal ini, Anda dapat melakukan health check dengan melakukan panggilan API biasa ke proxy tersebut.

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

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

dengan, $HOST mewakili nama host yang ditentukan dalam grup lingkungan Apigee yang disalurkan oleh load balancer.

Catatan: Panggilan API dengan health check kustom akan dihitung dalam keseluruhan penggunaan Apigee Anda. 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 menetapkan header User-Agent yang benar. Jika klien Anda 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 baru.