הצגת אירועים בלוח בקרה

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

התכונה הזו נתמכת רק בפרויקטים של Google Cloud . בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.

מידע על הערות לאירועים

אפשר להציג אירועים ברוב לוחות הבקרה שמופיעים בדף Dashboards במסוף Google Cloud . באופן דומה, אתם יכולים להגדיר כרטיסיות Observability ספציפיות לשירותים מסוימים, כמו Compute Engine ו-Google Kubernetes Engine, כך שיוצגו בהן אירועים. כדי להגדיר את סוגי האירועים שמוצגים בלוח הבקרה או בכרטיסייה Observability, אפשר להשתמש במסוף Google Cloud . אפשר גם להשתמש ב-Cloud Monitoring API כדי ליצור מרכזי בקרה, שמסווגים כמרכזי בקרה בהתאמה אישית.

אלא אם משתמשים ב-Cloud Monitoring API או מבצעים פעולה לשמירת הבחירות של סוג האירוע, הבחירות חלות רק על ההפעלה הנוכחית. כשמשתמשים במסוף Google Cloud , הצמדה של הבחירות שומרת אותן.

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

יכול להיות שתראו את סוגי האירועים הבאים מופעלים בלוח בקרה או בכרטיסייה Observability, גם אם לא בחרתם אף סוג אירוע:

כשסוג אירוע מתווסף באופן אוטומטי, הוא מוגדר כסוג אירוע מומלץ. אפשר להשאיר את סוגי האירועים האלה במצב המומלץ, לשמור אותם ב-JSON של לוח הבקרה או לסגור אותם כדי להסיר את ההמלצה. כדי לראות אילו סוגי אירועים נשמרים, מרחיבים את התפריט הערות ואז מעיינים בקטע מוצמדות.

איך המערכת מזהה אירועים

כדי לזהות את האירועים שיוצגו בלוח הבקרה, המערכת מריצה שאילתות במקורות נתונים שונים:

  • אירועי התראות מזוהים על ידי Monitoring. אירועי התראה מספקים מידע על מקרים שנפתחו.

  • אירועים ב-Service Health בהתאמה אישית מזוהים על ידי שאילתות ש-Monitoring שולח אל Service Health API. האירועים האלה מציינים מתי יש שיבוש בשירות Google Cloud .

  • סוגי אירועים אחרים מזוהים באמצעות ניתוח של רשומות היומן שעוברות דרך מאגרי Cloud Logging בפרויקט Google Cloud . רשומות היומן האלה כוללות את הרשומות שנוצרו על ידי הפרויקט ואת הרשומות שהועברו לפרויקט. כדי לקבל התראה כשמתרחש אחד מהאירועים האלה, אפשר ליצור מדיניות התראות שמבוססת על יומן. במדיניות ההתראות, משתמשים בשאילתות שמופיעות בדף סוגי אירועים.

איך האירועים מוצגים

כל האירועים מתועדים בתרשימים בלוח הבקרה בזמן שהם מתרחשים. אירועים שזוהו על ידי ניתוח של רשומות ביומן מוצגים עם הפניה יחידה לזמן. לעומת זאת, אירועים ב-Service Health מוצגים עם שעת התחלה, ואז הרקע של התרשים משתנה למשך האירוע. באירועים האלה מוצג גם סמל של לב.

בצילום המסך הבא מוצג תרשים עם כמה אירועים שזוהו בניתוח של רשומות ביומן, ואירוע אחד של Service Health:

תרשים שמציג הערות של אירועים מסוג אזהרה ומידע.

כפי שמוצג בצילום המסך הקודם, תיאור הכלי של אירוע כולל מידע כמו:

  • שם האירוע.
  • התאריך ושעת ההתחלה של האירוע.
  • באירועים ב-Service Health, צ'יפים שמציגים את מספר המוצרים והמיקומים שהושפעו. כדי לראות את המוצרים או המיקומים הרלוונטיים, מציבים את מצביע העכבר מעל הצ'יפ המתאים.
  • לחצן הצגה, שכשלוחצים עליו נפתח דף עם מידע נוסף על האירוע. לדוגמה, יכול להיות שהיא תפתח את הכלי Logs Explorer כדי שתוכלו לראות רשומות ביומן, או שהיא תפתח את דף הפרטים של אירוע ב-Service Health.

מסננים במרכז הבקרה, שמגבילים את הנתונים שמוצגים במרכז הבקרה, בדרך כלל מסננים גם נתונים של סדרות זמן וגם אירועים.

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

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

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

    • צפייה בלוחות בקרה ובכללי מדיניות להתראות ויצירה שלהם: עריכה ב-Monitoring‏ (roles/monitoring.editor).
    • הצגה של אירועים שזוהו מתוך רשומות ביומן שאינן קשורות לגישה לנתונים, שנוצרו ב Google Cloud פרויקט: מציג היומנים (roles/logging.viewer).
    • הצגה של אירועים שזוהו מתוך רשומות ביומן שנוצרו ב Google Cloud פרויקט: Private Logs Viewer (מציג היומנים הפרטיים) (roles/logging.privateLogViewer).
    • צפייה באירועים ב-Service Health: צפייה ב-Service Health בהתאמה אישית (roles/servicehealth.viewer)

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

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

  • אם רוצים להציג אירועים מ-Service Health בלוח הבקרה, צריך להפעיל את Service Health API:

    תפקידים שנדרשים להפעלת ממשקי API

    כדי להפעיל ממשקי API, צריך את תפקיד ה-IAM 'אדמין של Service Usage' (roles/serviceusage.serviceUsageAdmin), שכולל את ההרשאה serviceusage.services.enable. איך מקצים תפקידים

    להפעלת ה-API

הצגת האירועים

בקטע הזה נסביר איך להגדיר לוח בקרה או כרטיסייה של Observability כדי להציג אירועים.

הגדרת מרכזי בקרה להצגת אירועים

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

המסוף

כדי להציג אירועים במרכז בקרה:

  1. במסוף Google Cloud , עוברים לדף  Dashboards:

    עוברים אל מרכזי בקרה.

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

  2. בסרגל הכלים של מסוף Google Cloud , בוחרים את Google Cloud הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
  3. בוחרים את מרכז הבקרה שרוצים לראות.
  4. בסרגל הכלים של לוח הבקרה, לוחצים על הערות ובוחרים את סוגי האירועים שרוצים שיוצגו בלוח הבקרה.

  5. מבצעים אחת מהפעולות הבאות:

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

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

    • כדי להציג את סוגי האירועים רק עבור ההפעלה הנוכחית, לוחצים על החלה.

    אחרי שמעדכנים את רשימת סוגי האירועים שרוצים להציג, Cloud Monitoring מריץ שאילתות לגבי בעיות, מה שלוקח כמה רגעים, ואז מוסיף את ההערות לתרשימים בלוח הבקרה.

  6. כדי לראות סיכום של אירוע או לגשת לקישורים למידע נוסף, מעבירים את העכבר מעל תיאור הכלי כדי להפעיל אותו.

REST

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

  • בשדה defaultResourceName מופיעות הגדרות ברירת המחדל ברמת לוח הבקרה שלGoogle Cloud הפרויקטים שבהם יתבצע חיפוש של אירועים. אם לא מציינים את השדה הזה, המערכת מחפשת בפרויקט שנבחר.

  • מערך של אובייקטים מסוג EventAnnotation. כל אובייקט מכיל את הפרטים הבאים:

    • שדה displayName, שמאפשר להגדיר את התווית של המתג הספציפי לאירוע. אם לא מציינים את השדה הזה או אם הערך שלו הוא מחרוזת ריקה, מוצג שם ברירת המחדל של האירוע.
    • שדה enabled שקובע את הערך של המתג של האירוע. כשמצב המתג הוא true, הוא נמצא במצב on והאירועים מוצגים בלוח הבקרה. כשהערך בשדה false, המתג נמצא במצב off.
    • שדה eventType, שמכיל ערך מהספירה EventType.
    • שדה filter, שמאפשר לציין שאילתה להוספה לשאילתה הספציפית לאירוע. אם הערך בשדה הזה הוא מחרוזת ריקה, המערכת תשתמש בשאילתה שספציפית לאירוע.
    • שדה resourceNames, שמאפשר להגדיר רשימה שלGoogle Cloud פרויקטים לחיפוש אירועים. אם השדה הזה הוא מערך ריק, החיפוש יתבצע בפרויקט שבחרתם.

בדוגמה הבאה מוצג אובייקט annotations של אירוע עדכון של אשכול. השדה filter בדוגמה הזו מגביל את האירועים לאשכול ספציפי:

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

למידע מפורט על שימוש ב-Cloud Monitoring API כדי ליצור מרכזי בקרה, אפשר לעיין במאמרים יצירה וניהול של מרכזי בקרה באמצעות API ודוגמה: הפעלת אירועים במרכזי בקרה.

רשימה של סוגי אירועים, הפניות לפתרון בעיות ושאילתות שאפשר להשתמש בהן ב-Logs Explorer או במדיניות התראות שמבוססת על יומנים מופיעה בדף סוגי אירועים.

הגדרה של הכרטיסייה Observability להצגת אירועים

בקטע הזה נסביר איך להגדיר את הכרטיסייה Observability כדי להציג אירועים. שירותים מסוימים, כמו Compute Engine ו-Google Kubernetes Engine, מספקים כרטיסייה של Observability שבה מוצגים נתונים של מדדים ויומנים.

המסוף

כדי להגדיר את הכרטיסייה Observability כך שיוצגו בה אירועים:

  1. עוברים לכרטיסייה Observability (יכולת תצפית) של שירות או מוצר.

    לדוגמה, אפשר לעבור לדף Kubernetes Clusters ואז לבחור בכרטיסייה Observability. באופן דומה, אפשר לעבור לדף Kubernetes Workloads או לדף הפרטים של מכונה וירטואלית (VM), ואז לבחור בכרטיסייה Observability.

  2. מוודאים שהתפריט לוח בקרה מוגדר למוגדר מראש. אי אפשר להציג אירועים בלוחות בקרה בהתאמה אישית.

  3. בסרגל הכלים, לוחצים על הערות ומשלימים את תיבת הדו-שיח.

    אחרי שמעדכנים את רשימת האירועים שרוצים להציג, המערכת מריצה שאילתות כדי לאחזר את נתוני האירועים, ואז לוח הבקרה מתעדכן.

    אם התפריט Annotations לא מוצג, אי אפשר להגדיר את הכרטיסייה כך שיוצגו בה אירועים.

REST

לא זמין.

הצגת פרטי האירוע

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

כדי לגשת לפרטים על אירוע ספציפי, לוחצים על הצגה.

דף המסוף Google Cloud שנפתח בלחיצה על הלחצן הצגה נקבע לפי סוג האירוע. לדוגמה, עבור אירוע של בדיקת זמינות, הכפתור הזה פותח את לוח הבקרה של בדיקת הזמינות. יכול להיות שייפתח הכלי 'סייר היומנים' לסוג אחר של אירוע.

יצירת כללי מדיניות התראות

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

המסוף

כדי ליצור התראה שמבוססת על יומנים:

  1. אם לא הגדרתם ערוץ התראות, אתם צריכים לבצע את הפעולות הבאות:

    1. נכנסים לדף  Alerting במסוף Google Cloud :

      כניסה אל התראות

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

    2. בסרגל הכלים של מסוף Google Cloud , בוחרים את Google Cloud הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
    3. לוחצים על עריכת ערוץ ההתראות.
    4. עוברים לסוג של ערוץ ההתראות שרוצים להגדיר, לוחצים על הוספת ערוץ חדש וממלאים את תיבת הדו-שיח.

  2. במסוף Google Cloud , נכנסים לדף Logs Explorer:

    כניסה אל Logs Explorer

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

  3. בסרגל הכלים של מסוף Google Cloud , בוחרים את Google Cloud הפרויקט.

  4. בסרגל הכלים, בוחרים באפשרות יצירת התראה.

  5. מזינים שם למדיניות ההתראות ולוחצים על הבא.

  6. בקטע Define log entries to alert on (הגדרת רשומות ביומן שיופעלו לגביהן התראות), מזינים שאילתה או מעדכנים את השאילתה שהועתקה מהחלונית Query (שאילתה) כשבוחרים באפשרות Create Alert (יצירת התראה).

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

  7. ממלאים את תיבת הדו-שיח ולוחצים על שמירה.

REST

כדי ליצור מדיניות התראות מבוססת-יומנים באמצעות Cloud Monitoring API:

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

  2. יוצרים קובץ JSON שמכיל את הייצוג של מדיניות ההתראות. מידע נוסף על השלב הזה ודוגמה זמינים במאמר בנושא תכנון מדיניות ההתראות.

  3. מפעילים את שיטת ה-API‏ alertPolicies.create. לדוגמה, אפשר להריץ את הפקודה gcloud monitoring policies create.

הסתרת אירועים

המסוף

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

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

REST

כדי להסתיר סוג אחד של אירוע בלוח בקרה בהתאמה אישית, מחפשים את האובייקט EventAnnotation של סוג האירוע, ואז מגדירים את השדה enabled לערך false.

מידע מפורט על השימוש ב-Cloud Monitoring API זמין במאמר יצירה וניהול של לוחות בקרה באמצעות API.

המאמרים הבאים