הגדרת התראות

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

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

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

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

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

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

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

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

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

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

לדוגמה, אפשר להציג התראה תוקנה כאשר:

• [שיעור השגיאות של 5xx] [גדול מ-] [10%] למשך [10 דקות] מ-[target mytarget1]
• [ספירה של 2xx שגיאות] [פחות מ-] [50] למשך [5 דקות] ב[region us-east-1]
• [זמן אחזור של p90] [גדול מ-] [750ms] למשך [10 דקות] ב-[proxy myproxy1]

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

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

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

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

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

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

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

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

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

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

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

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

הוספת התראות והודעות

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

1. בממשק המשתמש של Edge, לוחצים על ניתוח > כללי התראות.
2. לוחצים על +התראה.
3. מזינים את המידע הכללי הבא לגבי ההתראה:

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

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

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

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

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

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

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

7. אם רוצים ליצור דוח בהתאמה אישית על סמך תנאי ההתראה שהגדרתם, צריך ללחוץ על Create an API Analytics Reports על סמך תנאי התראות. אפשרות זו מופיעה באפור אם אינך מנהל מערכת בארגון.

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

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

8. לוחצים על + התראה כדי להוסיף תזכורת.

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

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

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

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

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

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

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

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

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

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

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

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

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

1. בממשק המשתמש של Edge, לוחצים על ניתוח > כללי התראות.
2. לחץ על לחצן החלפת המצב בעמודה 'סטטוס' המשויכת להתראה שברצונך להפעיל או להשבית.
   

עריכת התראה

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

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

מחיקת התראה

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

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

הצעות להתראות

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

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

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

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

הגדרת התראה על זמן אחזור של P95 לשרת proxy של API

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

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

הגדרת התראת 404 (היישום לא נמצא) לכל שרתי ה-API של ממשק ה-API

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

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

הגדרת התראה לגבי ספירת שרתי proxy של API עבור ממשקי API

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

• הוספת התראות והודעות
• ניהול הקולקציות

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

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

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

• הוספת התראות והודעות
• ניהול הקולקציות

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

הגדרת התראה על שיעור שגיאות במדיניות בנושא יתרונות מרכזיים של שירות

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

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

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

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

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

• הוספת התראות והודעות
• ניהול הקולקציות

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