מבוא ל-Cloud Monitoring API

גרסה 3 של Cloud Monitoring API מאפשרת לשלוח שאילתות ולכתוב נתוני מדדים באופן פרוגרמטי, לארגן משאבים במעקב בקבוצות ולנהל לוחות בקרה, מדיניות התראות, יעדי רמת שירות (SLO) וערוצי התראות. למפרטים של שיטות ומשאבים, ראו Cloud Monitoring API (REST)‎ ו-Cloud Monitoring API (gRPC)‎.

שמות של פרויקטים ב-Monitoring API

לכל השיטות ב-Monitoring API יש פרמטר name חובה. לפרמטר הזה בדרך כלל יש תיאור כמו:

חובה. הפרויקט שבו תבוצע הבקשה. הפורמט הוא:
projects/[PROJECT_ID_OR_NUMBER]

ב-Monitoring API, הערך של PROJECT_ID_OR_NUMBER מזהה את אחד מהבאים:

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

כדי לתאר את סוגי השיטות האלה, בדיון הזה נשתמש במונח metrics API כדי להתייחס למשאבים הבאים ב-Monitoring API:

חובה להגדיר פרויקט להיקף המדדים

בכל השיטות של Monitoring API שלא נכללות ב-Metrics API, הפרמטר name צריך להתייחס לפרויקט הראשי של היקף המדדים.

לא נדרש פרויקט היקף של היקף המדדים בפרויקט

אף אחת מהשיטות ב-API של המדדים לא דורשת שהפרמטר name יתייחס לפרויקט ההיקף של היקף המדדים, אבל חלק מהשיטות פועלות אחרת כשהוא כן:

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

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • השיטות האחרות ב-Metrics API פועלות באופן הבא:

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

    השיטות בקבוצה הזו הן:

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

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

משאבי API

מדדים

באמצעות Monitoring API אתם יכולים לגשת לכ-6,500 מדדים של Cloud Monitoring מ-Google Cloud ומ-Amazon Web Services. אתם יכולים ליצור מדדים מותאמים אישית משלכם ולארגן את משאבי הענן באמצעות קבוצות.

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

במאמר סקירה כללית של מדדים בהגדרת משתמש מוסבר איך לנהל את המדדים המותאמים אישית ואת המדדים המובְנים.

ברשימת המדדים תוכלו לראות את כל המדדים הזמינים.

משאבים במעקב

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

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

קבוצות של משאבים במעקב

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

מידע נוסף זמין במאמרי העזרה של ה-API של Group.

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

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

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

ערוצי התראות

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

למידע נוסף, קראו את מקור המידע NotificationChannel ואת מקור המידע NotificationChannelDescriptor.

מעקב אחרי השירות

המשאבים של מעקב אחרי שירותים משמשים להגדרת יעדים ברמת השירות (SLO), שבעזרתם אפשר לעקוב אחרי תקינות השירותים.

המעקב אחרי שירותים מוסיף את המשאבים הבאים ל-Monitoring API:

למידע נוסף על המושגים האלה שקשורים למעקב אחרי שירותים ועל השימוש ב-API, קראו את המאמר מעקב אחרי יעדי SLO.

מרכזי שליטה

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

Monitoring Query Language

שפת שאילתת מעקב (MQL) מספקת ממשק מבוסס-טקסט לשליחת שאילתות לנתוני סדרות הזמן של Cloud Monitoring. ב-MQL נעשה שימוש במודל של שאילתה עם צינור עיבוד נתונים, והיא יותר אקספרסיבית ממסנני מעקב. אתם יכולים להשתמש בשאילתות MQL מ-Monitoring API או מעורך הקוד.

מידע כללי על MQL זמין במאמר סקירה כללית על שפת שאילתת מעקב.

כדי לקבל מידע על השימוש ב-MQL לאחזור נתונים של סדרות זמנים באמצעות Monitoring API, קראו את מאמרי העזרה של ה-API בנושא ה-method‏ timeSeries.query.

מסננים

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

ב-Monitoring API משתמשים במסננים גם כדי להגביל את קבוצת התוצאות של פעולות מסוימות של list. במאמר חומר עזר: מיון וסינון מוסבר איך לנהל את התוצאות של השיטות alertPolicies.list ו-notificationChannels.list.

השלבים הבאים