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

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

מונחים חופפים נפוצים

הדוגמאות הבאות ממחישות איך משתמשים במונחים ובמזהים של 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, אבל הם לא בדיוק אותו דבר. עם זאת, לעיתים קרובות משתמשים במונחים האלה באופן לא מדויק בדיונים לא רשמיים.

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

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

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

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

השדות "Value type" ו-"metric kind" מתארים את הנתונים שנאספו. שניהם קשורים למושג "סוג נתונים" בתכנות.

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

פרטים נוספים זמינים במאמר סוגי ערכים וסוגי מדדים.

שמות המשאבים

התבנית של יצירת ערך 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, קראו את המאמר שמות של משאבים.