מבוא ל-Cloud Monitoring API

בדף הזה מתוארים חלק מהתכונות של Cloud Monitoring API v3.

מאמרי העזרה של ה-API מופיעים באחד מהדפים הבאים:

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

לכל ה-methods ב-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 יתייחס לפרויקט היקף של היקף מדדים.

אין צורך להגדיר את היקף המדדים בפרויקט

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

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

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

  • ההתנהגות של שאר ה-methods ב-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.

ערוצי התראות

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

מידע נוסף מופיע במאמרים בנושא NotificationChannel וNotificationChannelDescriptor.

ניטור שירותים

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

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

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

מרכזי שליטה

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

Monitoring Query Language

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

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

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

מסננים

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

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

השלבים הבאים