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

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

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

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

  • מזהה של פרויקט ספציפי.
  • סמן, שתמיד מוגדר כ-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 metrics.
agent.googleapis.com/SERVICE_NAME 1/PATH 2 מדדים מסוכני Monitoring ו-Logging שפועלים במכונות וירטואליות ב- Google Cloud או ב-AWS. לרשימה המלאה של המדדים האלה, ראו מדדי הסוכן.
kubernetes.io/anthos/PATH 2 מדדים מ-GKE Enterprise, שירות של Google Cloudשמאפשר להריץ אשכולות Kubernetes באופן מקומי ובענן. לרשימה המלאה של המדדים האלה, ראו מדדי Anthos.
aws.googleapis.com/SERVICE_NAME 1/PATH 2 מדדים מ-Amazon Web Services. לרשימה המלאה של המדדים האלה, ראו מדדי AWS.
istio.io/PATH 2 מדדים מ-Istio עבור 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. אפשר להשתמש במדדים מוגדרים מראש או ליצור מדדים מותאמים אישית. אפשר להשתמש במדדים מותאמים אישית רק בפרויקטים שבהם הם הוגדרו.

1 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 תוויות לכל סוג מדד.