דוגמאות להתראות

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

התראה על קוד תגובה שאינו 200 למשך 5 דקות

בדוגמה הבאה נוצרת התראה אם לא מתקבל קוד תגובה 200 (בקשה מוצלחת) במשך 5 דקות.

כדי ליצור את ההתראה:

  1. במסוף Google Cloud , עוברים לדף Monitoring > Alerting > Policies.

    מעבר ליצירת מדיניות התראות

  2. לוחצים על Select a Metric (בחירת מדד).
  3. מבטלים את הסימון של הלחצן פעיל.

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

  4. בוחרים מדד באופן הבא:
    1. מעתיקים ומדביקים את הטקסט הבא בשדה בדיקת מדד: 
      apigee.googleapis.com/proxy/response_count
    2. בוחרים באפשרות Apigee Proxy.
    3. בחלונית שנפתחת משמאל, בוחרים באפשרות Proxy.
    4. בחלונית הבאה משמאל, בוחרים באפשרות Apigee proxy response count (מספר התגובות של שרת proxy של Apigee).
    5. לוחצים על אישור.
  5. מוסיפים מסנן לקוד התגובה באופן הבא:
    1. לוחצים על הוספת מסנן.
    2. לוחצים על השדה Filter (מסנן) ובוחרים באפשרות response_code (קוד תגובה) מהתפריט הנפתח.
    3. בגורם ההשוואה, בוחרים באפשרות =.
    4. בשדה ערך, מקלידים 200.
    5. לוחצים על אישור.

הגדרת הטריגר של ההתראה

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

  1. בקטע סוג התנאי, בוחרים באפשרות חוסר של מדד.
  2. בשדה Alert trigger (הפעלת התראה), בוחרים באפשרות Any time series violates (כל סדרת זמן חורגת).
  3. בשדה Metric absence time (זמן היעדרות של מדד), בוחרים באפשרות 5 min (5 דקות).
  4. אופציונלי: בשדה שם התנאי, מזינים שם לתנאי.

בהגדרות האלה, תופעל התראה אם ה-proxy לא יקבל קוד תגובה 200 למשך 5 דקות.

לוחצים על הבא כדי לפתוח את החלונית הגדרת התראות וסיום ההתראה.

הגדרת התראה לגבי ההתראה

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

  1. לוחצים על השדה Notification Channels. אם כבר יצרתם ערוץ להתראה, כמו כתובת אימייל או מספר טלפון ל-SMS, תוכלו לבחור אותו בקטע Notification Channels.

    אחרת, צריך להוסיף ערוץ על ידי בחירה באפשרות ניהול ערוצי התראות. ייפתח החלונית Notification channels, שבה אפשר להוסיף ערוץ אחד או יותר. למידע נוסף, ראה ניהול ערוצי התראות. כשמסיימים, חוזרים לחלונית הגדרת התראות וסיום ההתראה.

    הערה: יכול להיות שתצטרכו ללחוץ על לחצן הרענון שליד Manage Notification Channels כדי שערוץ חדש יוצג אחרי שתיצרו אותו.

    אחרי שבוחרים ערוץ התראות אחד או יותר, לוחצים על OK.

  2. בשדה Documentation, אפשר להוסיף הודעה שתצורף להתראה. לדוגמה, ההודעה עשויה לתאר את הסיבה להתראה ולכלול קישורים לתיעוד עם הסבר על אופן התגובה.
  3. לוחצים על הבא כדי לבדוק את פרטי ההתראה. אם אתם מרוצים מהם, לוחצים על Create Policy כדי ליצור את מדיניות ההתראות.

התראה על עלייה חדה בתנועה

בקטעים הבאים מוסבר איך ליצור התראה שמופעלת כשמספר בקשות ה-API במהלך דקה אחת עולה על 3,600.

כדי ליצור את ההתראה:

  1. במסוף Google Cloud , עוברים לדף Monitoring > Alerting > Policies.

    מעבר ליצירת מדיניות התראות

  2. לוחצים על Select a Metric (בחירת מדד).
  3. מבטלים את הסימון של הלחצן פעיל.

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

  4. בוחרים מדד באופן הבא:
    1. מעתיקים ומדביקים את הטקסט הבא בשדה בדיקת מדד: 
      apigee.googleapis.com/proxy/request_count
    2. בוחרים באפשרות Apigee Proxy.
    3. בחלונית שנפתחת משמאל, בוחרים באפשרות Proxy.
    4. בחלונית הבאה מימין, בחר ספירת בקשות פרוקסי של Apigee.
    5. לוחצים על אישור.
  5. בחלונית שינוי נתונים:
    • תחת בתוך כל סדרת זמן:
      • בשדה חלון מתגלגל, בחר דקה אחת.
      • בפונקציית חלון מתגלגל, בחר rate.
    • בקטע פעולות על ציר הזמן, בקטע ציר זמן מצטבר, בוחרים באפשרות סכום.

הגדרת הטריגר של ההתראה

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

  1. בקטע סוג התנאי, בוחרים באפשרות סף.
  2. בשדה Alert trigger (הפעלת התראה), בוחרים באפשרות Any time series violates (כל סדרת זמן חורגת).
  3. בשדה Threshold position, בוחרים באפשרות Above threshold.
  4. בשדה ערך הסף, מזינים 60.

הסיבה לכך שהגדרתם את ערך הסף כ-60 (ולא כ-3,600) היא שהיחידות של ערך הסף הן לשנייה. לכן, אם הסף הזה נשמר למשך דקה אחת, יהיו לפחות 3,600 בקשות במהלך התקופה הזו.

עם ההגדרות האלה, תופעל התראה אם המספר הכולל של הבקשות במהלך דקה אחת יעלה על 3,600.

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

התראת השהייה

בדוגמאות הבאות מוצגות דרכים ליצור התראה שמופעלת כשערך האחוזון ה-95 של זמן האחזור הממוצע בתשובות, במרווחי זמן של 10 דקות, גדול מ-600 אלפיות השנייה.

יצירת ההתראה באמצעות Apigee או Apigee Hybrid גרסה 1.12

כדי ליצור את ההתראה באמצעות Apigee:

  1. במסוף Google Cloud , עוברים לדף Monitoring > Alerting > Policies.

    מעבר ליצירת מדיניות התראות

  2. לוחצים על Select a Metric (בחירת מדד).
  3. מבטלים את הסימון של הלחצן פעיל.

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

  4. בוחרים מדד באופן הבא:
    1. מעתיקים ומדביקים את הטקסט הבא בשדה בדיקת מדד: 
      apigee.googleapis.com/proxy/latencies
    2. בוחרים באפשרות Apigee Proxy.
    3. בחלונית שנפתחת משמאל, בוחרים באפשרות Proxy.
    4. בחלונית הבאה משמאל, בוחרים באפשרות Apigee proxy latencies (זמני השהיה של שרת proxy של Apigee).
    5. לוחצים על אישור.
  5. בחלונית שינוי נתונים, בקטע בכל סדרת זמן:
    • בשדה חלון מתגלגל, בחר 10 דקות.
    • בשדה Rolling window function (פונקציית חלון נע), מזינים 95th percentile (המאון ה-95).

במאמר יצירת טריגר להתראה מוסבר איך להגדיר את האירוע שמפעיל את ההתראה.

יצירת ההתראה באמצעות Apigee Hybrid גרסה 1.10 או 1.11

כדי ליצור את ההתראה באמצעות Apigee Hybrid גרסה 1.10 או גרסה 1.11:

  1. במסוף Google Cloud , עוברים לדף Monitoring > Alerting > Policies.

    מעבר ליצירת מדיניות התראות

  2. לוחצים על Select a Metric (בחירת מדד).
  3. מבטלים את הסימון של הלחצן פעיל.

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

  4. בוחרים מדד באופן הבא:
    1. מעתיקים ומדביקים את הטקסט הבא בשדה בדיקת מדד: 
      apigee.googleapis.com/proxyv2/latencies_percentile
    2. בוחרים באפשרות Apigee proxy (v2).
    3. בחלונית שנפתחת משמאל, בוחרים באפשרות Proxyv2.
    4. בחלונית הבאה משמאל, בוחרים באפשרות Percentile of Apigee proxy response latencies (אחוזון של חביון תגובות של שרת proxy של Apigee).
    5. לוחצים על אישור.

  5. מוסיפים מסנן באופן הבא:

    1. לוחצים על הוספת מסנן.
    2. לוחצים על השדה מסנן ובוחרים באפשרות אחוזון מהתפריט הנפתח.
    3. בגורם ההשוואה, בוחרים באפשרות =.
    4. בשדה ערך, מקלידים 95.
    5. לוחצים על אישור.
  6. בחלונית שינוי נתונים, בקטע בכל סדרת זמן:
    • בשדה Rolling window, בוחרים באפשרות 10 min.
    • בשדה Rolling window function (פונקציית חלון נע), מזינים mean (ממוצע).

ראה יצירת טריגר ההתראה כדי להגדיר את האירוע שמפעיל את ההתראה.

הגדרת הטריגר של ההתראה

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

  1. בקטע סוג התנאי, בוחרים באפשרות סף.
  2. בשדה Alert trigger (הפעלת התראה), בוחרים באפשרות Any time series violates (כל סדרת זמן חורגת).
  3. בשדה Threshold position, בוחרים באפשרות Above threshold.
  4. בשדה ערך הסף, מזינים 600.

עם ההגדרות האלה, התראה תופעל כשהאחוזון ה-95 של זמן האחזור יהיה מעל הסף של 600 אלפיות השנייה.

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

כאשר אתם מקבלים התראה ולוחצים על הלחצן הצג ב-Apigee באימייל ההתראה, לוח המחוונים של החקירה יציג גרף השהייה עם הסף, בדומה לדוגמה המוצגת: בחר מדד.