כשמשתמשים שולחים בקשות ל-API שלכם, Extensible Service Proxy (ESP) משתמש ב-Cloud Logging כדי לרשום ביומן מידע על הבקשות והתשובות. בדף הזה מתואר המידע שמתועד ביומן.
כדי לאתר יומנים של Cloud Endpoints בדף Logs Explorer:
במסוף Google Cloud , נכנסים לדף Operations > Logging:
בוחרים באפשרות Produced API,
SERVICE_NAME, כאשרSERVICE_NAMEהוא השם של שירות Endpoints.לוחצים על היומן שרוצים לבדוק. היומן מכיל הודעה מובנית בפורמט JSON, כמו ההודעה הבאה:
{ insertId: "…" jsonPayload: {…} resource: { type: "api" labels: {…} } timestamp: "2017-05-08T15:00:02.804424422Z" severity: "INFO" logName: "…" }
אובייקט jsonPayload מכיל את כל המידע שדווח על ידי ESP. בטבלה הבאה מתוארים השדות:
| שדה | תיאור |
|---|---|
url |
נתיב כתובת ה-URL של הבקשה. |
producer_project_id |
מזהה הפרויקט של ה-API.Google Cloud |
api_name |
שם ה-API שהופעל. |
api_version |
הגרסה של ה-API שנקרא. |
api_method |
השיטה של ה-API שנקראת. |
api_key |
מפתח ה-API שבו משתמש הצרכן שקורא ל-API, אם קיים. |
http_method |
ה-method של ה-HTTP של הבקשה, כמו GET ו-POST. |
request_size_in_bytes |
גודל גוף הבקשה בבייטים. |
http_response_code |
קוד סטטוס HTTP של התגובה, כמו 200, 404 ו-500. |
response_size_in_bytes |
גודל גוף התשובה בבייטים. |
request_latency_in_ms |
הזמן שלקח להגיב לבקשה באלפיות השנייה, כולל הזמן שלקח ל-ESP ולחלק האחורי שלו. לא מופיע בשיטות סטרימינג. |
timestamp |
חותמת הזמן של קבלת הבקשה. |
location |
Google Cloud zone שטיפל בבקשה. |
log_message |
הודעה קצרה על השיטה שנקראה והסטטוס שלה אם היא נדחתה. לא מתבצעת רישום ביומן של שדות מידע של API עבור קריאות שנדחו. |
error_cause |
הודעת שגיאה אם התשובה הייתה שגיאה. |
labels |
הקטע labels מכיל מידע שמזהה את המקור של היומן, כמו מזהה הפרויקט Google Cloud , שם השירות של Endpoints, מספר גרסת ה-API ושם השיטה. |