ביצוע בדיקות תקינות

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

‫Apigee חושף בדיקות תקינות ברמות שונות, שאפשר להשתמש בהן בהתאם לתרחיש השימוש.

  1. בדיקת תקינות ברמת האזור או ברמת מופע Apigee: מחזירה את התקינות של מופע Apigee כולל באזור מסוים.
  2. בדיקות תקינות ברמת הסביבה: מחזירה את התקינות של סביבה מסוימת במופע Apigee.
  3. בדיקת תקינות מותאמת אישית דרך proxy ל-API: בתרחישי שימוש מורכבים, אפשר להגדיר proxy ל-API ייעודי כנקודת קצה מותאמת אישית לבדיקת תקינות.

ביצוע בדיקת תקינות ברמה אזורית

‫Apigee מציע בדיקת תקינות ברמת האזור או ברמת מופע Apigee, כדי להעריך את סטטוס התקינות הכולל של מופע Apigee באזור ספציפי. דפוס בדיקת התקינות הזה, שנמצא בשימוש נרחב במאזני עומסים, קובע את סטטוס התקינות של מופעי Apigee ומבצע יתירות כשל אזורית. כדי לבצע בדיקת תקינות ברמת האזור, צריך ליצור את הבקשה באופן הבא:

  • נתיב בדיקת תקינות: /healthz/ingress
  • הוספת כותרת בקשה: User-Agent: GoogleHC.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress
Apigee Ingress is healthy
כאשר $HOST מייצג את שם המארח שמוגדר בקבוצת סביבות Apigee שמטופלת על ידי מאזן העומסים.

ביצוע בדיקת תקינות ברמת הסביבה

‫Apigee מציע בדיקת תקינות ברמת הסביבה כדי להעריך את התקינות של סביבה מסוימת שמוגשת על ידי מופע Apigee. מומלץ להשתמש בדפוס הזה של בדיקת תקינות כשרוצים לבצע יתירות כשל אזורית על סמך התקינות של סביבות קריטיות או סלקטיביות מסוימות. כדי לבצע בדיקת תקינות ברמת הסביבה, צריך לקרוא לכל proxy ל-API תקף בסביבה. לשם כך, צריך ליצור את הבקשה באופן הבא:

  • מוסיפים /healthz/ בתחילת נתיב הבסיס של ה-Proxy.
  • הוספת כותרת בקשה: User-Agent: GoogleHC.

לדוגמה, נניח ש-/catalog הוא נתיב בסיס תקין של שרת proxy שנפרס בסביבה. כדי לבצע בדיקת תקינות, קוראים לשרת ה-proxy כך:

$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog
Server Ready
כאשר $HOST מייצג את שם המארח שמוגדר בקבוצת סביבות Apigee שמטופלת על ידי מאזן העומסים.

ביצוע בדיקת תקינות בהתאמה אישית באמצעות proxy ל-API

אם רוצים לבצע אימותים נוספים, אפשר להגדיר לוגיקה מותאמת אישית לבדיקת תקינות ב-proxy ל-API שנפרס בסביבה. לדוגמה, יכול להיות שהבדיקה תכשל אם כמה סביבות לא פעילות. או שהבדיקה תכשל על סמך בריאות היעד או זמן האחזור.

במקרה כזה, אפשר לבצע את בדיקת התקינות על ידי ביצוע קריאה רגילה ל-API של השרת הפרוקסי.

לדוגמה, נניח שרוצים לבדוק את תקינות הסביבה שנקראת prod. פורסים proxy ל-API בסביבה הזו עם נתיב בסיס /healthcheck-prod. כדי לבדוק את תקינות הסביבה prod שמוצגת על ידי מופע Apigee, קוראים ל-proxy כך:

$ curl https://$HOST/healthcheck-prod
כאשר $HOST מייצג את שם המארח שמוגדר בקבוצת הסביבות של Apigee שמשרת מאזן העומסים.

הערות שימוש

לביצוע בדיקות תקינות ברמת האזור וברמת הסביבה: אם הבדיקות מבוצעות על ידי מאזני העומסים של Google Cloud, מאזן העומסים מגדיר את הכותרת הנכונה של User-Agent. אם הלקוח שלכם צורך את קריאות ה-API האלה של בדיקות התקינות, אתם צריכים לוודא שהכותרת הנכונה של User-Agent מוגדרת.

ב-Apigee Hybrid: התכונה של בדיקת התקינות זמינה רק בגרסה 1.4 ומעלה.