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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

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

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

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

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

ערך חיובי פירושו שהתנועה עלתה, וערך שלילי פירושו שהתנועה ירדה.

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

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

למידע נוסף על התראות, ראה הגדרת התראות והודעות.

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

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

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

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

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

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

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

    מגדירים מאפיין ספציפי כדי:

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

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

הצגת התראות במרכז הבקרה 'אירועים'

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

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

  1. לוחצים על ניתוח > אירועים בממשק המשתמש של Edge. מרכז הבקרה החדש 'אירועים' יופיע:

  2. סינון מרכז הבקרה 'אירועים' לפי:

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

שימוש בממשקי ה-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.