באמצעות Cloud Monitoring API ו-Google Cloud CLI, אתם יכולים ליצור מדיניות התראות מקובצי JSON או YAML, או באמצעות ספריות לקוח. כל אובייקט AlertPolicy מגדיר את התנאים שמבוססים על מדדים או על יומנים, שמצביעים על סטטוס לא תקין במערכת, יחד עם ערוצי ההתראות ואסטרטגיות ההתראות.
כשמשתמשים ב-Monitoring API, צריך לבצע אימות באמצעות פרטי כניסה של משתמש קצה ולא באמצעות מפתח API. לדוגמה, אתם יכולים לספק אסימון OAuth 2.0 למשתמש או לחשבון שירות. למידע נוסף, קראו את המאמר שימוש ב-OAuth 2.0 לגישה ל-Google APIs ואת המאמר אימות לממשקי API ולשירותים של Google Cloud .
התכונה הזו נתמכת רק בפרויקטים ב- Google Cloud . בהגדרות של App Hub, בוחרים את הפרויקט המארח או את פרויקט הניהול של App Hub.
המבנה של מדיניות התראות
המבנה AlertPolicy מגדיר את הרכיבים של מדיניות התראה. כשיוצרים מדיניות, מציינים ערכים בשדות הבאים של AlertPolicy:
displayName: תווית תיאורית למדיניות.-
documentation: מומלץ להשתמש בשדה הזה כדי לספק מידע שיעזור למגיבים. מידע נוסף זמין במאמר הוספת הערות להתראות באמצעות מסמכים שמוגדרים על ידי המשתמש.
userLabels: תוויות שהמשתמשים הגדירו ומצורפות למדיניות. התוויות האלה מוצגות בכללי מדיניות התראות, בהתראות ובהודעות. למידע על שימוש בתוויות עם התראות, קראו את המאמר הוספת הערות להתראות באמצעות תוויות.
conditions[]: מערך של מבניCondition.
combiner: אופרטור לוגי שקובע איך לטפל בכמה תנאים.
notificationChannels[]: מערך של שמות משאבים, שכל אחד מהם מזההNotificationChannel.
alertStrategy: מציין את הפרטים הבאים:- כמה מהר המערכת סוגרת התראות כשנתונים מפסיקים להגיע.
- במדיניות התראות שמבוססת על מדדים, אם המערכת של Monitoring שולחת התראה כשההתראה נסגרת.
- במדיניות התראות שמבוססת על מדדים, אם ההתראות החוזרות מופעלות, ומה המרווח בין ההתראות האלה. למידע נוסף, קראו את המאמר הגדרת התראות חוזרות למדיניות התראות שמבוססת על מדדים.
אפשר גם לציין את השדה severity כשמשתמשים ב-Cloud Monitoring API ובמסוף Google Cloud . בשדה הזה אפשר להגדיר את רמת החומרה של ההתראות. אם לא מציינים רמת חומרה, מערכת Cloud Monitoring מגדירה את רמת החומרה של מדיניות ההתראה ל-No Severity.
יש שדות אחרים שאפשר להשתמש בהם, בהתאם לתנאים שאתם יוצרים.
כשמדיניות התראה מכילה תנאי אחד, נשלחת התראה כשהתנאי הזה מתקיים. למידע על התראות כשיש כמה תנאים במדיניות ההתראות, קראו את המאמרים מדיניות עם כמה תנאים ומתי Cloud Monitoring שולח התראות ויוצר התרעות.
כשיוצרים או משנים את מדיניות ההתראות, המערכת של Monitoring מגדירה גם שדות אחרים, כולל השדה name. הערך של השדה name הוא שם המשאב של מדיניות ההתראה, שמזהה את המדיניות. שם המשאב מופיע בפורמט הבא:
projects/PROJECT_ID/alertPolicies/POLICY_ID
בביטוי הקודם:
- PROJECT_ID: מזהה הפרויקט. בהגדרות של App Hub, בוחרים את הפרויקט המארח או את פרויקט הניהול של App Hub.
- POLICY_ID: המזהה של מדיניות ההתראה
סוגי התנאים ב-API
Cloud Monitoring API תומך במגוון סוגי תנאים במבנה Condition. יש כמה סוגי תנאים לכללי מדיניות התראות שמבוססים על מדדים, וסוג אחד לכללי מדיניות התראות שמבוססים על יומנים. בקטעים הבאים מתוארים סוגי התנאים הזמינים.
תנאים לכללי מדיניות התראות שמבוססים על מדדים
כדי ליצור מדיניות התראות שמנטרת נתוני מדדים, כולל מדדים מבוססי-יומנים, אתם יכולים להשתמש בסוגי התנאים הבאים:
תנאים להערכת מדדים שמבוססים על מסננים
התנאים MetricAbsence ו-MetricThreshold משתמשים במסנני מעקב כדי לבחור את נתוני הסדרות העיתיות למעקב. שדות אחרים במבנה התנאי מציינים איך לסנן, לקבץ ולצבור את הנתונים. למידע נוסף על המושגים האלה, קראו את המאמר סינון וצבירה: שינוי של סדרות זמן.
אם משתמשים בסוג התנאי MetricAbsence, אפשר ליצור תנאי שמתקיים רק כשכל סדרות הזמנים חסרות. התנאי הזה משתמש בפרמטר aggregations כדי לצבור כמה סדרות זמנים לסדרת זמנים אחת. מידע נוסף מופיע במאמרי העזרה של ה-API בקטע MetricAbsence.
כדי להגדיר מדיניות התראה על היעדר מדד, צריך שחלק מהנתונים ייכתבו קודם. למידע נוסף, קראו את המאמר יצירת מדיניות התראה על היעדר מדד.
אם אתם רוצים לקבל התראות על סמך ערך חזוי, הגדירו את מדיניות ההתראות כך שתשתמש בסוג התנאי MetricThreshold ותגדיר את השדה forecastOptions. אם השדה הזה לא מוגדר, הנתונים שנמדדו מושווים לסף.
עם זאת, כשהשדה הזה מוגדר, הנתונים החזויים מושווים לסף. מידע נוסף זמין במאמר יצירת מדיניות התראות לערכי מדדים חזויים.
תנאים למדדים שמבוססים על PromQL
התנאי PrometheusQueryLanguageCondition משתמש בשאילתות של Prometheus Query Language (PromQL) כדי לבחור ולשנות את נתוני סדרת זמנים למעקב.
התנאי יכול לחשב יחס בין מדדים, להעריך השוואות בין מדדים ועוד.
אם משתמשים בתנאי PrometheusQueryLanguageCondition, הוא חייב להיות התנאי היחיד במדיניות ההתראות. למידע נוסף, ראו מדיניות התראות באמצעות PromQL.
תנאים להצגת התראות על יחסים
אתם יכולים ליצור מדיניות התראות של סף מדדים כדי לעקוב אחרי היחס בין שני מדדים. אפשר ליצור את כללי המדיניות האלה באמצעות סוג התנאי MetricThreshold או PrometheusQueryLanguageCondition.
אפשר גם להשתמש ב-PromQL ישירות במסוף Google Cloud . אי אפשר ליצור או לנהל תנאים שמבוססים על יחס באמצעות הממשק הגרפי ליצירת תנאי סף.
מומלץ להשתמש ב-PromQL כדי ליצור מדיניות התראות שמבוססת על יחס.
בעזרת PromQL אפשר ליצור שאילתות חזקות וגמישות יותר מאשר באמצעות סוג התנאי MetricTheshold ומסנני Monitoring.
לדוגמה, באמצעות התנאי PrometheusQueryLanguageCondition אפשר לחשב את היחס בין מדד מסוג gauge למדד מסוג delta.
אם משתמשים בתנאי MetricThreshold, המונה והמכנה של היחס צריכים להיות עם אותו MetricKind.
רשימה של מדדים והמאפיינים שלהם מופיעה במאמר רשימות של מדדים.
באופן כללי, מומלץ לחשב יחסים על סמך סדרות זמן שנאספו לסוג מדד יחיד, באמצעות ערכי תוויות. יחס שמחושב על שני סוגי מדדים שונים כפוף לחריגות בגלל תקופות דגימה וחלונות התאמה שונים.
לדוגמה, נניח שיש לכם שני סוגי מדדים שונים, ספירה כוללת של RPC וספירת שגיאות של RPC, ואתם רוצים לחשב את היחס בין ספירת השגיאות של RPC לבין סך כל ה-RPC. הקריאות ל-RPC שנכשלו נספרות בסדרת הזמן של שני סוגי המדדים. לכן, יכול להיות שכשתתאימו את סדרות הזמנים, קריאת RPC שנכשלה לא תופיע באותו מרווח התאמה בשתי הסדרות. יכולות להיות לכך כמה סיבות, כולל:
- מכיוון שיש שתי סדרות זמן שונות שמתעדות את אותו אירוע, יש שני ערכי מונה בסיסיים שמטמיעים את האוסף, והם לא מתעדכנים באופן אטומי.
- יכול להיות שתדירויות הדגימה יהיו שונות. כשהסדרות העיתיות מותאמות לתקופה משותפת, הספירות של אירוע בודד עשויות להופיע במרווחי התאמה סמוכים בסדרות העיתיות של המדדים השונים.
ההבדל במספר הערכים במרווחי ההתאמה התואמים יכול להוביל לערכי יחס error/total חסרי משמעות, כמו 1/0 או 2/1.
יחסים של מספרים גדולים יותר נוטים פחות להוביל לערכים חסרי משמעות. כדי לקבל מספרים גדולים יותר, אפשר להשתמש בצבירה, באמצעות חלון התאמה ארוך יותר מתקופת הדגימה, או באמצעות קיבוץ נתונים של תוויות מסוימות. השיטות האלה ממזערות את ההשפעה של הבדלים קטנים במספר הנקודות במרווח זמן נתון. כלומר, פער של שתי נקודות משמעותי יותר כשהמספר הצפוי של הנקודות במרווח הוא 3, מאשר כשהמספר הצפוי הוא 300.
אם אתם משתמשים בסוגי מדדים מובְנים, יכול להיות שלא תהיה לכם ברירה אלא לחשב יחסים בין סוגי מדדים כדי לקבל את הערך שאתם צריכים.
אם אתם מתכננים מדדים מותאמים אישית שעשויים לספור את אותו הדבר – כמו קריאות RPC שמחזירות סטטוס שגיאה – בשני מדדים שונים, כדאי לשקול במקום זאת מדד יחיד שכולל כל ספירה פעם אחת בלבד. לדוגמה, נניח שאתם סופרים קריאות RPC ורוצים לעקוב אחרי היחס בין קריאות RPC שנכשלו לבין כל קריאות ה-RPC. כדי לפתור את הבעיה, יוצרים סוג מדד אחד לספירת קריאות RPC, ומשתמשים בתווית כדי לתעד את סטטוס ההפעלה, כולל הסטטוס "OK". לאחר מכן, כל ערך סטטוס, שגיאה או "OK", מתועד על ידי עדכון מונה יחיד לאותו מקרה.
תנאי למדיניות התראות מבוססות-יומנים
כדי ליצור מדיניות התראות מבוססת-יומנים, ששולחת התראה כשמופיעה ברשומות ביומן הודעה שתואמת למסנן, משתמשים בסוג התנאי LogMatch. אם משתמשים בתנאי LogMatch, הוא חייב להיות התנאי היחיד במדיניות ההתראות.
אל תנסו להשתמש בסוג התנאי LogMatch בשילוב עם מדדים מבוססי-יומנים. כללי מדיניות התראה שעוקבים אחרי מדדים מבוססי-יומנים הם כללי מדיניות מבוססי-מדדים. למידע נוסף על בחירה בין מדיניות התראות שעוקבות אחרי מדדים מבוססי-יומנים או רשומות ביומן, ראו מעקב אחרי היומנים.
מדיניות ההתראות שמופיעה בדוגמאות במאמר ניהול מדיניות ההתראות באמצעות API מבוססת על מדדים, אבל העקרונות זהים גם למדיניות התראות שמבוססת על יומנים. למידע ספציפי על מדיניות התראות מבוססות-יומנים, קראו את המאמר יצירת מדיניות התראות מבוססות-יומנים באמצעות Monitoring API במסמכי התיעוד של Cloud Logging.
איך משייכים מדיניות התראה לאפליקציה ב-App Hub
Google Cloud יוצר מרכזי בקרה שעוזרים לכם לעקוב אחרי האפליקציות ב-App Hub. בלוחות הבקרה האלה מוצג מידע כמו נתוני יומנים ומדדים של האפליקציות, ושל השירותים ועומסי העבודה שהם חלק מהאפליקציה. בלוחות הבקרה האלה מוצגות גם מדיניות ההתראות וההתראות שלהן, כשהמדיניות משויכת לשירות או לעומס העבודה של האפליקציה. למידע נוסף על מעקב אחרי אפליקציות, ראו הצגת נתוני טלמטריה של אפליקציות.
כדי לשייך מדיניות התראות לאפליקציה ב-App Hub, צריך לצרף למדיניות תוויות עם המפתחות הבאים:
apphub_application_locationapphub_application_idapphub_service_idאוapphub_workload_id
userLabels בייצוג ה-JSON של מדיניות התראות יכול להיראות כך:
"userLabels": {
"apphub_service_id": "my-service-id",
"apphub_application_location": "my-app-location",
"apphub_application_id": "my-app"
},
לפני שמתחילים
לפני שכותבים קוד ל-API, צריך:
- להכיר את המושגים הכלליים ואת המונחים שמשמשים במדיניות התראות. למידע נוסף, קראו את הסקירה הכללית על התראות.
- מוודאים ש-Cloud Monitoring API מופעל לשימוש. למידע נוסף, ראו הפעלת ה-API.
- אם אתם מתכננים להשתמש בספריות לקוח, התקינו את הספריות לשפות שבהן אתם רוצים להשתמש. פרטים נוספים זמינים במאמר ספריות לקוח. אפשר להשתמש ב-API כדי להגדיר התראות רק ב-C#, Go, Java, Node.js ו-Python.
אם אתם מתכוונים להשתמש ב-Google Cloud CLI, אתם צריכים להתקין אותו. עם זאת, אם אתם משתמשים ב-Cloud Shell, כבר מותקן אצלכם Google Cloud CLI.
כאן מוצגות גם דוגמאות לשימוש בממשק של
gcloud. שימו לב שבכל הדוגמאות שלgcloud, הפרויקט הנוכחי כבר הוגדר כיעד (gcloud config set project [PROJECT_ID]), ולכן הקריאות לא כוללות את הדגל המפורש--project. בדוגמאות, מזהה הפרויקט הנוכחי הואa-gcp-project. בהגדרות של App Hub, בוחרים את הפרויקט המארח או את פרויקט הניהול של App Hub.
-
כדי לקבל את ההרשאות שנדרשות ליצירה ולשינוי של מדיניות התראות באמצעות Cloud Monitoring API, בקשו מהאדמין להקצות לכם את התפקיד עריכת מדיניות התראות ב-Monitoring (
roles/monitoring.alertPolicyEditor) ב-IAM בפרויקט. כדי לקרוא הסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
במאמר בקרת גישה באמצעות ניהול זהויות והרשאות גישה (IAM) מוסבר בהרחבה על תפקידי IAM ב-Monitoring.
כדאי לתכנן את האפליקציה כך שתבצע קריאות ל-Cloud Monitoring API ב-thread יחיד, שמשנות את המצב של מדיניות ההתראות בפרויקט ב-Google Cloud . לדוגמה, קריאות ל-API בשרשור יחיד שיוצרות, מעדכנות או מוחקות מדיניות התראות.
יצירת מדיניות התראות
כדי ליצור מדיניות התראות בפרויקט, משתמשים ב-method alertPolicies.create. כדי לדעת איך להפעיל את השיטה הזו, מהם הפרמטרים שלה ומהם נתוני התגובה, קראו את דף העזר alertPolicies.create.
אפשר ליצור כללי מדיניות מקובצי JSON או YAML.
Google Cloud CLI מקבל את הקבצים האלה כארגומנטים, ואפשר לקרוא קובצי JSON באופן פרוגרמטי, להמיר אותם לאובייקטים מסוג AlertPolicy וליצור מהם כללי מדיניות באמצעות ה-method alertPolicies.create. אם יש לכם קובץ תצורה של Prometheus בפורמט JSON או YAML עם כלל התראה, אתם יכולים להעביר אותו באמצעות ה-CLI של gcloud למדיניות התראה ב-Cloud Monitoring עם תנאי PromQL. למידע נוסף, קראו את המאמר העברת כללי התראות ומקלטים מ-Prometheus.
כל מדיניות התראה שייכת לפרויקט היקף של היקף המדדים בפרויקט. כל פרויקט יכול להכיל עד 2,000 כללי מדיניות.
בקריאות ל-API, צריך לספק את מזהה הפרויקט (project ID). הערך שצריך להזין הוא המזהה של הפרויקט שמוגדר כהיקף המדדים. בדוגמאות האלה, המזהה של הפרויקט להיקף המדדים הוא a-gcp-project.
הדוגמאות הבאות ממחישות את היצירה של מדיניות התראות, אבל הן לא מתארות איך ליצור קובץ JSON או YAML שמתאר מדיניות התראות. במקום זאת, הדוגמאות מבוססות על ההנחה שקיים קובץ בפורמט JSON, והן ממחישות איך לשלוח את הקריאה ל-API. בקטע כללי מדיניות לדוגמה תוכלו לראות קובצי JSON לדוגמה. למידע כללי על מעקב אחרי יחסים בין מדדים, ראו יחסים בין מדדים.
gcloud
כדי ליצור מדיניות התראות בפרויקט, משתמשים בפקודה gcloud monitoring
policies create. בדוגמה הבאה, מדיניות ההתראה נוצרת ב-a-gcp-project מהקובץ rising-cpu-usage.json:
gcloud monitoring policies create --policy-from-file="rising-cpu-usage.json"
אם הפעולה מצליחה, הפקודה מחזירה את שם המדיניות החדשה, לדוגמה:
Created alert policy [projects/a-gcp-project/alertPolicies/12669073143329903307].
הקובץ rising-cpu-usage.json מכיל את ה-JSON של מדיניות עם השם המוצג "High CPU rate of change". לפרטים על המדיניות הזו, ראו מדיניות קצב השינוי.
למידע נוסף, עיינו במפרט של השיטה ב-gcloud monitoring policies create.
C#
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
Go
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
Java
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
Node.js
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
PHP
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
Python
כדי לבצע אימות ב-Monitoring, צריך להגדיר את Application Default Credentials. למידע נוסף, ראו הגדרת אימות לסביבת פיתוח מקומית.
לאובייקט AlertPolicy שנוצר יהיו שדות נוספים.
המדיניות עצמה תכלול את השדות name, creationRecord ו-mutationRecord. בנוסף, כל תנאי במדיניות מקבל גם name.
אי אפשר לשנות את השדות האלה באופן חיצוני, ולכן אין צורך להגדיר אותם כשיוצרים מדיניות. הם לא מופיעים באף אחת מדוגמאות ה-JSON שמשמשות ליצירת כללי מדיניות, אבל אם מאחזרים כללי מדיניות שנוצרו מהן אחרי היצירה, השדות יופיעו.
הגדרת התראות חוזרות למדיניות התראות שמבוססת על מדדים
כברירת מחדל, מדיניות התראות שמבוססת על מדדים שולחת התראה אחת לכל ערוץ התראות כשנפתחת התראה. עם זאת, אתם יכולים לשנות את התנהגות ברירת המחדל ולהגדיר מדיניות התראה שתשלח מחדש את ההתראות לכל ערוצי ההתראות של מדיניות ההתראה, או לחלק מהם. ההתראות החוזרות האלה נשלחות לגבי התראות בסטטוס "פתוחה" או "אומתה". מרווח הזמן בין ההתראות האלה חייב להיות לפחות 30 דקות ולא יותר מ-24 שעות, והוא מצוין בשניות.
כדי להגדיר התראות חוזרות, מוסיפים להגדרות של מדיניות ההתראה אובייקט AlertStrategy שמכיל לפחות אובייקט NotificationChannelStrategy אחד.
לאובייקט NotificationChannelStrategy יש שני שדות:
renotifyInterval: מרווח הזמן, בשניות, בין התראות חוזרות.אם משנים את הערך של השדה
renotifyIntervalכשנפתחת התראה לגבי מדיניות ההתראות, קורים הדברים הבאים:- מדיניות ההתראות שולחת התראה נוספת.
- מדיניות ההתראה מפעילה מחדש את תקופת המרווח.
notificationChannelNames: מערך של שמות משאבים של ערוצי התראות, שהם מחרוזות בפורמטprojects/PROJECT_ID/notificationChannels/CHANNEL_ID, כאשר CHANNEL_ID הוא ערך מספרי. במאמר הצגת רשימה של ערוצי התראות בפרויקט מוסבר איך לאחזר את מזהה הערוץ.
לדוגמה, בדגימת ה-JSON הבאה מוצגת אסטרטגיית התראות שמוגדרת לשלוח התראות חוזרות כל 1,800 שניות (30 דקות) לערוץ התראות אחד:
"alertStrategy": {
"notificationChannelStrategy": [
{
"notificationChannelNames": [
"projects/PROJECT_ID/notificationChannels/CHANNEL_ID"
],
"renotifyInterval": "1800s"
}
]
}
כדי להפסיק זמנית התראות חוזרות, אפשר ליצור התראה חוזרת. כדי למנוע התראות חוזרות, צריך לערוך את מדיניות ההתראות באמצעות ה-API ולהסיר את האובייקט NotificationChannelStrategy.