מעקב אחר השימוש ב-API
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מוסבר איך להשתמש במדדי API כדי לעקוב אחרי השימוש שלכם ב-Google APIs וב-Cloud APIs, ולהבין אותו.
ממשקי Google APIs יוצרים מדדי שימוש מפורטים שיכולים לעזור לכם:
מעקב אחר השימוש ב-Google APIs והבנתו.
מעקב אחרי הביצועים של האפליקציות ושל Google APIs.
לגלות בעיות בין האפליקציות שלכם לבין Google APIs.
היא יכולה לקצר משמעותית את זמני הפתרון כשמנסים לפתור בעיות או כשזקוקים לתמיכה טכנית מ-Google.
המדדים שממשקי Google API יוצרים הם האותות הסטנדרטיים שמהנדסי אמינות האתרים של Google משתמשים בהם כדי להעריך את תקינות השירות.
המדדים האלה כוללים את מספר הבקשות, שיעורי השגיאות, זמן האחזור הכולל, זמן האחזור של ה-Backend, גודל הבקשה וגודל התגובה. הגדרות המדדים של ה-API מופיעות במאמרי העזרה של Cloud Monitoring.
אפשר לראות את מדדי ה-API בשני מקומות: מרכז הבקרה של ה-API ו-Cloud Monitoring. המדדים שמוצגים הם ספציפיים לפרויקט שלכם, והם לא משקפים את הסטטוס הכולל של השירות.
שימוש בלוח הבקרה של ה-API
הדרך הפשוטה ביותר לראות את מדדי ה-API היא באמצעות מרכז הבקרה של ה-API במסוף Google Cloud. אתם יכולים לראות סקירה כללית של כל השימוש שלכם ב-API, או להציג את השימוש שלכם ב-API ספציפי.
כדי לראות סקירה כללית של השימוש ב-API:
נכנסים לקטע APIs and Services במסוף Cloud.
לוח הבקרה הראשי של ה-API מוצג כברירת מחדל. בדף הזה אפשר לראות את כל ממשקי ה-API שמופעלים כרגע בפרויקט, וגם תרשימי סקירה כללית של המדדים הבאים:
תנועה: מספר הבקשות לשנייה שבוצעו על ידי הפרויקט או לגביו לממשקי API מופעלים
Errors: אחוז הבקשות ל-API מופעלות שהובילו לשגיאות
זמן התגובה החציוני: זמן התגובה החציוני לבקשות לממשקי API מופעלים, אם זמין".
כדי לראות את פרטי השימוש ב-API ספציפי:
בוחרים את ה-API שרוצים לראות ברשימת ממשקי ה-API הראשית במרכז הבקרה של ה-API.
בדף 'סקירה כללית' של ה-API מוצג תרשים תנועה מפורט יותר עם פירוט לפי קוד תגובה.
כדי לראות פרטים נוספים על השימוש, בוחרים באפשרות הצגת מדדים.
כברירת מחדל, מוצגים התרשימים המוכנים מראש הבאים, אבל יש עוד:
תנועה לפי קוד תגובה
שגיאות לפי שיטת API
חביון כולל במאון ה-50, במאון ה-95 ובמאון ה-99
זמן האחזור לפי שיטת API (חציון)
אם רוצים להוסיף עוד תרשימים, אפשר לבחור תרשימים מוכנים מראש נוספים מהתפריט הנפתח בחירת תרשימים.
שימוש ב-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".
סוג המדד שלב ההשקה(רמות בהיררכיית המשאבים) שם לתצוגה
מספר הבקשות שהושלמו. נדגמים כל 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_latenciesGA(project) זמני האחזור של הבקשות
התפלגות של זמן האחזור של הבקשות בשניות, לבקשות שלא כוללות סטרימינג, לא כולל הקצה העורפי. נדגמים כל 60 שניות. אחרי הדגימה, הנתונים לא גלויים למשך עד 1,800 שניות.
מספר הבקשות של MCP.
response_code:
קוד תגובת ה-HTTP לבקשות HTTP, או קוד שווה ערך של HTTP לבקשות MCP.
response_code_class:
הסיווג של קוד התגובה לבקשות HTTP, או סיווג מקביל של HTTP לבקשות gRPC, למשל '2xx', '4xx'.
מכסת ההקצאה הכוללת שנצרכה. ערכים שמדווחים יותר מפעם אחת בדקה מושמטים. אם לא מתקבלים שינויים בשימוש במכסת הנתונים, הערך האחרון חוזר על עצמו לפחות כל 24 שעות. נדגמים כל 60 שניות.
quota_metric:
השם של מדד המכסה או של קבוצת המכסות.
quota/concurrent/exceededאלפא(פרויקט, תיקייה, ארגון) חריגה ממכסת השימוש בו-זמנית
מספר הפעמים שבהן נעשה ניסיון לחרוג מהמכסה המקבילה. נדגם כל 86,400 שניות. אחרי הדגימה, הנתונים לא מוצגים למשך עד 180 שניות.
limit_name:
שם מכסת השימוש, כמו 'בקשות ליום' או 'כתובות IP בשימוש'.
quota_metric:
השם של מדד המכסה או של קבוצת המכסות.
time_window:
גודל החלון למגבלות של פעולות מקבילות.
