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

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

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

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

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

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

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

הערה: כדי לצפות בלוח הבקרה הזה, מספיקה הרשאת IAM מסוג "צפייה בפרויקט".

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

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

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

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

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

שימוש ב-Cloud Monitoring

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

המדדים הזמינים

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

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

סוג המדד ^שלב ההשקה (רמות היררכיית המשאבים) השם המוצג
סוג, סוג, יחידה משאבים במעקב	תיאור תוויות
api/request_count ^GA  (פרויקט) מספר הבקשות
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  (פרויקט) זמני האחזור של הבקשות
DELTA, DISTRIBUTION, s api consumed_api produced_api	התפלגות זמני האחזור בשניות לבקשות ללא סטרימינג. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 1,800 שניות.
api/request_latencies_backend ^GA  (פרויקט) זמני אחזור של בקשות לקצה העורפי
‫DELTA, DISTRIBUTION, s api produced_api	התפלגות זמני האחזור של בקשות שאינן בסטרימינג, בשניות. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 1,800 שניות.
api/request_latencies_overhead ^GA  (פרויקט) זמני האחזור של התקורה בבקשות
‫DELTA, DISTRIBUTION, s api produced_api	התפלגות זמני האחזור של בקשות בשניות לבקשות ללא סטרימינג, לא כולל הקצה העורפי. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 1,800 שניות.
api/request_sizes ^GA  (פרויקט) גודלי בקשות
DELTA, DISTRIBUTION, By api consumed_api produced_api	התפלגות גודלי הבקשות בבייטים שתועדו בסיום הבקשה. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 1,800 שניות.
api/response_sizes ^GA  (פרויקט) גודלי התגובות
DELTA, DISTRIBUTION, By api consumed_api produced_api	התפלגות גודלי התגובות בבייטים שתועדו בסיום הבקשה. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 1,800 שניות.
mcp/request_count ^GA  (פרויקט) מספר הבקשות ל-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 ^GA  (פרויקט) משך הבקשה ב-MCP
DELTA, DISTRIBUTION, s consumed_mcp_api	משך הזמן של בקשת ה-MCP מהרגע שהיא נשלחה ועד שהתגובה או האישור התקבלו.
quota/allocation/usage ^GA  (פרויקט, תיקייה, ארגון) ניצול מכסת ההקצאה
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 ^ALPHA  (פרויקט, תיקייה, ארגון) שימוש במכסות בו-זמניות
GAUGE, INT64, 1 consumer_quota producer_quota	השימוש במכסה בו-זמנית. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 180 שניות. limit_name: שם המגבלה, למשל "בקשות ליום" או "כתובות IP בשימוש". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ time_window: גודל החלון למגבלות של פעולות בו-זמניות.
quota/exceeded ^GA  (פרויקט, תיקייה, ארגון) שגיאת חריגה מהמכסה
GAUGE, BOOL, 1 consumer_quota	השגיאה קרתה בגלל חריגה ממגבלת המכסה. נדגם כל 60 שניות. limit_name: שם המגבלה, למשל "בקשות ליום" או "כתובות IP בשימוש". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/limit ^GA  (פרויקט, תיקייה, ארגון) מגבלת מכסה
GAUGE, INT64, 1 consumer_quota producer_quota	המגבלה של המכסה. נדגם כל 86,400 שניות. limit_name: שם המגבלה, למשל "בקשות ליום" או "כתובות IP בשימוש". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/rate/net_usage ^GA  (פרויקט, תיקייה, ארגון) שימוש במכסה לקצב הגשת בקשות
DELTA, INT64, 1 consumer_quota producer_quota	מכסת הקצב הכוללת שנוצלה. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 240 שניות. method: שם ה-method של ה-API, למשל "disks.list". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות.
quota/ratev2/exceeded ^בטא  (פרויקט, תיקייה, ארגון) חריגה מהמכסה לקצב הגשת בקשות בחלון זמן נתון
DELTA, INT64, 1 consumer_quota	מספר הפעמים שבהן בוצע ניסיון לחרוג מהמכסה לקצב הגשת בקשות בחלון זמן. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 180 שניות. limit_name: שם המגבלה, למשל "בקשות ליום" או "כתובות IP בשימוש". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולות.
quota/ratev2/limit ^בטא  (פרויקט, תיקייה, ארגון) מגבלת המכסה לקצב הגשת בקשות בחלון זמן
GAUGE, INT64, 1 consumer_quota producer_quota	מגבלת הקצב ליצירת בקשות בחלון הזמן של המכסה. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 180 שניות. limit_name: שם המגבלה, למשל "בקשות ליום" או "כתובות IP בשימוש". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולות.
quota/ratev2/net_usage ^בטא  (פרויקט, תיקייה, ארגון) שימוש במכסה לקצב הגשת בקשות בחלון זמן
GAUGE, INT64, 1 consumer_quota producer_quota	השימוש במכסה לפי חלון זמן. נדגם כל 60 שניות. אחרי הדגימה, הנתונים לא מוצגים במשך עד 240 שניות. method: שם ה-method של ה-API, למשל "disks.list". limit_name: שם מגבלת המכסה, כמו "RequestsPerDay" או "InUseIpAddresses". ‫ quota_metric: השם של מדד המכסה או של קבוצת המכסות. ‫ window_size: גודל החלון של מגבלות קצב הפעולות. window_start_time: שעת ההתחלה של החלון.

הטבלה נוצרה ב-22 באוקטובר 2026 בשעה 02:44:18 לפי שעון UTC.

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

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

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

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

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

• אם כל הקריאות לשירות נכשלות במזהה פרטי כניסה אחד, אבל לא באחרים, סביר להניח שיש בעיה בחשבון הזה שאפשר לתקן בקלות בלי לפתוח כרטיס תמיכה.
• אתם פותרים בעיה באפליקציה, ומבחינים בקורלציה בין הביצועים הירודים של האפליקציה לבין עלייה מתמשכת בזמן האחזור באחוזון ה-50 של שירות 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 נתמכים

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