הגדרת התראות לגבי תפוגה

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

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

מידע על אישורי TLS

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

אישור TLS הוא קובץ דיגיטלי שמזהה ישות בעסקת TLS. ‫Edge משתמש באישור TLS כדי להגדיר TLS עבור:

• גישה ל-API proxies שלכם על ידי לקוחות API. משתמשים במארחים וירטואליים כדי להגדיר TLS.
• גישה לשירותים לקצה העורפי באמצעות Edge. משתמשים בנקודות קצה (endpoints) ושרתי יעד במעבד ההודעות של Edge כדי להגדיר TLS.

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

מידע על התראות לגבי תפוגה

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

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

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

• יום לפני שתוקף האישור יפוג
• ‫14 ימים לפני שתוקף האישור יפוג
• 30 ימים לפני שתוקף האישור יפוג

הוספת התראות ותזכורות על תפוגה

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

   שדה	תיאור
   שם התראה	שם ההתראה. חשוב להשתמש בשם שמתאר את הטריגר ושיהיה בעל משמעות עבורכם. השם לא יכול להכיל יותר מ-128 תווים.
   תיאור	תיאור ההתראה.
   סוג התראה	בוחרים באפשרות TLS Expiry (תפוגה של TLS). מידע נוסף מופיע במאמר מידע על סוגי התראות.
   סביבה	בוחרים את הסביבה מהרשימה הנפתחת.
   סטטוס	מפעילים או משביתים את ההתראה.

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

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

5. לוחצים על + 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 הערה: אפשר לציין רק יעד אחד לכל התראה. כדי לציין כמה יעדים לאותו סוג ערוץ, מוסיפים עוד התראות.

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

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

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

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

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

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

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

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

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

שימוש בממשקי ה-API של ההתראות עם התראות על תפוגה

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

• קבלת התראה – קבלת הגדרה של התראה קבועה או התראה על אנומליה.
• קבלת היסטוריית התראות – קבלת מדדים של היסטוריית התראות.
• מחיקת התראה – מחיקה של הגדרת התראה קבועה או התראה על אנומליה.
• ‫Get alert instance (קבלת מופע של התראה) – קבלת מידע על התראה שהופעלה.
• קבלת מספר ההתראות – קבלת המספר הכולל של ההתראות.

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

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

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

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

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

  "alertType": "cert"
  "alertSubType": "certfixed"

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

  "alertType": "runtime"
  "alertSubType": "fixed"

• במערך conditions:

  • במאפיין metrics אפשר להשתמש רק בערכים expiration.
  • משתמשים במאפיין gracePeriodSeconds כדי לציין את טווח הזמן של תפוגת האישור בשניות, עד למשך מקסימלי של 30 ימים.
  • אין תמיכה במאפיינים threshold, durationSeconds ו-comparator.
• ברכיב dimensions במערך conditions:
  • חובה להגדיר את הערך של המאפיין certificate בתור ANY.
  • חובה להגדיר את הערך של המאפיין proxy בתור ALL.
  • המאפיינים statusCode, ‏ developerApp, ‏ collection, ‏ faultCodeCategory,‏ faultCodeSubCategory, ‏ faultCodeName לא נתמכים.
• אין תמיכה במאפיין reportEnabled בהתראות על תפוגה.

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

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 Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

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

קבלת התראות על תוקף

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

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

לדוגמה, משתמשים בקריאה הבאה ל-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=cert&alertSubType=certfixed'

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