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

מוצג המסמך של 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%. אפשר לבחור מרווח זמן של: שעה אחת יום אחד שבוע אחד
   מאפיין	לוחצים על +הוספת מאפיין ומציינים את פרטי המאפיין שעבורו יוחזרו התוצאות, כולל את שרת ה-proxy והאזור של ה-API. הגדרת מאפיין ספציפי כ: שרת proxy – הגדרה של שרת proxy ספציפי או כל שרתי ה-proxy. שרת proxy לא תומך בערך 'הכול'. במקום זאת תוכלו להוסיף התראה נפרדת לכל שרת 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. אם הוספתם התראה, צריך להגדיר את השדות הבאים:

   שדה	תיאור
   Playbook	(אופציונלי) שדה טקסט חופשי שמספק תיאור קצר של פעולות מומלצות טיפול בהתראות כשהן מופעלות. אפשר גם לציין קישור לוויקי הפנימי או דף קהילה שבו אתם מפנים לשיטות מומלצות. המידע בשדה הזה יהיה שכלול בהודעה. התוכן בשדה הזה לא יכול לחרוג מ-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 – מציין את סוג המשנה של ההתראה שיוחזרו. ערך ברירת המחדל לא מוגדר, כלומר יוצגו כל סוגי המשנה של ההתראות.

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

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.