מעקב אחר ה-API

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

כשיוצרים API, ‏ API Gateway יוצר באופן אוטומטי שירות מנוהל תואם. השם של השירות המנוהל שנוצר מופיע בפלט של הפקודה הבאה:

gcloud api-gateway apis describe API_ID

השם של השירות הוא הערך של השדה managedService.

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

לפני שמתחילים

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

סקירה כללית על ממשקי API

כשמבצעים ניפוי באגים בבעיה בשירות או כשרוצים לוודא שהכול פועל כמו שצריך, עוברים אל דף הסקירה הכללית של ה-API:

  1. במסוף Google Cloud , עוברים לדף API Gateway > APIs של הפרויקט:

    לדף APIs

  2. אם יש לכם יותר מ-API אחד, לוחצים על ה-API שרוצים לעקוב אחריו.

  3. מוודאים שאתם בכרטיסייה סקירה כללית.

גרפים

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

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

טבלת שיטות

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

  • בפינה הימנית העליונה של הטבלה, לוחצים על סמל סינון הטבלה כדי לבחור אפשרויות לסינון מדויק יותר מהטבלה הנפתחת. כדי לחפש כמה מונחים, אפשר להוסיף OR בין שאילתות הסינון.
  • בפינה השמאלית העליונה של הטבלה, לוחצים על הסמל אפשרויות תצוגה של עמודות כדי להציג רשימה נפתחת. מסמנים את המדדים שרוצים לראות ומבטלים את הסימון של המדדים שלא רוצים לראות.
  • בפינה השמאלית העליונה של הדף סקירה כללית, בוחרים טווח זמן לערכי המדדים בטבלה באמצעות בורר טווחי הזמן. הפעולה הזו בוחרת טווח זמן לגרפים ולטבלה.

מדדים

כדי לעקוב אחרי השער, מבצעים את השלבים הבאים:

  1. במסוף Google Cloud , נכנסים לדף Monitoring > Metrics explorer.

    כניסה לדף Metrics Explorer

  2. בחלונית Metric Query Builder, לוחצים על התפריט Select a metric.
  3. בשדה Filter (מסנן), מזינים API Gateway > Proxy > Request Count (שער API > פרוקסי > מספר הבקשות).
  4. לוחצים על אישור.

השאילתה הזו מחזירה נתונים לגבי כל השערים בפרויקט הנוכחי. הנתונים האלה עשויים להיות מקובצים לפי:

  • ‫location: האזור שבו פועל שער.
  • ‫gateway_id: המזהה של שער הנתונים.
  • ‫response_code_class: סיווג קוד התגובה של HTTP‏ (1xx, ‏ 2xx, ‏ 3xx, ‏ 4xx, ‏ 5xx).
  • ‫api_config: השם של משאב API Config שמתארח ב-Gateway.

התרשים בדף Metrics Explorer מתעדכן באופן אוטומטי בהתאם לשאילתה שצוינה. כדי לשמור את התרשים, לוחצים על שמירה בשם ומציינים את מרכז הבקרה שבו רוצים לשמור אותו (או יוצרים מרכז בקרה חדש).

יומנים

אם מזהים בעיה במדדים, אפשר להשתמש בדף Logs Explorer במסוףGoogle Cloud כדי לראות את היומנים של הבקשות והתשובות של ה-API.

  • כדי לראות יומנים של שיטות ספציפיות ב-API, לוחצים על View logs (הצגת יומנים) בטבלה.

  • כדי לראות את היומנים של כל השיטות ב-API, בפינה השמאלית התחתונה לוחצים על הצגת כל היומנים.

  • כדי לאתר יומנים של API Gateway ישירות מהדף Logs Explorer:

    1. נכנסים לדף Logs Explorer במסוף Google Cloud :

      כניסה לדף Logs Explorer

    2. לוחצים על כל המשאבים.

    3. בוחרים באפשרות API Gateway, LOCATION ו-GATEWAY_ID. כאשר LOCATION הוא האזור שבו נפרס המופע של API Gateway, ו-GATEWAY_ID הוא השם של המופע של API Gateway.

    4. לוחצים על אישור.

למידע נוסף על מבנה היומנים ב-Logs Explorer, קראו את המאמר הפניה ליומנים של API Gateway.

מה עוד אפשר לעשות עם היומנים:

  • מתחילים להשתמש ב-Logs Explorer.

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

  • הגדרה וניהול של אובייקטים מסוג sink כך תוכלו להזרים יומנים ל-BigQuery לניתוח נוסף, לשמור את היומנים הגולמיים ב-Cloud Storage או לשלוח אותם לנושאי הודעות ב-Pub/Sub.

סינון לפי פרויקט צרכן ספציפי

כדי לסנן מדדים של פרויקט צרכן ספציפי:

  1. מקבלים את מספר הפרויקט של הפרויקט של צרכן ה-API. אם אין לכם הרשאה לגשת לפרויקט של צרכן ה-API, תוכלו לבקש ממישהו שיש לו הרשאה לקבל את מספר הפרויקט בשבילכם.

  2. במסוף Google Cloud , עוברים לדף API Gateway > APIs בפרויקט.

    לדף APIs

  3. בפינה הימנית העליונה של הדף סקירה כללית, מזינים את מספר הפרויקט בשדה סינון לפי מספר פרויקט.

  4. לוחצים על סינון.

המדדים בדף מתעדכנים כך שיוצגו רק נתוני התנועה מהפרויקט שצוין.

המאמרים הבאים