Melakukan pemeriksaan kesehatan

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Apigee Edge dokumentasi.

Apigee mendukung dua pendekatan health check. Pendekatan 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 memeriksa salah satu /healthz/* endpoint untuk menentukan kondisi instance / lingkungan, dan load balancer melakukan failover antar-region. Jika arsitektur Anda menggunakan MIG, terus gunakan health check aktif.
• Health check PSC: Untuk arsitektur yang merutekan traffic klien ke Apigee melalui Private Service Connect (PSC). Apigee memantau instance regional untuk Anda dan memperbarui status kondisi per region secara otomatis. Tidak diperlukan pemeriksaan yang dimulai oleh klien atau load balancer. Jika arsitektur Anda menggunakan PSC, ikut serta dalam PSC health check.

Pilih tab untuk mempelajari lebih lanjut.

Health check aktif

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

1. Health check level regional / instance Apigee: Menampilkan kondisi keseluruhan instance Apigee di suatu region.
2. Health check level 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 level regional

Apigee menawarkan health check level 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 kondisi instance Apigee dan melakukan failover regional. Anda dapat melakukan health check level 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 dilayani oleh load balancer.

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

Melakukan health check level lingkungan

Apigee menawarkan health check level lingkungan untuk menilai kondisi lingkungan tertentu yang dilayani 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 level lingkungan dengan memanggil proxy API yang valid di lingkungan dengan membuat permintaan sebagai berikut:

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

Misalnya, asumsikan bahwa /catalog adalah basepath proxy yang valid dan 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 dilayani oleh load balancer.

Catatan: Panggilan proxy API ini untuk menentukan health check level lingkungan tidak akan menjalankan proxy, dan tidak akan dihitung terhadap penggunaan Apigee Anda secara keseluruhan. Basepath /catalog hanya digunakan untuk merutekan API ke lingkungan yang benar. Jika lingkungan responsif, 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 dapat membuat health check gagal saat beberapa lingkungan tidak berfungsi. Atau, Anda dapat membuat health check gagal berdasarkan kondisi atau latensi target.

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

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

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

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

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

Catatan penggunaan

Untuk health check level regional dan level 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 ditetapkan.

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

Health check PSC

Pratinjau — Konektor BigQuery

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 memiliki beberapa instance Apigee di beberapa region, Anda dapat ikut serta dalam health check PSC sehingga traffic otomatis melakukan failover ke region yang responsif saat instance Apigee di region aktif menjadi tidak responsif. Tidak diperlukan permintaan dari klien atau load balancer untuk memicu pemeriksaan. Google Cloud memantau instance secara terus-menerus atas nama Anda dan memperbarui status kondisi 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 bayar sesuai penggunaan atau Langganan.
• Organisasi Anda memiliki dua atau lebih instance Apigee, masing-masing di region yang berbeda Google Cloud .
• 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 berpindah antar-region.

Cara mengaktifkan

Health check PSC adalah fitur keikutsertaan yang dikelola oleh Google. Untuk meminta pengaktifan bagi organisasi Anda, hubungi tim akun Apigee 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 secara langsung , sebaiknya uji fitur ini di lingkungan Apigee non-produksi sebelum mengaktifkannya untuk organisasi produksi Anda. Pastikan failover dan pemulihan berperilaku seperti yang diharapkan untuk pola traffic API Anda dan aplikasi klien Anda menangani transisi secara transparan.

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

Cara kerja failover

Saat 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 ke aplikasi klien Anda.

Penting: Failover bersifat langsung 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 ikut serta.

Batasan saat ini

• Health check PSC saat ini hanya mendeteksi pemadaman infrastruktur regional yang lengkap. Fitur ini tidak dipicu pada insiden saat traffic masih dapat mengalir, meskipun traffic mengalami penurunan dalam tingkat error atau latensi. Health check level 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 Google Cloud project 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 region, lihat kolom healthState pada entri log yang cocok. Nilai HEALTHY menunjukkan bahwa instance Apigee di region tersebut dapat dijangkau dan melayani traffic. Nilai lain menunjukkan bahwa health check PSC saat ini tidak merutekan traffic ke region tersebut.

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