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

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

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

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

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

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

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

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

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

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

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

ניתן להגדיר התראת תפוגה:

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

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

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

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

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

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

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

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

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

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

לדוגמה, כדי להחזיר התראות עבור הארגון 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=cert&alertSubType=certfixed'

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