מעקב אחר ה-API

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

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

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

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

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

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

    לדף Endpoints Services

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

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

גרפים

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

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

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

טבלת שיטות

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

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

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

יומנים

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

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

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

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

    1. במסוף Google Cloud , נכנסים לדף Stackdriver > Logging:

      כניסה לדף Logs Explorer

    2. בוחרים באפשרות Produced API, SERVICE_NAME, כאשר SERVICE_NAME הוא השם של שירות Endpoints.

פרטים על מבנה היומנים ב-Logs Explorer מופיעים במאמר הפניה ליומני נקודות קצה.

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

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

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

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

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

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

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

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

  2. במסוף Google Cloud , עוברים לדף Endpoints > Services של הפרויקט.

    לדף Endpoints Services

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

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

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

שליחת התראות

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

כדי להגדיר התראות:

  1. במסוף Google Cloud , בוחרים את Google Cloud הפרויקט עם ה-API שבפיקוח של Endpoints שמשויך לחשבון.

    כניסה למסוף Google Cloud

  2. בחלונית הניווט, בוחרים באפשרות Monitoring.

  3. יוצרים מדיניות התראות כדי להגדיר התראות לאותות הזהב באמצעות:

    • זמן אחזור

      1. בשדה Condition Type, מזינים Metric Threshold.
      2. בשדה Resource Type, מזינים Produced API.
      3. במדד, מזינים Request latencies.
      4. מזינים את ערך הסף שרוצים לקבל עליו התראה ופועלים לפי שאר ההוראות במדריך בנושא התראות.

    • תעבורת נתונים

      1. בשדה Condition Type, מזינים Metric Threshold.
      2. בשדה Resource Type, מזינים Produced API.
      3. במדד, מזינים Request count.
      4. מזינים את ערך הסף שרוצים לקבל עליו התראה ופועלים לפי שאר ההוראות במדריך בנושא התראות.

    • שגיאות

      1. בשדה Condition Type, מזינים Metric Threshold.
      2. בשדה Resource Type, מזינים Produced API.
      3. במדד, מזינים Request count.
      4. בשדה response-code-class, מזינים 5xx.
      5. מזינים את ערך הסף שרוצים לקבל עליו התראה ופועלים לפי שאר ההוראות במדריך בנושא התראות.

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