כתיבת רשומות ביומן ושליחת שאילתות באמצעות ה-CLI של gcloud

כתיבת רשומות ביומן באמצעות ה-CLI של gcloud

היומנים תומכים ברשומות יומן עם נתונים מובנים ולא מובנים. נתונים מובְנים מורכבים ממבנה נתונים בפורמט JSON. לדוגמה: {"weather": "partly cloudy"}. נתונים לא מובְנים הם מחרוזת של תווים. לדוגמה: "A simple entry".

בשלבים הבאים משתמשים ב-CLI של gcloud כדי לכתוב רשומה ביומן עם נתונים לא מובנים ורשומה ביומן עם נתונים מובנים. ‫ה-CLI של gcloud מספק ממשק שורת פקודה ל-Cloud Logging API.

1. כדי לכתוב רשומה ביומן עם נתונים לא מובנים ביומן my-test-log, מריצים את הפקודה gcloud logging write:

   gcloud logging write my-test-log "A simple entry."
   

   אחרי שהפקודה מסתיימת, מוצגת ההודעה: Created log entry.

2. כתיבת רשומה ביומן עם נתונים מובְנים ליומן my-test-log:

   gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'
   

   כשכותבים רשומה ביומן עם נתונים מובְנים, צריך לכלול את --payload-type=json. אם משמיטים את השדה הזה, Logging מפרש את מטען הנתונים כנתונים לא מובנים.

אם היומן my-test-log לא קיים, שירות הרישום ביומן יוצר את היומן כשמתקבלת רשומה ביומן.

הצגת רשומות ביומן באמצעות ה-CLI של gcloud

אפשר לאחזר רשומות ביומן מ-Logging ולהציג אותן באמצעות ה-CLI של gcloud. לדוגמה, כדי לאחזר ולהציג את רשומות היומן עם סוג המשאב global, מריצים את הפקודה הבאה:

gcloud logging read "resource.type=global"

הפקודה מחזירה תוצאה שדומה לזו:

---
insertId: jpj9zjf73t1mn
jsonPayload:
  message: My second entry
  weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'

מידע על קריאת יומנים מופיע במאמרי העזרה של gcloud logging read.

צפייה ברשומות ביומן בכלי Logs Explorer

כדי להציג רשומות ביומן ב Cloud de Confiance מסוף, אפשר להשתמש ב-Logs Explorer. ברוב הפרויקטים מאוחסן מספר גדול של יומנים. אפשר לבחור רשומות מסוימות ביומן על ידי כתיבת שאילתה. Cloud de Confiance

כדי לראות את הרשומות ביומן שכתבתם באמצעות Logs Explorer:

1. במסוף Cloud de Confiance , נכנסים לדף segment Logs Explorer:

   כניסה אל Logs Explorer

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא Logging.

   מוודאים שפרויקט Cloud de Confiance נבחר בסרגל Cloud de Confiance by S3NSהניווט. במידת הצורך, משתמשים Cloud de Confiance ברשימה הנפתחת של הפרויקטים Cloud de Confiance כדי לבחור את הפרויקט.

2. בתפריט Resource בוחרים באפשרות Global.

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

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

   הנתונים של הרשומה הראשונה ביומן מאוחסנים ב-textPayload. רשומת היומן השנייה מכילה נתונים מובְנים שמאוחסנים ב-jsonPayload. המטען הייעודי המובנה מכיל את המפתחות message ו-weather.

למידע על פורמט הנתונים של רשומות ביומן, אפשר לעיין בסוג LogEntry.

שליחת שאילתות על רשומות ביומן ב-Logs Explorer

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

1. במסוף Cloud de Confiance , נכנסים לדף segment Logs Explorer:

   כניסה אל Logs Explorer

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא Logging.

2. בתפריט Resource בוחרים באפשרות Global.

3. בעורך השאילתות, מזינים את המחרוזת simple במירכאות. בתצוגת היומנים מוצגת רק רשומת היומן A simple entry.

4. אחרי שמעיינים ביומן, מסירים את מחרוזת השאילתה שהוספתם ולוחצים על הפעלת שאילתה. שתי רשומות היומן מופיעות שוב בתצוגה.

כדי להציג את כל רשומות היומן עם נתונים מובנים שיש להם מפתח של weather כאשר השדה value מכיל partly, מבצעים את הפעולות הבאות:

1. עורך השאילתות מכיל את השורה resource.type="global". מזינים את הפקודה הבאה:

   jsonPayload.weather:partly
   

2. לוחצים על Run query. התוצאה היא רשומה אחת ביומן My second entry.

בנוסף, בכלי Logs Explorer מוצגות שאילתות שנשמרו, הצעות לשאילתות ושאילתות אחרונות. מידע נוסף על שאילתות זמין במאמר יצירת שאילתות ב-Logs Explorer.

שאילתות לדוגמה מופיעות במאמר שאילתות לדוגמה באמצעות Logs Explorer.

פתרון בעיות

• שגיאות הקלדה ושמות שדות לא מוכרים גורמים לפקודות של ה-CLI של gcloud להסתיים עם הודעות invalid argument. לדוגמה, אם שכחתם להוסיף את הנקודה ב-resource.type, תקבלו את השגיאה הבאה:

   ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.
  

• אם לא ניתנו ל-Cloud Logging הרשאות הגישה הנדרשות, פקודות ה-CLI של gcloud יושלמו עם הודעות permission denied. לדוגמה, אם מכונה וירטואלית ב-Compute Engine מוגדרת עם הגדרות ברירת המחדל של ה-API, הפקודה list מסתיימת עם שגיאת דחייה של הרשאה:

   ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.
  

  כדי לתקן את התנאי הזה, צריך לשנות את ההרשאות של מכונת ה-VM ב-Compute Engine כדי להעניק הרשאת קריאה ל-Cloud Logging. לשם כך, מבצעים את הפעולות הבאות:

  1. נכנסים לדף VM instance details של המכונה הווירטואלית. לוחצים על הפסקה. הפעולה הזו עשויה להימשך דקה או שתיים.
  2. כדי לשנות את ההגדרות, לוחצים על עריכה.
  3. מחפשים את הכותרת Cloud API access scopes ולוחצים על Details כדי להציג את ההגדרות של כל API. משנים את הערך מ-Cloud Logging API לFull. לוחצים על Save.
  4. כדי להפעיל מחדש את מופע ה-VM, לוחצים על התחלה. אחרי כמה רגעים, המכונה הווירטואלית מוכנה לשימוש.