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

אתם קוראים את מאמרי העזרה של Apigee Edge.
כדאי לעיין במסמכי העזרה בנושא Apigee X. מידע

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

אתם מגדירים את טווח הזמן כך:

  • שעה אחת
  • יום אחד
  • 7 ימים
  • ‫15 ימים (API בלבד)
  • ‫30 ימים (API בלבד)

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

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

ערך חיובי מציין שהתנועה גדלה, וערך שלילי מציין שהתנועה קטנה.

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

לפני שמגדירים את האחוז הזה, חשוב לוודא שהוא תואם לדפוסי התנועה הרגילים שלכם. לדוגמה, אם בדרך כלל יש תנודות בתנועת הגולשים ב-API במהלך היום, עם עליות חדות בתנועת הגולשים של עד 100% בשעות מסוימות של שיא, העליות האלה הן נורמליות ולא אמורות להפעיל התראה. עם זאת, אם תגדירו התראה שתופעל בכל עלייה של 50% בתנועה השעתית, תקבלו התראות מיותרות לגבי התנועה הרגילה.

מידע נוסף על התראות זמין במאמר הגדרת התראות והודעות.

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

כדי להוסיף התראות על מצב התנועה:
  1. בממשק המשתמש של Edge, לוחצים על Analyze > Alert Rules (ניתוח > כללי התראה).
  2. לוחצים על +התראה.
  3. מזינים את הפרטים הכלליים הבאים לגבי ההתראה:
    שדה תיאור
    שם התראה שם ההתראה. חשוב להשתמש בשם שמתאר את הטריגר ושיהיה בעל משמעות עבורכם. השם לא יכול להכיל יותר מ-128 תווים.
    תיאור תיאור ההתראה.
    סוג התראה בוחרים באפשרות סך כל התנועה. מידע נוסף זמין במאמר מידע על סוגי התראות.
    סביבה בוחרים את הסביבה מהרשימה הנפתחת.
    סטטוס מפעילים או משביתים את ההתראה.
  4. מגדירים את הסף ואת המאפיין של התנאי שיפעיל את ההתראה.
    שדה תנאי תיאור
    סף

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

    מגדירים את אחוז ההעלאה לערך שגדול מ-0% או שווה לו. מגדירים את הערך של הנחה באחוזים כערך שגדול מ-0% או שווה לו, וקטן מ-100% או שווה לו.

    אפשר לבחור מרווח זמן של:

    • שעה אחת
    • יום אחד
    • שבוע אחד
    מאפיין

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

    הגדרת מאפיין ספציפי לערך:

    • Proxy (שרת proxy) – הגדרה של שרת proxy ספציפי או של All (כל) שרתי ה-proxy. Proxy לא תומך בערך Any. במקום זאת, אפשר להוסיף התראה נפרדת לכל שרת proxy שמעניין אתכם.
    • Region – הגדרה של אזור ספציפי או של All regions (כל האזורים). הערך Any לא נתמך במאפיין אזור. במקום זאת, אתם יכולים להוסיף התראה נפרדת לכל אזור שמעניין אתכם.
  5. כדי להוסיף התראה, לוחצים על + התראה.
    פרטי ההודעה תיאור
    ערוץ בוחרים את ערוץ ההתראות שרוצים להשתמש בו ומציינים את היעד: אימייל, Slack,‏ PagerDuty או Webhook.
    יעד מציינים את היעד בהתאם לסוג הערוץ שנבחר:
    • אימייל – כתובת אימייל, כמו [email protected]
    • ‫Slack – כתובת ה-URL של ערוץ Slack, לדוגמה https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – קוד PagerDuty, כמו abcd1234efgh56789
    • Webhook – כתובת ה-URL של ה-webhook, כמו https://apigee.com/test-webhook

      הערה: אפשר לציין רק יעד אחד לכל התראה. כדי לציין כמה יעדים לאותו סוג ערוץ, מוסיפים עוד התראות.
  6. כדי להוסיף עוד תזכורות, חוזרים על השלב הקודם.
  7. אם הוספתם התראה, צריך להגדיר את השדות הבאים:
    שדה תיאור
    Playbook (אופציונלי) שדה טקסט חופשי שבו אפשר לספק תיאור קצר של פעולות מומלצות לפתרון הבעיות שגורמות להפעלת ההתראות. אפשר גם לציין קישור לוויקי הפנימי או לדף הקהילה שבו מפורטות שיטות מומלצות. המידע בשדה הזה ייכלל בהתראה. התוכן בשדה הזה לא יכול להיות ארוך מ-1,500 תווים.
    משנק התדירות שבה נשלחות ההתראות. בוחרים ערך מהרשימה הנפתחת.
  8. לוחצים על שמירה.

צפייה בהתראות בלוח הבקרה 'אירועים'

כש-Edge מזהה תנאי להתרעה, הוא מתעד אוטומטית את התנאי הזה בלוח הבקרה Events בממשק המשתמש של Edge. רשימת האירועים שמוצגת בלוח הבקרה 'אירועים' כוללת את כל ההתראות, גם אלה שתוקנו וגם אלה שקשורות לאישור.

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

  1. בממשק המשתמש של Edge, לוחצים על Analyze > Events (ניתוח > אירועים). מוצגת לוח הבקרה החדש של אירועים:

  2. אפשר לסנן את לוח הבקרה 'אירועים' לפי:

    • סביבה
    • אזור
    • תקופה
  3. בוחרים שורה בלוח הבקרה של האירועים כדי להציג את מאגר המפתחות שמכיל את האישור שתוקפו עומד לפוג, כדי להמשיך לבדוק את ההתראה. בדף 'מאגר מפתחות' אפשר להעלות אישור חדש ולמחוק את האישור שתוקפו עומד לפוג.

שימוש בממשקי ה-API של ההתראות עם התראות על מצב התנועה

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

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

  • קבלת התראות – רשימה של כל ההתראות, כולל התראות על תיקונים והתראות על חריגות.
  • יצירת התראה – יצירת התראה קבועה או התראה על אנומליה.
  • עדכון התראה – עדכון של הגדרת התראה על תיקון או על אנומליה.

יצירה או עדכון של התראת תנועה

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

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

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    ערכי ברירת המחדל של המאפיינים האלה הם:

    "alertType": "runtime"
"alertSubType": "fixed"
  • ברכיב dimensions במערך conditions:
    • חובה להגדיר את הערכים של המאפיינים org, ‏ env, ‏ proxy,‏ region ו-. רק הנכסים האלה נתמכים. אפשר להגדיר את proxy ואת region ל-ALL.
    • צריך להגדיר את הערך של המאפיין traffic ל-total.

  • במערך conditions:

    • הערך של מאפיין metrics חייב להיות trafficChange.
    • המאפיין comparator צריך להיות מוגדר לערך increasedBy או decreasedBy.
    • המאפיין threshold מכיל ערך חיובי שמציין עלייה או ירידה באחוזים בתנועה, כאשר ערך של 1.0 מתאים ל-100%. במקרה של increasedBy, הערך צריך להיות גדול מ-0.0 (0%) או שווה לו. במקרה של decreasedBy, הערך צריך להיות גדול מ-0.0 (0%) או שווה לו, וקטן מ-1.0 (100%) או שווה לו.
    • המאפיין durationSeconds צריך להיות אחד מהערכים הבאים: 3600 (שעה אחת), 86400 (יום אחד), 604800 (7 ימים), 1296000 (15 ימים), 2592000 (30 ימים) .
  • אין תמיכה בנכס reportEnabled בהתראות על תנועה.
בדוגמה הבאה מוצג איך להגדיר התראה שמופעלת כשתנועת הגולשים בארגון ובסביבה גדלה ב-50% במהלך שעה אחת. התראה נשלחת לקוד PagerDuty שצוין כשההתראה מופעלת. 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

מגדירים את $ACCESS_TOKEN לאסימון הגישה מסוג OAuth 2.0, כמו שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות של cURL שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-cURL.

מידע נוסף על השימוש ב-API הזה זמין במאמר הצגת אירועים.

קבלת התראות על מצב התנועה

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

  • ‫enabled – אם true מציין להחזיר רק התראות מופעלות. ערך ברירת המחדל הוא false.
  • ‫alertType – מציין את סוג ההתראה שיוחזר. הערכים המותרים הם runtime (ברירת המחדל) ו-cert.
  • ‫alertSubType – מציין את סוג המשנה של ההתראה שיוחזר. ערך ברירת המחדל לא מוגדר, כלומר כל סוגי המשנה של ההתראות יוחזרו.

לדוגמה, כדי להחזיר רק התראות מופעלות לארגון בשם myorg, משתמשים בקריאה הבאה ל-API:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

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

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

מגדירים את $ACCESS_TOKEN לאסימון הגישה מסוג OAuth 2.0, כמו שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות של cURL שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-cURL.