מעקב אחר השימוש ב-API

בדף הזה מוסבר איך להשתמש במדדי API כדי לעקוב אחרי השימוש שלכם בממשקי Google API ובממשקי Google Cloud API, ולהבין אותו.

ממשקי Google API יוצרים מדדי שימוש מפורטים שיכולים לעזור לכם:

• מעקב אחר השימוש ב-Google APIs והבנתו.
• מעקב אחרי הביצועים של האפליקציות ושל ממשקי ה-API של Google.
• לגלות בעיות בין האפליקציות שלכם לבין Google APIs.

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

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

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

שימוש בלוח הבקרה של ה-API

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

כדי לראות סקירה כללית של השימוש ב-API:

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

   • תנועה: מספר הבקשות לשנייה שבוצעו על ידי הפרויקט או לגביו לממשקי API מופעלים
   • ‫Errors: אחוז הבקשות ל-API מופעלות שהובילו לשגיאות
   • זמן התגובה החציוני: זמן התגובה החציוני לבקשות לממשקי API מופעלים, אם זמין".

הערה: ההרשאה Project Viewer (צפייה בפרויקט) ב-IAM מספיקה כדי להציג את לוח הבקרה הזה.

כדי לראות את פרטי השימוש ב-API ספציפי:

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

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

   • תנועה לפי קוד תגובה
   • שגיאות לפי שיטת API
   • חביון כולל במאון ה-50, במאון ה-95 ובמאון ה-99
   • זמן האחזור לפי שיטת API (חציון)

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

שימוש ב-Cloud Monitoring

אם אתם משתמשים ב-Cloud Monitoring, אתם יכולים להשתמש ב-Metrics Explorer כדי לקבל תובנות מעמיקות יותר לגבי השימוש ב-API. תוכלו להשתמש במגוון רחב של מדדים ב-Cloud Monitoring ולשלב אותם עם מסננים ונתונים נצברים, כדי ליצור תצוגות חדשות שיעזרו לכם להפיק תובנות לגבי ביצועי האפליקציה. לדוגמה, אפשר לשלב בין מדד של מספר הבקשות לבין מסנן של מחלקת קוד התגובה של HTTP כדי ליצור לוח בקרה שמציג את שיעורי השגיאות לאורך זמן, או לבדוק את זמן האחזור של הבקשות ל-Cloud Pub/Sub API באחוזון ה-95.

מדדים זמינים

בטבלה הבאה מפורטים המדדים הזמינים של serviceruntime. מדדי השימוש ב-API הם אלה שכוללים את consumed_api כמשאב שבמעקב.

לפני המחרוזות של 'סוג המדד' בטבלה הזו צריך להוסיף את הקידומת serviceruntime.googleapis.com/. הקידומת הזו הושמטה מהערכים בטבלה. כשמבצעים שאילתה על תווית, משתמשים בקידומת metric.labels.. לדוגמה, metric.labels.LABEL="VALUE".

סוג המדד ^שלב ההשקה (רמות בהיררכיית המשאבים) שם לתצוגה
סוג, יחידה משאבים במעקב	תיאור תוויות
api/request_count ^GA  (project) Request count
DELTA, INT64, 1 api consumed_api produced_api	מספר הבקשות שהושלמו. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות. protocol: הפרוטוקול של הבקשה, לדוגמה, http או grpc. ‫ response_code: קוד תגובת ה-HTTP לבקשות HTTP, או קוד שווה ערך של HTTP לבקשות gRPC. אפשר לראות מיפוי קוד בכתובת https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto. response_code_class: הסיווג של קוד התגובה לבקשות HTTP, או סיווג מקביל של HTTP לבקשות gRPC, לדוגמה: ‎2xx,‏ ‎4xx. ‫ grpc_status_code: קוד התגובה המספרי של gRPC לבקשות gRPC, או קוד מקביל של gRPC לבקשות HTTP. אפשר לראות מיפוי קוד בכתובת https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto.
api/request_latencies ^GA  (project) זמני האחזור של הבקשות
DELTA, DISTRIBUTION, s api consumed_api produced_api	התפלגות של זמני האחזור בשניות לבקשות שאינן סטרימינג. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
api/request_latencies_backend ^GA  (project) בקשה לזמני אחזור של קצה העורפי
DELTA, DISTRIBUTION, s api produced_api	התפלגות של זמן האחזור של השרת העורפי בשניות לבקשות שאינן סטרימינג. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
api/request_latencies_overhead ^GA  (project) Request overhead latencies
DELTA, DISTRIBUTION, s api produced_api	התפלגות של זמן האחזור של הבקשות בשניות, לבקשות שלא כוללות סטרימינג, לא כולל הקצה העורפי. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
api/request_sizes ^GA  (project) Request sizes
DELTA, DISTRIBUTION, By api consumed_api produced_api	התפלגות הגדלים של הבקשות בבייטים שנרשמו בסיום הבקשה. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
api/response_sizes ^GA  (project) Response sizes
DELTA, DISTRIBUTION, By api consumed_api produced_api	התפלגות גדלי התגובות בבייטים שנרשמו בסיום הבקשה. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
mcp/request_count ^בטא  (project) מספר הבקשות של MCP
DELTA, INT64, 1 consumed_mcp_api	מספר הבקשות של MCP. ‫ response_code: קוד תגובת ה-HTTP לבקשות HTTP, או קוד שווה ערך של HTTP לבקשות MCP. response_code_class: הסיווג של קוד התגובה לבקשות HTTP, או סיווג מקביל של HTTP לבקשות gRPC, לדוגמה '2xx',‏ '4xx'.
mcp/request_durations ^בטא  (project) משך בקשת MCP
DELTA, DISTRIBUTION, s consumed_mcp_api	משך הזמן של בקשת ה-MCP מהרגע שהיא נשלחה ועד שהתקבלה התגובה או אישור הקבלה.
quota/allocation/usage ^GA  (project, folder, organization) Allocation quota usage
GAUGE, INT64, 1 consumer_quota producer_quota	מכסת ההקצאה הכוללת שנצרכה. ערכים שמדווחים יותר מפעם אחת בדקה מושמטים. אם לא מתקבלים שינויים בשימוש במכסת הנתונים, הערך האחרון חוזר על עצמו לפחות כל 24 שעות. נדגמים כל 60 שניות. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/concurrent/exceeded ^אלפא  (פרויקט, תיקייה, ארגון) חריגה ממכסת השימוש בו-זמנית
DELTA, INT64, 1 consumer_quota	מספר הפעמים שבהן נעשה ניסיון לחרוג מהמכסה המקבילה. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ time_window: גודל החלון למגבלות של פעולות מקבילות.
quota/concurrent/limit ^אלפא  (פרויקט, תיקייה, ארגון) מכסת שימוש בו-זמני
GAUGE, INT64, 1 consumer_quota producer_quota	המגבלה בו-זמנית של המכסה. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ time_window: גודל החלון למגבלות של פעולות מקבילות.
quota/concurrent/usage ^אלפא  (פרויקט, תיקייה, ארגון) שימוש מקביל במכסה
GAUGE, INT64, 1 consumer_quota producer_quota	השימוש במכסה בו-זמנית. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ time_window: גודל החלון למגבלות של פעולות מקבילות.
quota/exceeded ^GA  (project, folder, organization) Quota exceeded error
GAUGE, BOOL, 1 consumer_quota	השגיאה קרתה כשחורגים ממגבלת המכסה. נדגמים כל 60 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/limit ^GA  (project, folder, organization) Quota limit
GAUGE, INT64, 1 consumer_quota producer_quota	המגבלה של המכסה. נדגם כל 86,400 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/rate/net_usage ^GA  (project, folder, organization) Rate quota usage
DELTA, INT64, 1 consumer_quota producer_quota	מכסת הקצב הכוללת שנצרכה. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 240 שניות. ‫ method: שם שיטת ה-API, כמו 'disks.list'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/ratev2/exceeded ^בטא  (project, folder, organization) Windowed Rate Quota Exceeded
DELTA, INT64, 1 consumer_quota	מספר הפעמים שבהן נעשה ניסיון לחרוג ממכסת קצב הגשת הבקשות המוגבלת בזמן. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולה.
quota/ratev2/limit ^בטא  (project, folder, organization) Windowed Rate Quota limit
GAUGE, INT64, 1 consumer_quota producer_quota	מגבלת התעריף של המכסה בחלון זמן. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. ‫ limit_name: שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולה.
quota/ratev2/net_usage ^בטא  (project, folder, organization) Windowed Rate Quota usage
GAUGE, INT64, 1 consumer_quota producer_quota	שיעור השימוש במכסה בחלון הזמן. הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 240 שניות. ‫ method: שם שיטת ה-API, כמו 'disks.list'. limit_name: השם של מכסת המכסה, כמו RequestsPerDay או InUseIpAddresses. ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולה. ‫ window_start_time: שעת ההתחלה של חלון הזמן.
reserved/metric1 ^EARLY_ACCESS  (project) Deprecated
DELTA, INT64, 1 deprecated_resource	הוּצאה משימוש הדגימה מתבצעת כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות. quota_name: הוצא משימוש. credential_id: הוצא משימוש. quota_location: הוצא משימוש.

הטבלה נוצרה בתאריך 2026-06-24 בשעה 20:26:54 לפי שעון UTC.

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

• יצירת תרשימים
• מבוא בנושא התראות
• ניהול מדיניות ההתראות

מידע נוסף זמין במאמר בנושא Metrics Explorer.

פתרון בעיות באמצעות מדדי API

מדדי API יכולים להיות שימושיים במיוחד אם אתם צריכים לפנות אל Google כשמשהו משתבש, ואולי אפילו יראו לכם שאתם לא צריכים לפנות לתמיכה בכלל. לדוגמה:

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

שיטות מומלצות

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

האם זמן הטעינה גורם לבעיה?

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

חיפוש שינויים מהנורמה

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

יכול להיות שתראו שסוגים מסוימים של בקשות נמשכים יותר זמן מאחרים. אם הגודל החציוני של תמונה שהועלתה ל-Google Photos הוא 4MB, אבל אתם בדרך כלל מעלים קובצי RAW בגודל 20MB, סביר להניח שהזמן הממוצע שלכם להעלאת 20 תמונות יהיה ארוך משמעותית מהזמן של רוב המשתמשים, אבל עדיין יהיה זהה להתנהגות הרגילה שלכם.

כלומר, אין טעם להגדיר התראה על הפעם הראשונה שבה מזוהה קריאת RPC באורך שנייה או קריאת HTTP מסוג 5xx. במקום זאת, כשבודקים אם שירות של Google הוא הגורם האפשרי לבעיה באפליקציה, כדאי להשוות את קודי ההחזרה ואת שיעורי ההשהיה לאורך זמן, ולחפש שינויים מתמשכים מהנורמה שקשורים לבעיות שנצפו באפליקציה.

שיעור תנועת הגולשים

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

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

ממשקי API נתמכים

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