במאמר הזה נסביר על הקונספט של רישום ביומן במבנה מוגדר ועל השיטות להוספת מבנה לשדות של מטען ייעודי (payload) של רשומות ביומן. כשמטען ייעודי של יומן מעוצב כאובייקט JSON והאובייקט הזה מאוחסן בשדה jsonPayload, רשומת היומן נקראת יומן מובנה. ביומנים האלה אפשר ליצור שאילתות שמחפשות נתיבי JSON ספציפיים, ולבצע אינדוקס של שדות ספציפיים במטען הייעודי (payload) של היומן. לעומת זאת, אם מטען הייעודי (payload) של היומן מעוצב כמחרוזת ומאוחסן בשדה textPayload, רשומת היומן היא לא מובנית.
אפשר לחפש בשדה הטקסט, אבל אי אפשר ליצור אינדקס של התוכן שלו.
כדי ליצור רשומות יומן מובנות, אפשר לבצע אחת מהפעולות הבאות:
- קוראים לשיטת ה-API
entries.writeומספקיםLogEntryבפורמט מלא. - משתמשים בפקודה
gcloud logging write.
- שימוש בספריית לקוח של Cloud Logging שכותבת יומנים מובנים.
בסעיפים הבאים יש מידע נוסף על הגישות האלה.
כתיבת יומנים באמצעות ספריות לקוח או ה-API
אפשר לכתוב נתוני יומנים באמצעות ספריות הלקוח של Cloud Logging, שקוראות ל-Cloud Logging API, או באמצעות קריאה ישירה ל-Cloud Logging API.
ספריות לקוח יכולות לפשט את האכלוס של שדות ה-JSON המיוחדים על ידי תיעוד אוטומטי של חלק מהמידע ועל ידי מתן ממשקים לאכלוס השדות בצורה מתאימה. עם זאת, כדי לקבל שליטה מלאה במבנה של נתוני ה-payload, צריך להפעיל ישירות את Cloud Logging API ולהעביר את המבנה המלא של LogEntry אל Cloud Logging API.
מידע נוסף זמין במאמר בנושא entries.write.
דוגמאות קוד מופיעות במאמר בנושא כתיבת יומנים מובְנים.
כתיבת יומנים באמצעות ה-CLI של gcloud
אפשר לכתוב נתוני יומן באמצעות ה-CLI של gcloud. הממשק תומך ביומנים לא מובנים וביומנים מובנים. כשרוצים לכתוב יומן מובנה, צריך לספק לפקודה אובייקט JSON שעבר סריאליזציה.
מדריך למתחילים: כתיבה של רשומות ביומן וביצוע שאילתות לגביהן באמצעות Google Cloud CLI
דוגמאות קוד מופיעות במאמר בנושא gcloud logging write.
המאמרים הבאים
כדי לשלוח שאילתות ולצפות ברשומות ביומן, ראו צפייה ביומנים באמצעות Logs Explorer.
כדי לקרוא רשומות ביומן באמצעות Google Cloud CLI, אפשר לעיין במאמר בנושא קריאת רשומות ביומן.
כדי לקרוא רשומות ביומן באמצעות Logging API, אפשר לעיין בשיטה
entries.list.