Melakukan pemeriksaan kesehatan

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 penggunaannya.

  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 responsif secara 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 merepresentasikan nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

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 pemeriksaan kualitas, panggil proxy seperti ini: 

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
 dengan $HOST merepresentasikan nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

Melakukan pemeriksaan kesehatan 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 kesehatan 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 reguler ke proxy tersebut.

Misalnya, anggaplah 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 merepresentasikan nama host yang ditentukan dalam grup lingkungan Apigee yang ditayangkan oleh load balancer.

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.