הגדרת הודעות והתראות

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

תנאי ההתראה מגדירים סף מסוים של קוד סטטוס (לדוגמה, 404/502/2xx/4xx/5xx), זמן אחזור וקוד שגיאה. אם חורגים מהסף הזה, מוצגות התראות חזותיות בממשק המשתמש ונשלחות התראות במגוון ערוצים, כמו אימייל, Slack, ‏ PagerDuty או Webhook. אפשר להגדיר התראות ברמת הסביבה, ברמת ה-API proxy או שירות היעד, או ברמת האזור. כשמופעלת התראה, תקבלו הודעה בשיטה שהגדרתם כשהוספתם התראות והודעות.

לדוגמה, יכול להיות שתרצו להפעיל התראה ולשלוח הודעה לצוות התפעול כששיעור השגיאות מסוג 5xx חורג מ-23% למשך 5 דקות ב-proxy ל-API של orders-prod שנפרס בסביבת הייצור.

באיור הבא אפשר לראות איך ההתראות מוצגות בממשק המשתמש:

בהמשך מופיעה דוגמה להתראה באימייל שאולי תקבלו כשמופעלת התראה.

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

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

בקטעים הבאים מוסבר איך להגדיר ולנהל התראות.

מידע על סוגי התראות

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

לדוגמה, אפשר להגדיר התראה קבועה במקרים הבאים:

• ‫[rate of 5xx errors] [is greater than] [10%] for [10 minutes] from [target mytarget1]
• ‫[count of 2xx errors] [is less than] [50] for [5 minutes] in [region us-east-1]
• ‫[p90 latency] [is greater than] [750ms] for [10 minutes] on [proxy myproxy1]

גרסת הבטא של דוחות האבטחה 19.11.13 כוללת סוגים חדשים של התראות:

• התראות על אנומליות (בטא). סוג התראה שבו Edge מזהה בעיות בתנועה ובביצועים במקום שאתם תצטרכו לקבוע אותן מראש בעצמכם. אחר כך אפשר להגדיר התראה לגבי האנומליות האלה.
• התראות על תוקף TLS (בטא). סוג התראה שמאפשר להציג התראות כשאישור TLS מתקרב למועד התפוגה.

הכלי למעקב אחר API תומך עכשיו בכמה סוגים של התראות, ולכן בתיבת הדו-שיח Create Alert (יצירת התראה) מוצגת עכשיו האפשרות לבחור את סוג ההתראה:

הצגת הגדרות ההתראות

כדי לראות את הגדרות ההתראות שמוגדרות כרגע, לוחצים על Analyze > Alert Rules בממשק המשתמש של Edge.

דף ההתראה מוצג, כמו באיור הבא:

כפי שמודגש באיור, בדף ההתראות אפשר:

• הצגת סיכום של הגדרות ההתראות שמוגדרות כרגע
• צפייה בהיסטוריית ההתראות שהופעלו
• הוספת התראות
• יצירת דוח בהתאמה אישית מתוך התראה
• הפעלה או השבתה של התראה
• עריכת התראה
• מחיקת התראה
• חיפוש מחרוזת מסוימת ברשימת ההתראות

צפייה בהיסטוריית ההתראות שהופעלו בארגון

כדי לראות את היסטוריית ההתראות שהופעלו בארגון ב-24 השעות האחרונות, לוחצים על Analyze > Alert Rules בממשק המשתמש של Edge ואז על הכרטיסייה History.

יוצג הדף 'היסטוריית ההתראות'.

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

הוספת התראות

כדי להוסיף התראות ותזכורות:

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

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

4. מגדירים את המדד, ערך הסף והמאפיין של התנאי הראשון שיפעיל את ההתראה.

   שדה התנאי	תיאור
   מדד	בוחרים אחד מהמדדים הבאים: קוד סטטוס: בוחרים קוד סטטוס מהרשימה, כמו 401,‏ 404,‏ 2xx,‏ 4xx או 5xx HTTP. הערה: ה-API מאפשר להגדיר טווח רחב יותר של קודי סטטוס. אפשר להשתמש ב-API כדי לציין כל קוד סטטוס בין 200 ל-299, בין 400 ל-599, וערכי wildcard של 2xx,‏ 4xx או 5xx. איך יוצרים התראה להתראות על הגבלת קצב (קוד סטטוס של HTTP‏ 429), צריך להגדיר את המדד כקוד שגיאה של Spike Arrest. אפשר להשתמש במדיניות AssignMessage כדי לשכתב את קוד התגובה של HTTP, משגיאת proxy או משגיאת יעד. הכלי 'מעקב אחר API' מתעלם מקודים שנכתבו מחדש ומתעד את קודי תגובת ה-HTTP בפועל. זמן אחזור: בוחרים ערך של זמן אחזור מהרשימה הנפתחת. באופן ספציפי: p50 (אחוזון 50), p90 (אחוזון 90), p95 (אחוזון 95) או p99 (אחוזון 99). לדוגמה, בוחרים באפשרות p95 כדי להגדיר התראה שמופעלת כשחביון התגובה לאחוזון ה-95 גבוה מסף שהגדרתם בהמשך. קוד תקלה: בוחרים קטגוריה, קטגוריית משנה וקוד תקלה מהרשימה. אפשר גם לבחור אחת מהאפשרויות הבאות בתוך קטגוריה או קטגוריית משנה: הכול – הסכום הכולל המשולב של כל קודי התקלה בקטגוריה או בקטגוריית המשנה הזו צריך לעמוד בקריטריונים של המדד. כל – קוד תקלה יחיד בקטגוריה או בקטגוריית המשנה הזו צריך לעמוד בקריטריונים של המדד. מידע נוסף זמין בחומר העזר בנושא קודי תקלות.
   סף	הגדרת סף למדד שנבחר: קוד סטטוס: הגדרת ערך הסף כאחוז, כספירה או כעסקאות לשנייה (TPS) לאורך זמן. זמן אחזור: בוחרים את ערך הסף כמשך זמן אחזור כולל או יעד (באלפיות השנייה) לאורך זמן. במקרה כזה, תופעל התראה אם חביון האחוזון שצוין, שמתעדכן כל דקה אם יש תעבורת נתונים, חורג מתנאי הסף לטווח הזמן שכולל את משך הזמן שצוין. כלומר, תנאי הסף לא מצטבר על פני כל משך הזמן. קוד שגיאה: מגדירים את ערך הסף כאחוז, כספירה או כעסקאות לשנייה (TPS) לאורך זמן.
   מאפיין	לוחצים על +הוספת מאפיין ומציינים את פרטי המאפיין שעבורו רוצים לקבל תוצאות, כולל שרת ה-proxy של ה-API, שירות היעד או אפליקציית המפתחים והאזור. אם מגדירים מאפיין ספציפי ל: All – כל הישויות במאפיין צריכות לעמוד בקריטריונים של המדד. אי אפשר לבחור באפשרות הכול למדד מסוג חביון. כל – רלוונטי רק לאזור. ישות במאפיין צריכה לעמוד בקריטריונים של המדד באזור אחד לפחות. הערה: בשביל שרתי proxy של API או שירותי יעד, בוחרים באוסף כדי לתמוך בכל הפונקציות. אוספים – בוחרים אוסף מהרשימה כדי לציין את קבוצת שרתי ה-proxy של ה-API או שירותי היעד. במקרה כזה, כל ישות באוסף צריכה לעמוד בקריטריונים. אם מגדירים את המאפיין Target, אפשר לבחור שירות יעד או את השירות שצוין על ידי מדיניות ServiceCallout. יעד של מדיניות ServiceCallout מוצג כערך עם הקידומת sc://‎. לדוגמה, sc://my.endpoint.net.

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

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

6. כדי להוסיף עוד תנאים, לוחצים על + הוספת תנאי וחוזרים על שלבים 4 ו-5.

   הערה: אם מציינים כמה תנאים, ההתראה תופעל כשכל התנאים יתקיימו.

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

   מידע נוסף זמין במאמר יצירת דוח בהתאמה אישית מתוך התראה.

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

8. לוחצים על + Notification (הוספת התראה) כדי להוסיף התראה.

   פרטי ההתראה	תיאור
   ערוץ	בוחרים את ערוץ ההתראות שרוצים להשתמש בו ומציינים את היעד: אימייל, 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. במאמר פורמט של אובייקט webhook מופיע תיאור של האובייקט שנשלח לכתובת ה-URL. להעביר את פרטי הכניסה בכתובת ה-URL של ה-Webhook. לדוגמה: https://apigee.com/test-webhook?auth_token=1234_abcd. אפשר לציין את כתובת ה-URL של נקודת קצה שיכולה לנתח את אובייקט ה-Webhook כדי לשנות או לעבד אותו. לדוגמה, אפשר לציין את כתובת ה-URL של API, כמו Edge API, או של כל נקודת קצה אחרת שיכולה לעבד את האובייקט. הערה: אפשר לציין רק יעד אחד לכל התראה. כדי לציין כמה יעדים לאותו סוג ערוץ, מוסיפים עוד התראות.

9. כדי להוסיף עוד תזכורות, חוזרים על שלב 8.
10. אם הוספתם התראה, צריך להגדיר את השדות הבאים:

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

11. לוחצים על שמירה.

פורמט אובייקט של webhook

{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

המאפיינים thresholdViolations ו-thresholdViolationsFormatted מכילים פרטים על ההתראה. המאפיין thresholdViolations מכיל מחרוזת אחת עם הפרטים, ואילו המאפיין thresholdViolationsFormatted מכיל אובייקט שמתאר את ההתראה. בדרך כלל משתמשים במאפיין thresholdViolationsFormatted כי קל יותר לפענח אותו.

בדוגמה שלמעלה מוצג התוכן של המאפיינים האלה עבור התראה קבועה כשמגדירים את מדד ההתראה להפעלה על סמך קוד הסטטוס HTTP 2xx, כפי שמצוין במאפיין statusCode.

התוכן של המאפיינים האלה תלוי בסוג ההתראה, למשל קבועה או אנומליה, ובהגדרה הספציפית של ההתראה. לדוגמה, אם יוצרים התראה קבועה על סמך קוד תקלה, מאפיין thresholdViolationsFormatted מכיל מאפיין faultCode במקום מאפיין statusCode.

בטבלה הבאה מוצגים כל המאפיינים האפשריים של thresholdViolationsFormatted הנכס לסוגים שונים של התראות:

metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation

metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation

metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation

envName, certificateName, thresholdValue, violation

יצירת דוח בהתאמה אישית מתוך התראה

כדי ליצור דוח בהתאמה אישית מתוך התראה:

1. כשיוצרים התראה, לוחצים על Create an API analytics reports based on alert conditions (יצירת דוחות ניתוח של API על סמך תנאי ההתראה), כמו שמתואר במאמר הוספת התראות והודעות.

   אחרי ששומרים את ההתראה, ההודעה הבאה מוצגת בממשק המשתמש:

   Alert alertName saved successfully. To customize the report generated, click here.

   לוחצים על ההודעה כדי לפתוח את הדוח בכרטיסייה חדשה עם שדות רלוונטיים שאוכלסו מראש. כברירת מחדל, השם של הדוח בהתאמה אישית הוא: API Monitoring Generated alertName

2. עורכים את הדוח בהתאמה אישית לפי הצורך ולוחצים על שמירה.
3. לוחצים על שם הדוח ברשימה ומריצים את הדוח המותאם אישית.

כדי לנהל את הדוח המותאם אישית שנוצר על סמך תנאי ההתראה:

1. בממשק המשתמש של Edge, לוחצים על Analyze > Alert Rules (ניתוח > כללי התראות).
2. לוחצים על הכרטיסייה הגדרות.
3. בעמודה 'דוחות', לוחצים על הדוח המותאם אישית שמשויך להתראה שרוצים לנהל.

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

4. עורכים את הדוח בהתאמה אישית לפי הצורך ולוחצים על שמירה.
5. לוחצים על שם הדוח ברשימה ומריצים את הדוח המותאם אישית.

הפעלה או השבתה של התראה

כדי להפעיל או להשבית התראה:

1. בממשק המשתמש של Edge, לוחצים על Analyze > Alert Rules (ניתוח > כללי התראות).
2. לוחצים על המתג בעמודה 'סטטוס' שמשויך להתראה שרוצים להפעיל או להשבית.
   

עריכת התראה

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

1. בממשק המשתמש של Edge, לוחצים על Analyze > Alert Rules (ניתוח > כללי התראות).
2. לוחצים על שם ההתראה שרוצים לערוך.
3. עורכים את ההתראה לפי הצורך.
4. לוחצים על שמירה.

מחיקת התראה

כדי למחוק התראה:

1. בממשק המשתמש של Edge, לוחצים על Analyze > Alert Rules (ניתוח > כללי התראות).
2. ממקמים את הסמן מעל ההתראה שרוצים למחוק ולוחצים על בתפריט הפעולות.

התראות מוצעות

מומלץ להגדיר את ההתראות הבאות ב-Apigee כדי לקבל הודעה על בעיות נפוצות. חלק מההתראות האלה ספציפיות להטמעה של ממשקי ה-API שלכם, והן שימושיות רק במצבים מסוימים. לדוגמה, חלק מההתראות שמוצגות בהמשך רלוונטיות רק אם משתמשים במדיניות ServiceCallout או במדיניות JavaCallout.

הגדרת התראה על קוד סטטוס 5xx ל-proxy ל-API

בדוגמה הבאה מוסבר איך להגדיר התראה באמצעות ממשק המשתמש, שתופעל אם מספר הטרנזקציות לשנייה (TPS) של קודי סטטוס 5xx עבור proxy ל-API של Hotels יעלה על 100 למשך 10 דקות באזור כלשהו. מידע נוסף זמין במאמר הוספת התראות.

מידע על השימוש ב-API זמין במאמר הגדרת התראה על קוד סטטוס 5xx ל-proxy באמצעות ה-API.

הגדרת התראה על חביון P95 לשרת proxy של API

בהמשך מופיעה דוגמה להגדרת התראה באמצעות ממשק המשתמש, שמופעלת כשחביון התגובה הכולל לאחוזון ה-95 גדול מ-100 אלפיות השנייה למשך 5 דקות עבור proxy ל-API של Hotels בכל אזור. מידע נוסף זמין במאמר הוספת התראות.

במאמר הגדרת התראה על זמן אחזור של P95 ל-proxy ל-API באמצעות ה-API מוסבר איך משתמשים ב-API.

הגדרת התראה על שגיאת 404 (האפליקציה לא נמצאה) לכל שרתי ה-API proxy

בדוגמה הבאה מוסבר איך להגדיר התראה באמצעות ממשק המשתמש, שמופעלת כששיעור קודי הסטטוס 404 לכל שרתי ה-API הפרוקסי עולה על 5% למשך 5 דקות בכל אזור. מידע נוסף זמין במאמר הוספת התראות.

במאמר הגדרת התראה על שגיאה 404 (האפליקציה לא נמצאה) לכל שרתי ה-proxy של ה-API באמצעות ה-API מוסבר איך משתמשים ב-API.

הגדרת התראה על מספר שרתי proxy ל-API

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

• הוספת התראות
• ניהול האוספים

במאמר הגדרת התראה על מספר שרתי proxy ל-API עבור ממשקי API באמצעות ה-API מוסבר איך משתמשים ב-API.

הגדרת התראה על שיעור שגיאות בשירותים מטורגטים

בדוגמה הבאה מוסבר איך להגדיר התראה באמצעות ממשק המשתמש, שתופעל כששיעור הקוד 500 בשירותי היעד יעלה על 10% למשך שעה בכל אזור. בדוגמה הזו, שירותי היעד נכללים באוסף Critical targets. מידע נוסף זמין בדפים הבאים:

• הוספת התראות
• ניהול האוספים

במאמר הגדרת התראה על שיעור שגיאות בשירותי יעד באמצעות ה-API מוסבר איך משתמשים ב-API.

הגדרת התראה על שיעור שגיאות למדיניות ServiceCallout

בדוגמה הבאה מוצג איך להגדיר התראה באמצעות ממשק המשתמש, שתופעל כששיעור קוד 500 בשירות שצוין על ידי מדיניות ServiceCallout יעלה על 10% למשך שעה בכל אזור. מידע נוסף זמין בדפים הבאים:

• הוספת התראות

במאמר הגדרת התראה על שיעור שגיאות למדיניות Service Callout באמצעות API מוסבר איך משתמשים ב-API.

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

בדוגמה הבאה מוצג איך להגדיר התראה באמצעות ממשק המשתמש, שתופעל כשJWT AlgorithmMismatch מספר קודי השגיאה של מדיניות VerifyJWT יהיה גדול מ-5 למשך 10 דקות בכל ממשקי ה-API. מידע נוסף זמין בדפים הבאים:

• הוספת התראות
• ניהול האוספים

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