הערות לגבי מינוח

המילים name,‏ type,‏ kind,‏ metric ו-resource מופיעות בשילובים שונים ובהקשרים שונים שקשורים ל-Cloud Monitoring, והשימוש בהן לא תמיד עקבי. לדוגמה, אלה כמה דפוסים נפוצים:

  • המונח מדד יכול לשמש בהקשרים שונים כדי להתייחס לכל אחד מהדברים הבאים:

    • 'משהו' כללי למדידה
    • סוג מדד
    • פעולות על ציר הזמן
    • קבוצה של סדרות עיתיות שמשויכות לסוג מדד
    • המבנה Metric מוטמע במבנה TimeSeries

  • מחרוזת כמו storage.googleapis.com/api/request_count יכולה להיקרא באחד מהשמות הבאים:

    • מדד
    • שם המדד
    • סוג מדד
    • שם של סוג מדד

  • מחרוזת כמו gcs_bucket יכולה להיקרא בכל אחד מהשמות הבאים:

    • שם משאב1
    • משאב במעקב
    • סוג משאב במעקב
    • שם של משאב במעקב

‫1 במסמכי הפניית API בארכיטקטורת REST נעשה שימוש תדיר במונח שם משאב, שבדרך כלל לא קשור למשאבים במעקב. המונח הזה מוסבר בפירוט במאמר בנושא שמות של משאבים.

בקטע הזה מוסבר על מונחים שעלולים להיות מבלבלים.

סוגים ושמות

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

לדוגמה, המחרוזת storage.googleapis.com/api/request_count היא סוג של מדד, אבל היא נקראת גם שם או שם סוג.

אם בודקים את התיאור של סוג המדד הזה, רואים את שני צמדי המפתח-ערך האלה, name ו-type:

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

הערך type בתיאור המדד הוא מחרוזת שמקודדת מידע על השירות שמייצר את הנתונים (לדוגמה, storage.googleapis.com) ועל מה שנמדד (api/request_count).

בתיאור מדד, הערך של name הוא הגרסה המלאה של סוג המדד, והערך של name הוא הערך של type עם הקידומת הבאה:

projects/[PROJECT_ID]/metricDescriptors/

דפוס דומה קיים גם לגבי משאבים במעקב. ‫type הוא תווית של סוג מסוים של משאב, ו-name מורכב מהערך type עם הקידומת הבאה:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

הדוגמה הבאה תואמת לרשומה api ברשימת המשאבים שבמעקב:

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

הערך של name בפרויקט ניתן לחיזוי מלא מהערך של type, אבל הם לא בדיוק אותו הדבר. עם זאת, בשיחות לא רשמיות, לעיתים קרובות משתמשים במונחים האלה בצורה לא מדויקת.

סוג המדד וסוג הערך

יש עוד שני מונחים שאפשר להתבלבל ביניהם לבין 'סוג מדד':

  • סוג הערך
  • סוג המדד

המונחים האלה לא חלופיים למונח 'סוג מדד'.

ההגדרות 'סוג ערך' ו'סוג מדד' מתארות את הנתונים שנאספים. שניהם קשורים למושג התכנות 'סוג נתונים'.

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

פרטים נוספים זמינים במאמר סוגים וסוגים של מדדים.

שמות המשאבים

הדפוס של יצירת ערך name על ידי הוספת מחרוזת לערך type (או לערך אחר) חל על הרבה יותר מסוגי מדדים ומשאבים במעקב. היא מופיעה כמעט בכל דבר שיוצר נתונים שניתנים לזיהוי מובהק. לדוגמה, גם MetricDescriptor וגם AlertPolicy תואמים לדפוס הזה.

הערך של השדה name מתואר לעיתים קרובות בתיעוד העזר כ'שם משאב':

שם המשאב בהפניית ה-API

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

  • תיאורי מדדים: צירוף הערכים של הקידומת והשדה type:
    • קידומת: projects/[PROJECT_ID]/metricDescriptors
    • type (דוגמה): storage.googleapis.com/api/request_count
    • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • מתארי משאבים במעקב: צריך לצרף את הערכים של הקידומת והשדה type:
    • קידומת: projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (דוגמה): api
    • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • מדיניות התראות: צירוף הערכים של הקידומת ומזהה שנוצר
    • קידומת: projects/[PROJECT_ID]/alertPolicies
    • מזהה מדיניות ההתראות: מספר שנוצר כשנוצרה המדיניות
    • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

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