מוסכמות למתן שמות למדדים

במאמר הזה מוסבר על מוסכמות מתן השמות למדדים ב-Cloud Monitoring.

שם המשאב של המדד

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

• מזהה של פרויקט ספציפי.
• סמן, שתמיד מוגדר כ-metricDescriptors, כדי לציין שהמחרוזת מייצגת תיאור של מדד.
• סוג המדד.

שמות המשאבים של סוגי המדדים מורכבים מהדפוס הבא:

projects/PROJECT_ID/metricDescriptors/METRIC_TYPE

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

agent.googleapis.com/agent/api_request_count
compute.googleapis.com/firewall/dropped_bytes_count
istio.io/service/client/received_bytes_count
kubernetes.io/anthos/APIServiceOpenAPIAggregationControllerQueue1_adds

בשדה name של תיאור המדד מאוחסן שם המשאב של סוג המדד, ובשדה type מאוחסן מחרוזת המשנה METRIC_TYPE.

בטבלה הבאה מוסבר איך לנתח את מחרוזות המשנה METRIC_TYPE שכלולות בשם משאב:

מבנים אפשריים	תיאור
SERVICE_NAME^1.googleapis.com/PATH^2	מדדים ממוצרים ושירותים של Google Cloud . רשימה מלאה של המדדים האלה זמינה במאמר בנושא מדדים שלGoogle Cloud .
agent.googleapis.com/SERVICE_NAME^1/PATH^2	מדדים מסוכני Monitoring ו-Logging שפועלים במכונות וירטואליות ב- Google Cloud או ב-AWS. רשימה מלאה של המדדים האלה מופיעה במאמר מדדים של סוכנים.
kubernetes.io/anthos/PATH^2	מדדים מ-GKE Enterprise, שירות Google Cloud שמאפשר להריץ אשכולות Kubernetes גם במקום וגם בענן. רשימה מלאה של המדדים האלה
aws.googleapis.com/SERVICE_NAME^1/PATH^2	מדדים מ-Amazon Web Services. רשימה מלאה של המדדים האלה זמינה במאמר בנושא מדדי AWS.
istio.io/PATH^2	מדדים מ-Istio for Google Cloud. רשימה מלאה של המדדים האלה זמינה במאמר בנושא מדדי Istio.
kubernetes.io/PATH^2	מדדים מ-Google Kubernetes Engine. רשימה מלאה של מדדי Kubernetes
knative.dev/PATH^2	מדדים מ-Knative. רשימה מלאה של המדדים האלה מופיעה במאמר בנושא מדדים של Knative.
external.googleapis.com/EXT_SERVICE/PATH^2 external.googleapis.com/prometheus/PATH^2	מדדים מותאמים אישית של צד שלישי, כמו Prometheus. כלי הניטור הזה בקוד פתוח משמש לעיתים קרובות עם Kubernetes. מידע נוסף על המדדים האלה זמין במאמר מדדים חיצוניים. אפשר להשתמש בסוגי המדדים האלה רק בפרויקטים שבהם הם מוגדרים.
custom.googleapis.com/PATH^2 external.googleapis.com/user/PATH^2	מדדים שהוגדרו על ידי המשתמש. אפשר להשתמש בסוגי המדדים האלה רק בפרויקטים שבהם מגדירים אותם.
logging.googleapis.com/PATH^2	מדדים מבוססי-יומנים מ-Cloud Logging. אפשר להשתמש במדדים שהוגדרו מראש או ליצור מדדים מותאמים אישית. אפשר להשתמש במדדים מותאמים אישית רק בפרויקטים שבהם הם מוגדרים.

‫¹ SERVICE_NAME מזהה Google Cloud מוצר, כמו compute בשביל Compute Engine.
^‫2 PATH מציין את המדד במוצר, כמו instance/cpu/utilization.

כללים לגבי סוגים של מדדים ותוויות

הרשימה הזו כוללת כללים שצריך לפעול לפיהם כשיוצרים סוגים של מדדים מותאמים אישית. תוויות שמשויכות לסוג מדד מוגדרות כצמדי מפתח/ערך מהסוג LabelDescriptor. המפתח משמש כשם של התווית.

• סוגי מדדים

  • אפשר להשתמש במחרוזת באותיות רישיות וקטנות (A-Z, a-z), בספרות (0-9), בנקודות (.) ובקווים תחתונים (_).
  • משתמשים בלוכסנים (/) כדי להפריד בין רכיבי הנתיב.
  • כל רכיב בנתיב חייב להתחיל באות או בספרה.
  • האורך המקסימלי של מחרוזת מסוג מדד הוא 200 תווים.

• Label keys

  • במַפתח התווית צריך להשתמש באותיות קטנות (a-z), בספרות (0-9) ובקווים תחתונים (_).
  • המפתחות של התוויות צריכים להתחיל באות.
  • האורך המקסימלי של מפתח תווית הוא 100 תווים.
  • כל מפתח חייב להיות ייחודי בתוך סוג המדד.
  • אפשר להוסיף עד 30 תוויות לכל סוג מדד.