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

במאמר הזה נציג כמה מהיכולות של Cloud Logging ונסביר איך לבצע את הפעולות הבאות:

  • כתיבת רשומות ביומן באמצעות Google Cloud CLI.
  • אפשר לרשום את רשומות היומן באמצעות ה-CLI של gcloud.
  • מציגים רשומות ביומן באמצעות Logging API.
  • הצגה של רשומות ביומן והרצת שאילתות באמצעות Logs Explorer.

לפני שמתחילים

כדי להשלים את המדריך הזה, צריך שיהיה לכם פרויקט עם חיוב מופעל. Google Cloud אם אין לכם פרויקט Google Cloud או אם החיוב לא מופעל בפרויקט Google Cloud , אתם צריכים לבצע את הפעולות הבאות:

  1. נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.

  2. התקינו את ה-CLI של Google Cloud.

  3. אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

  4. כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה: 

    gcloud init

  5. יוצרים או בוחרים Google Cloud פרויקט.

    תפקידים שנדרשים כדי לבחור או ליצור פרויקט

    • Select a project: כדי לבחור פרויקט לא צריך תפקיד IAM ספציפי – אפשר לבחור כל פרויקט שקיבלתם בו תפקיד.
    • יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד Project Creator (יצירת פרויקטים) (roles/resourcemanager.projectCreator), שכולל את ההרשאה resourcemanager.projects.create. איך מקצים תפקידים

    • יוצרים Google Cloud פרויקט:

      gcloud projects create PROJECT_ID

      מחליפים את PROJECT_ID בשם של פרויקט Google Cloud שיוצרים.

    • בוחרים את הפרויקט שיצרתם: Google Cloud 

      gcloud config set project PROJECT_ID

      מחליפים את PROJECT_ID בשם הפרויקט ב- Google Cloud .

  6. אם משתמשים בפרויקט קיים, מוודאים שיש את ההרשאות הנדרשות כדי להשלים את ההדרכה. אם משתמשים בפרויקט חדש, לא צריך לוודא כי כבר יש את ההרשאות הנדרשות.

  7. מוודאים שהחיוב מופעל בפרויקט Google Cloud .

  8. התקינו את ה-CLI של Google Cloud.

  9. אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

  10. כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה: 

    gcloud init

  11. יוצרים או בוחרים Google Cloud פרויקט.

    תפקידים שנדרשים כדי לבחור או ליצור פרויקט

    • Select a project: כדי לבחור פרויקט לא צריך תפקיד IAM ספציפי – אפשר לבחור כל פרויקט שקיבלתם בו תפקיד.
    • יצירת פרויקט: כדי ליצור פרויקט, צריך את התפקיד Project Creator (יצירת פרויקטים) (roles/resourcemanager.projectCreator), שכולל את ההרשאה resourcemanager.projects.create. איך מקצים תפקידים

    • יוצרים Google Cloud פרויקט:

      gcloud projects create PROJECT_ID

      מחליפים את PROJECT_ID בשם של פרויקט Google Cloud שיוצרים.

    • בוחרים את הפרויקט שיצרתם: Google Cloud 

      gcloud config set project PROJECT_ID

      מחליפים את PROJECT_ID בשם הפרויקט ב- Google Cloud .

  12. אם משתמשים בפרויקט קיים, מוודאים שיש את ההרשאות הנדרשות כדי להשלים את ההדרכה. אם משתמשים בפרויקט חדש, לא צריך לוודא כי כבר יש את ההרשאות הנדרשות.

  13. מוודאים שהחיוב מופעל בפרויקט Google Cloud .

התפקידים הנדרשים

כדי לקבל את ההרשאות שנדרשות ליצירה, להצגה ולמחיקה של רשומות ביומן, צריך לבקש מהאדמין להקצות לכם את תפקיד ה-IAM‏ Logging Admin (אדמין של Logging) ‏(roles/logging.admin) בפרויקט. כדי לקרוא הסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.

התפקידים 'כתיבה ביומנים' (roles/logging.logWriter) ו'צפייה ביומנים' (roles/logging.viewer) כוללים את ההרשאות ליצירה ולרשימה של רשומות ביומן. כדי למחוק רשומות ביומן, צריך להקצות את התפקיד 'אדמין של Logging' (roles/logging.admin), שכולל את ההרשאות ליצור, לרשום ולמחוק רשומות ביומן. שימו לב שהתפקיד Logging Admin ‏(roles/logging.admin) מעניק גם הרשאות לביצוע כל הפעולות ב-Logging.

כתיבת רשומות ביומן באמצעות ה-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: