KRM API monitoring.gdc.goog/v1

monitoring.gdc.goog/v1

כולל הגדרות של סכימת API לקבוצת המעקב.

AlertRule

הגדרת כללי ההתראות.

מופיע ב: - MonitoringRuleSpec

שדה תיאור
alert string שם ההתראה. הערך שלו חייב להיות ערך תווית תקין.
expr string ביטוי PromQL או LogQL להערכת כלל ההתראה.
for string משך הזמן בשניות שבו התנאי שצוין צריך להתקיים כדי שההתראה תעבור מהסטטוס 'בהמתנה' לסטטוס 'פתוח'.
‫labels object (keys:string, values:string) התוויות שרוצים להוסיף או להחליף. תוויות החובה בשדה הזה הן severity: [error, critical, warning, info, test], ‏code: <short code for the error> ו-resource: <component, service, or hardware related to the alert>. הוספת תוויות נוספות היא אופציונלית.
‫annotations object (keys:string, values:string) ההערות להוספה.
groupby_labels מערך מחרוזות ההגדרה GroupbyLabels מגדירה את רשימת התוויות הלוגיות או תוויות המטא-נתונים שמשמשות לצבירת התראות לאירועים.

ClusterStatus

‫ClusterStatus היא רשימה של תנאים שמשפיעים על אשכול ספציפי.

מופיע ב: - MonitoringTargetStatus

שדה תיאור
cluster string
conditions מערך Condition

MonitoringRule

הגדרת הסכימה של Monitoring Rules API.

מופיע ב: - MonitoringRuleList

שדה תיאור
apiVersion string monitoring.gdc.goog/v1
kind string MonitoringRule
metadata ObjectMeta פרטים נוספים על השדות של metadata זמינים במסמכי העזרה של Kubernetes API.
spec MonitoringRuleSpec
status MonitoringRuleStatus

MonitoringRuleList

מכיל רשימה של כללי מעקב.

שדה תיאור
apiVersion string monitoring.gdc.goog/v1
kind string MonitoringRuleList
metadata ListMeta פרטים נוספים על השדות של metadata זמינים במסמכי העזרה של Kubernetes API.
items MonitoringRule

MonitoringRuleSpec

מגדיר את המפרט או את המצב הצפוי של אובייקט MonitoringRule.

מופיע ב: - MonitoringRule

שדה תיאור
interval string המרווח בין הערכות הכללים.
limit מספר שלם מספר ההתראות המקסימלי. הערך 0 מציין שאין מגבלה.
recordRules מערך RecordRule רשימת כללי הרשומה.
alertRules מערך AlertRule רשימת כללי ההתראות.

MonitoringRuleStatus

המאפיין מגדיר את המצב הנצפה של אובייקט MonitoringRule.

מופיע ב: - MonitoringRule

שדה תיאור
conditions מערך Condition המאפיין מגדיר את המצב הנצפה של אובייקט MonitoringRule.
errorStatus ErrorStatus השדה ErrorStatus מכיל רשימה של השגיאות הנוכחיות וחותמת הזמן שבה השדה הזה מתעדכן.

MonitoringTarget

הגדרת הסכימה של API של יעדי מעקב.

מופיע ב: - MonitoringTargetList

שדה תיאור
apiVersion string monitoring.gdc.goog/v1
kind string MonitoringTarget
metadata ObjectMeta פרטים נוספים על השדות של metadata זמינים במסמכי העזרה של Kubernetes API.
spec MonitoringTargetSpec
status MonitoringTargetStatus

MonitoringTargetList

מכיל רשימה של יעדי מעקב.

שדה תיאור
apiVersion string monitoring.gdc.goog/v1
kind string MonitoringTargetList
metadata ListMeta פרטים נוספים על השדות של metadata זמינים במסמכי העזרה של Kubernetes API.
items מערך MonitoringTarget

MonitoringTargetMetricsRelabeling

הגדרת מסנן לשמירה או להסרה של מדדים על סמך תוויות.

מופיע ב: - MonitoringTargetPodMetricsEndpoints

שדה תיאור
sourceLabels מערך מחרוזות הערכים שנבחרו מתוויות קיימות. התוכן מורכב באמצעות separator ומוצמד לביטוי regex לפעולות replace, keep ו-drop.
separator string ערך המפריד שמוצב בין ערכי תוויות המקור המצורפים בשרשור.
regex string הביטוי הרגולרי שיתאים לערך שחולץ.
action string הפעולה שתתבצע אם הביטוי regex תואם לערך שחולץ.
targetLabel string התווית שאליה ייכתב הערך שמתקבל בפעולה replace. השדה הזה הוא חובה לפעולות מסוג replace. אפשר להשתמש בקבוצות ללכידה של ביטויים רגולריים.
replacement string ערך ההחלפה שבו יש להשתמש אם הביטוי הרגולרי תואם לערך שחולץ בפעולה replace. אפשר להשתמש בקבוצות ללכידה של ביטויים רגולריים.

MonitoringTargetPodMetricsEndpoints

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

מופיע ב: - MonitoringTargetSpec

שדה תיאור
port MonitoringTargetPodMetricsPort היציאה שממנה נאספים המדדים.
path MonitoringTargetPodMetricsPath הנתיב שממנו מתבצעת גריפת המדדים.
‫scheme MonitoringTargetPodMetricsScheme הסכימה שבה משתמשים כשמגרדים מדדים.
‫params object (keys:string, values:string array) הפרמטרים של השאילתה שבהם צריך להשתמש כשמגרדים מדדים מ-path.
scrapeInterval string התדירות שבה Prometheus יבצע Scrape של נקודות הקצה של המדדים שמוגדרים בשדה podMetricsEndpoints.
scrapeTimeout string הזמן שבו Prometheus ימתין לתגובה מנקודות הקצה של המדדים שמוגדרות בשדה podMetricsEndpoints.
‫metricsRelabelings מערך MonitoringTargetMetricsRelabeling המסנן להכללה (allowlist) או להחרגה (denylist) של מדדים על סמך תוויות.
ipAddresses מערך מחרוזות התג IPAddress משמש להגדרת כתובות IP סטטיות לגירוד.
tlsConfig TLSConfig לספק הגדרת TLS בהתאמה אישית. האפשרות הזו מסופקת לעומסי עבודה מחוץ ל-Kubernetes שצריך לבצע להם scraping.
authCredential string פרטי הכניסה שצריך לספק לנקודת הקצה של הגירוד.

MonitoringTargetPodMetricsPath

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

מופיע ב: - MonitoringTargetPodMetricsEndpoints

שדה תיאור
value string הנתיב לאיסוף מדדים. אם מצורפות הערות, הן מקבלות עדיפות על פני השדה הזה.
annotation string הנתיב לאיסוף מדדים באמצעות הערות.

MonitoringTargetPodMetricsPort

קובע את היציאה שבה יש להשתמש כדי לגרד מדדים מ-pods.

מופיע ב: - MonitoringTargetPodMetricsEndpoints

שדה תיאור
value מספר שלם היציאה שממנה המערכת אוספת מדדים. אם מצורפות הערות, הן מקבלות עדיפות על פני השדה הזה.
annotation string היציאה לאיסוף מדדים באמצעות הערות.

MonitoringTargetPodMetricsScheme

קובעת את הסכימה שתשמש לגירוד מדדים מ-pods.

מופיע ב: - MonitoringTargetPodMetricsEndpoints

שדה תיאור
value string הסכימה שמשמשת לאיסוף מדדים. אם מצורפות הערות, הן מקבלות עדיפות על פני השדה הזה.
annotation string הסכימה שבה משתמשים כשמציגים מדדים באמצעות הערות.

MonitoringTargetSelectors

מספק סלקטורים שקובעים אילו פודים ינוטרו.

מופיע ב: - MonitoringTargetSpec

שדה תיאור
matchClusters מערך מחרוזות האשכולות שצריך לקחת בחשבון עבור העבודה הזו. ההגדרה שמוגדרת כברירת מחדל היא שכל האשכולות רלוונטיים לפרויקט. הקשר בין אשכולות שונים הוא קשר OR. לדוגמה, הערך ["admin", "system"] מציין שצריך להתייחס לאשכול האדמין OR כאשכול המערכת.
‫matchLabels object (keys:string, values:string) תוויות ה-Pod שצריך לקחת בחשבון עבור העבודה הזו. הגדרת ברירת המחדל היא שלא יחול סינון על סמך תוויות. הקשר בין זוגות שונים הוא קשר AND, ולכן כל הזוגות נלקחים בחשבון.
‫matchAnnotations object (keys:string, values:string) ההערות שצריך לקחת בחשבון לגבי המשימה הזו. הגדרת ברירת המחדל היא שלא יחול סינון על סמך הערות. הקשר בין זוגות שונים הוא קשר AND, ולכן כל הזוגות נלקחים בחשבון.

MonitoringTargetSpec

מגדיר את המפרט או את המצב הצפוי של אובייקט MonitoringTarget.

מופיע ב: - MonitoringTarget

שדה תיאור
selector MonitoringTargetSelectors התבנית התואמת שמזהה את ה-Pods של המשימה הזו. כדי ליצור קשר בין סלקטורים שונים, משתמשים ב-AND.
podMetricsEndpoints MonitoringTargetPodMetricsEndpoints נקודת הקצה שנחשפת למשימה הזו. נקודת הקצה משתמשת בסגנון של Prometheus.

MonitoringTargetStatus

המאפיין מגדיר את המצב הנצפה של אובייקט MonitoringTarget.

מופיע ב: - MonitoringTarget

שדה תיאור
conditions מערך Condition רשימה של תנאים שנצפו בחבילת הניטור.
clusterStatuses ClusterStatus ‫ClusterStatuses היא רשימה של כל אשכול והתנאים שנצפו ב-Monitoring stack עבור האשכול הזה.

RecordRule

הגדרת כללי הרשומה.

מופיע ב: - MonitoringRuleSpec

שדה תיאור
record string סדרת הזמן שבה רוצים לכתוב את כלל הרשומה. השם חייב להיות שם תקין של מדד.
expr string ביטוי PromQL או LogQL להערכת כלל הרשומה.
‫labels object (keys:string, values:string) התוויות שרוצים להוסיף או להחליף.

TLSConfig

מופיע ב: - MonitoringTargetPodMetricsEndpoints

שדה תיאור
ca string הטקסט של אישור CA לשימוש ביעדים.
cert string הטקסט של קובץ אישור הלקוח ליעדים.
server_name string הפרמטר הזה משמש לאימות שם המארח של יעדי הטרגוט.