ตั้งค่าการแจ้งเตือน

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X
ข้อมูล

เงื่อนไขการแจ้งเตือนจะกำหนดรหัสสถานะเฉพาะ (เช่น 404/502/2xx/4xx/5xx) เกณฑ์เวลาในการตอบสนอง และโค้ดข้อผิดพลาด ซึ่งเมื่อเกินจะทำให้มีการแจ้งเตือนด้วยภาพใน UI และส่งการแจ้งเตือนผ่านช่องทางต่างๆ เช่น อีเมล, Slack, PagerDuty หรือเว็บฮุค คุณสามารถตั้งค่าการแจ้งเตือนในระดับสภาพแวดล้อม พร็อกซี API หรือบริการเป้าหมาย หรือภูมิภาค เมื่อมีการแจ้งเตือน คุณจะได้รับการแจ้งเตือนโดยใช้วิธีที่คุณกำหนดไว้เมื่อเพิ่มการแจ้งเตือน

ตัวอย่างเช่น คุณอาจต้องการทริกเกอร์การแจ้งเตือนและส่งการแจ้งเตือนไปยังทีมปฏิบัติการเมื่ออัตราข้อผิดพลาด 5xx เกิน 23% ในช่วงเวลา 5 นาทีสำหรับพร็อกซีของ อย่าลืมรัฐ และใช้ API ของคำสั่งซื้อที่ใช้งานได้กับสภาพแวดล้อมการใช้งานจริงของคุณ

รูปต่อไปนี้แสดงวิธีที่การแจ้งเตือนแสดงใน UI

ต่อไปนี้เป็นตัวอย่างการแจ้งเตือนทางอีเมลที่คุณอาจได้รับเมื่อมีการเรียกให้แสดงการแจ้งเตือน

ภายในเนื้อหาของการแจ้งเตือน ให้คลิกลิงก์ต่อไปนี้เพื่อดูข้อมูลเพิ่มเติม

  • ดูรายละเอียดเพื่อดูรายละเอียดเพิ่มเติม รวมถึงการตั้งค่าการแจ้งเตือนและกิจกรรมของแต่ละเงื่อนไขในชั่วโมงที่ผ่านมา
  • คําจํากัดความของการแจ้งเตือนเพื่อดูคําจํากัดความของการแจ้งเตือน
  • ประวัติการแจ้งเตือน เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับการแจ้งเตือนนั้นๆ
  • ดู Playbook เพื่อดูการดำเนินการที่แนะนำ (หากมี)
  • ดูรายงานการวิเคราะห์ API เพื่อดูรายงานที่กำหนดเองสำหรับเงื่อนไขการแจ้งเตือน

ส่วนต่อไปนี้จะอธิบายวิธีการตั้งค่าและจัดการการแจ้งเตือน

เกี่ยวกับประเภทการแจ้งเตือน

การเปิดตัว API Monitoring รุ่นแรกจะให้คุณสร้างกฎที่อิงตามรูปแบบซึ่งจะระบุเวลาที่ควรเพิ่มการแจ้งเตือนโดยอิงตามชุดเงื่อนไขที่กำหนดไว้ล่วงหน้า การแจ้งเตือนประเภทนี้เรียกว่าการแจ้งเตือนคงที่ และเป็นการแจ้งเตือนประเภทเดียวที่รองรับใน API Monitoring รุ่นแรก

เช่น คุณจะเพิ่มการแจ้งเตือนคงที่ได้ในกรณีต่อไปนี้

  • [อัตราข้อผิดพลาด 5xx] [มากกว่า] [10%] เป็นเวลา [10 นาที] จาก [target mytarget1]
  • [จำนวนข้อผิดพลาด 2xx] [น้อยกว่า] [50] เป็นเวลา [5 นาที] ใน [ภูมิภาค us-east-1]
  • [เวลาในการตอบสนอง p90] [มากกว่า] [750ms] เป็นเวลา [10 นาที] ใน [proxy myproxy1]

การรายงานความปลอดภัยเวอร์ชันเบต้า 19.11.13 มีการเพิ่มการแจ้งเตือนประเภทใหม่ดังนี้

  • การแจ้งเตือนการเข้าชมทั้งหมด (เบต้า) ประเภทการแจ้งเตือนที่ให้คุณเพิ่มการแจ้งเตือนเมื่อการรับส่งข้อมูลเปลี่ยนแปลงตามเปอร์เซ็นต์ที่ระบุในช่วงเวลาหนึ่งๆ
  • การแจ้งเตือนความผิดปกติ (เบต้า) ประเภทการแจ้งเตือนที่ Edge จะตรวจพบปัญหาด้านการเข้าชมและประสิทธิภาพแทนที่จะต้องระบุปัญหาด้วยตัวเอง จากนั้นคุณจะเพิ่มการแจ้งเตือนสำหรับความผิดปกติเหล่านี้ได้
  • การแจ้งเตือนการหมดอายุ TLS (เบต้า) ประเภทการแจ้งเตือนที่ช่วยให้คุณส่งการแจ้งเตือนเมื่อใบรับรอง TLS ใกล้หมดอายุ

เนื่องจากตอนนี้ API Monitoring รองรับการแจ้งเตือนหลายประเภท กล่องโต้ตอบสร้างการแจ้งเตือนจึงแสดงตัวเลือกให้เลือกประเภทการแจ้งเตือน ดังนี้

กล่องโต้ตอบสร้างการแจ้งเตือนมีการแจ้งเตือนหลายประเภทแล้ว

ดูการตั้งค่าการแจ้งเตือน

หากต้องการดูการตั้งค่าการแจ้งเตือนที่กำหนดไว้ในปัจจุบัน ให้คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI

หน้าการแจ้งเตือนจะปรากฏขึ้น ดังที่แสดงในรูปต่อไปนี้

อีเมลแจ้งเตือน

ดังที่ไฮไลต์ในรูป หน้าการแจ้งเตือนช่วยให้คุณทําสิ่งต่อไปนี้ได้

ดูประวัติการแจ้งเตือนที่ทริกเกอร์สำหรับองค์กรของคุณ

หากต้องการดูประวัติการแจ้งเตือนที่ทริกเกอร์สำหรับองค์กรในช่วง 24 ชั่วโมงที่ผ่านมา ให้คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI แล้วคลิกแท็บประวัติ

หน้าประวัติการแจ้งเตือนจะปรากฏขึ้น

ประวัติการแจ้งเตือน

คลิกชื่อการแจ้งเตือนเพื่อดูรายละเอียดของการแจ้งเตือนในหน้าแดชบอร์ดการตรวจสอบ คุณสามารถกรองรายการโดยค้นหาชื่อการแจ้งเตือนทั้งหมดหรือบางส่วนก็ได้

เพิ่มการแจ้งเตือน

วิธีเพิ่มการแจ้งเตือน

  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. คลิก +การแจ้งเตือน
  3. ป้อนข้อมูลทั่วไปเกี่ยวกับการแจ้งเตือนดังนี้
    ฟิลด์ คำอธิบาย
    ชื่อข้อความแจ้งเตือน ชื่อการแจ้งเตือน ใช้ชื่อที่อธิบายถึงทริกเกอร์และมีความหมายสำหรับคุณ ชื่อต้องมีอักขระไม่เกิน 128 ตัว
    ประเภทการแจ้งเตือน เลือกคงที่ ดูข้อมูลเพิ่มเติมเกี่ยวกับประเภทการแจ้งเตือนได้ที่เกี่ยวกับประเภทการแจ้งเตือน
    คำอธิบาย คำอธิบายของการแจ้งเตือน
    สภาพแวดล้อม เลือกสภาพแวดล้อมจากรายการแบบเลื่อนลง
    สถานะ สลับเพื่อเปิดหรือปิดใช้การแจ้งเตือน
  4. กำหนดเมตริก เกณฑ์ และมิติข้อมูลสำหรับเงื่อนไขแรกที่จะทำให้เกิดการแจ้งเตือน
    ช่องเงื่อนไข คำอธิบาย
    เมตริก

    เลือกเมตริกต่อไปนี้ 1 รายการ

    • รหัสสถานะ: เลือกรหัสสถานะจากรายการ เช่น 401, 404, 2xx, 4xx หรือ 5xx HTTP

      หมายเหตุ

      • API จะให้คุณตั้งค่าช่วงของรหัสสถานะที่กว้างขึ้น ใช้ API เพื่อระบุรหัสสถานะระหว่าง 200-299, 400-599 และค่าไวลด์การ์ดเป็น 2xx, 4xx หรือ 5xx โปรดดูหัวข้อสร้างการแจ้งเตือน
      • สำหรับการแจ้งเตือนเกี่ยวกับการจำกัดอัตรา (รหัสสถานะ HTTP 429) ให้ตั้งค่าเมตริกเป็นโค้ดข้อผิดพลาด Spike Arrest
      • คุณใช้นโยบาย AssignMessage เพื่อเขียนโค้ดตอบกลับ HTTP ใหม่ ไม่ว่าจะมาจากข้อผิดพลาดของพร็อกซีหรือข้อผิดพลาดเป้าหมาย การตรวจสอบ API จะไม่สนใจโค้ดที่เขียนขึ้นใหม่ทั้งหมดและบันทึกโค้ดตอบกลับ HTTP จริง
    • เวลาในการตอบสนอง: เลือกค่าเวลาในการตอบสนองจากรายการแบบเลื่อนลง เช่น p50 (เปอร์เซ็นไทล์ที่ 50), p90 (เปอร์เซ็นไทล์ที่ 90), p95 (เปอร์เซ็นไทล์ที่ 95) หรือ p99 (เปอร์เซ็นไทล์ที่ 99 ชั่วโมง) เช่น เลือก p95 เพื่อตั้งค่าการแจ้งเตือนให้แสดงขึ้นเมื่อเวลาในการตอบสนองของเวลาในการตอบสนองสำหรับเปอร์เซ็นไทล์ที่ 95 สูงกว่าเกณฑ์ที่คุณตั้งไว้ด้านล่าง
    • รหัสข้อผิดพลาด: เลือกหมวดหมู่ หมวดหมู่ย่อย และโค้ดข้อผิดพลาดจากรายการ หรือเลือกรายการใดรายการหนึ่งต่อไปนี้ภายในหมวดหมู่หรือหมวดหมู่ย่อย

      • ทั้งหมด - ยอดรวมของโค้ดข้อผิดพลาดทั้งหมดในหมวดหมู่/หมวดหมู่ย่อยนี้ต้องเป็นไปตามเกณฑ์เมตริก
      • ใดก็ได้ - โค้ดข้อผิดพลาดเดี่ยวในหมวดหมู่/หมวดหมู่ย่อยนี้ต้องเป็นไปตามเกณฑ์เมตริก

      ดูข้อมูลเพิ่มเติมในข้อมูลอ้างอิงรหัสข้อผิดพลาด

    • การเข้าชมทั้งหมด (เบต้า): เลือกการเข้าชมที่เพิ่มขึ้นหรือลดลง ดูข้อมูลเพิ่มเติมในการแจ้งเตือนการจราจร (เบต้า)

    เกณฑ์

    กำหนดค่าเกณฑ์สำหรับเมตริกที่เลือก

    • รหัสสถานะ: กำหนดเกณฑ์เป็นอัตราเปอร์เซ็นต์ จำนวน หรือการทำธุรกรรมต่อวินาที (TPS) เมื่อเวลาผ่านไป
    • เวลาในการตอบสนอง: เลือกเกณฑ์เป็นระยะเวลาทั้งหมดหรือเวลาในการตอบสนองเป้าหมาย (มิลลิวินาที) เมื่อเวลาผ่านไป ในกรณีนี้ ระบบจะส่งการแจ้งเตือนหากเปอร์เซ็นไทล์ที่ระบุเวลาในการตอบสนองที่พบ ซึ่งมีการอัปเดตทุกนาทีหากมีการเข้าชม เกินเงื่อนไขเกณฑ์สำหรับช่วงเวลาที่ครอบคลุมระยะเวลาที่ระบุ กล่าวคือ เงื่อนไขของเกณฑ์ไม่ได้รวมตลอดระยะเวลาแบบเต็มเวลา
    • Fault Code: กำหนดเกณฑ์เป็นอัตราเปอร์เซ็นต์ จำนวน หรือการทำธุรกรรมต่อวินาที (TPS) เมื่อเวลาผ่านไป
    มิติข้อมูล คลิก +เพิ่มมิติข้อมูล และระบุรายละเอียดมิติข้อมูลที่จะแสดงผลลัพธ์ ซึ่งรวมถึงพร็อกซี API, บริการเป้าหมาย หรือแอปของนักพัฒนาซอฟต์แวร์ และภูมิภาค

    หากคุณตั้งค่ามิติข้อมูลหนึ่งๆ เป็น

    • ทั้งหมด - เอนทิตีทั้งหมดในมิติข้อมูลต้องเป็นไปตามเกณฑ์เมตริก คุณไม่สามารถเลือกทั้งหมดสำหรับเมตริกประเภทเวลาในการตอบสนองได้
    • ไม่จำกัด - ใช้ได้กับภูมิภาคเท่านั้น เอนทิตีในมิติข้อมูลต้องเป็นไปตามเกณฑ์ของเมตริกสำหรับภูมิภาคเดียว
      หมายเหตุ: สำหรับพร็อกซี API หรือบริการเป้าหมาย ให้เลือกคอลเล็กชันเพื่อรองรับฟังก์ชันการทำงานใดก็ได้
    • คอลเล็กชัน - เลือกคอลเล็กชันจากรายการเพื่อระบุชุดพร็อกซี API หรือบริการเป้าหมาย ในกรณีนี้ เอนทิตีในคอลเล็กชันต้องเป็นไปตามเกณฑ์

    หากตั้งค่ามิติข้อมูลเป็นเป้าหมาย คุณจะเลือกบริการเป้าหมายหรือบริการที่ระบุโดยนโยบาย Serviceข้อความไฮไลต์ ได้ เป้าหมายของนโยบาย ServiceAPI จะแสดงเป็นค่าที่ขึ้นต้นด้วย "sc://" เช่น "sc://my.endpoint.net"

  5. คลิกแสดงข้อมูลเงื่อนไขเพื่อแสดงข้อมูลล่าสุดของเงื่อนไขในช่วงชั่วโมงที่ผ่านมา
    อัตราข้อผิดพลาดในกราฟจะแสดงเป็นสีแดงเมื่อเกินเกณฑ์ของเงื่อนไขการแจ้งเตือน
    แสดงข้อมูลเงื่อนไข

    คลิกซ่อนข้อมูลเงื่อนไขเพื่อซ่อนข้อมูล

  6. คลิก + เพิ่มเงื่อนไข เพื่อเพิ่มเงื่อนไขอื่น แล้วทำขั้นตอนที่ 4 และ 5 ซ้ำ

    หมายเหตุ: หากคุณระบุหลายเงื่อนไข ระบบจะเรียกให้แสดงการแจ้งเตือนเมื่อเป็นไปตามเงื่อนไขทั้งหมด

  7. คลิกสร้างรายงานการวิเคราะห์ API ตามเงื่อนไขในการแจ้งเตือน หากต้องการสร้างรายงานที่กำหนดเองตามเงื่อนไขการแจ้งเตือนที่คุณกำหนดค่าไว้ ตัวเลือกนี้จะเป็นสีเทาหากคุณไม่ใช่ผู้ดูแลระบบองค์กร

    ดูข้อมูลเพิ่มเติมได้ที่สร้างรายงานที่กำหนดเองจากการแจ้งเตือน

    หมายเหตุ: คุณจะแก้ไขรายงานที่กำหนดเองหลังจากที่บันทึกการแจ้งเตือนได้ตามที่อธิบายไว้ในการจัดการรายงานที่กำหนดเอง

  8. คลิก + การแจ้งเตือนเพื่อเพิ่มการแจ้งเตือน
    รายละเอียดการแจ้งเตือน คำอธิบาย
    ช่อง เลือกช่องทางการแจ้งเตือนที่ต้องการใช้และระบุปลายทาง ได้แก่ Email, Slack, PagerDuty หรือเว็บฮุค
    ปลายทาง ระบุปลายทางตามประเภทแชแนลที่เลือก ดังนี้
    • อีเมล - อีเมล เช่น joe@company.com
    • Slack - URL ของช่อง Slack เช่น https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - รหัส PagerDuty เช่น abcd1234efgh56789
    • เว็บฮุค - URL ของเว็บฮุค เช่น https://apigee.com/test-webhook ดูรูปแบบออบเจ็กต์ของเว็บฮุคสำหรับคำอธิบายของออบเจ็กต์ที่ส่งไปยัง URL

      ส่งผ่านข้อมูลเข้าสู่ระบบใน URL ของเว็บฮุค ตัวอย่างเช่น https://apigee.com/test-webhook?auth_token=1234_abcd

      คุณระบุ URL ไปยังปลายทางที่แยกวิเคราะห์ออบเจ็กต์เว็บฮุคเพื่อแก้ไขหรือประมวลผลได้ เช่น คุณอาจระบุ URL ไปยัง API เช่น Edge API หรือปลายทางอื่นๆ ที่ประมวลผลออบเจ็กต์ได้

      หมายเหตุ: คุณสามารถระบุปลายทางได้เพียงรายการเดียวต่อการแจ้งเตือน 1 รายการ หากต้องการระบุปลายทางหลายแห่งสำหรับช่องทางประเภทเดียวกัน ให้เพิ่มการแจ้งเตือนเพิ่มเติม

  9. หากต้องการเพิ่มการแจ้งเตือนอื่นๆ ให้ทำขั้นตอนที่ 8 ซ้ำ
  10. หากคุณเพิ่มการแจ้งเตือน ให้ตั้งค่าช่องต่อไปนี้
    ฟิลด์ คำอธิบาย
    Playbook (ไม่บังคับ) ช่องข้อความรูปแบบอิสระที่มีคำอธิบายสั้นๆ เกี่ยวกับการดำเนินการที่แนะนำเพื่อแก้ไขการแจ้งเตือนเมื่อการแจ้งเตือนเริ่มทำงาน นอกจากนี้คุณยังระบุลิงก์ไปยัง wiki ภายในหรือหน้าชุมชนที่คุณใช้อ้างอิงแนวทางปฏิบัติแนะนำได้อีกด้วย ข้อมูลในช่องนี้จะรวมอยู่ในการแจ้งเตือน เนื้อหาในช่องนี้ต้องไม่เกิน 1,500 อักขระ
    คันเร่ง ความถี่ในการส่งการแจ้งเตือน เลือกค่าจากรายการแบบเลื่อนลง ค่าที่ใช้ได้ ได้แก่ 15 นาที 30 นาที และ 1 ชั่วโมง
  11. คลิกบันทึก

รูปแบบออบเจ็กต์เว็บฮุค

หากคุณระบุ URL ของเว็บฮุคเป็นปลายทางของการแจ้งเตือน ออบเจ็กต์ที่ส่งไปยัง URL จะมีรูปแบบดังนี้
{
  "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
TLS วันหมดอายุ
envName, certificateName, thresholdValue, violation

สร้างรายงานที่กำหนดเองจากการแจ้งเตือน

วิธีสร้างรายงานที่กำหนดเองจากการแจ้งเตือน

  1. เมื่อสร้างการแจ้งเตือน ให้คลิกสร้างรายงานการวิเคราะห์ API ตามเงื่อนไขของการแจ้งเตือน ดังที่อธิบายไว้ในการเพิ่มการแจ้งเตือนและการแจ้งเตือน

    หลังจากที่คุณบันทึกการแจ้งเตือน UI จะแสดงข้อความต่อไปนี้

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

    คลิกข้อความเพื่อเปิดรายงานในแท็บใหม่ซึ่งมีช่องที่เกี่ยวข้องที่ป้อนข้อมูลล่วงหน้าแล้ว โดยค่าเริ่มต้น รายงานที่กำหนดเองจะมีชื่อว่า API Monitoring Generated alertName

  2. แก้ไขรายงานที่กําหนดเองตามต้องการ แล้วคลิกบันทึก
  3. คลิกชื่อรายงานในรายการและเรียกใช้รายงานที่กำหนดเอง

วิธีจัดการรายงานที่กำหนดเองที่สร้างขึ้นตามเงื่อนไขในการแจ้งเตือน

  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. คลิกแท็บการตั้งค่า
  3. ในคอลัมน์รายงาน ให้คลิกรายงานที่กำหนดเองที่เชื่อมโยงกับการแจ้งเตือนที่คุณต้องการจัดการ

    หน้ารายงานที่กำหนดเองจะแสดงในแท็บใหม่ หากคอลัมน์รายงานว่างเปล่า แสดงว่ายังไม่ได้สร้างรายงานที่กำหนดเอง คุณสามารถแก้ไขการแจ้งเตือนเพื่อเพิ่มรายงานที่กำหนดเองได้หากต้องการ

  4. แก้ไขรายงานที่กําหนดเองตามต้องการ แล้วคลิกบันทึก
  5. คลิกชื่อรายงานในรายการและเรียกใช้รายงานที่กำหนดเอง

เปิดหรือปิดใช้การแจ้งเตือน

ในการเปิดใช้งานหรือปิดใช้งานการแจ้งเตือน:

  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. คลิกปุ่มสลับในคอลัมน์สถานะที่เชื่อมโยงกับการแจ้งเตือนที่คุณต้องการเปิดหรือปิดใช้งาน

แก้ไขการแจ้งเตือน

หากต้องการแก้ไขการแจ้งเตือน:

  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. คลิกชื่อการแจ้งเตือนที่ต้องการแก้ไข
  3. แก้ไขการแจ้งเตือนตามต้องการ
  4. คลิกบันทึก

ลบการแจ้งเตือน

วิธีลบการแจ้งเตือน

  1. คลิกวิเคราะห์ > กฎการแจ้งเตือนใน Edge UI
  2. วางเคอร์เซอร์เหนือการแจ้งเตือนที่ต้องการลบ แล้วคลิก ในเมนูการทำงาน

Apigee ขอแนะนำให้คุณตั้งค่าการแจ้งเตือนต่อไปนี้ให้แจ้งเตือนเกี่ยวกับปัญหาที่พบได้ทั่วไป การแจ้งเตือนบางส่วนมีไว้สำหรับการใช้ API ของคุณโดยเฉพาะและมีประโยชน์ในบางสถานการณ์เท่านั้น ตัวอย่างเช่น การแจ้งเตือนหลายรายการที่แสดงด้านล่างจะมีผลก็ต่อเมื่อคุณใช้นโยบาย Serviceคำขอราคาเสนอ หรือนโยบาย JavaScript ของ Java

การแจ้งเตือน ตัวอย่าง UI ตัวอย่าง API
รหัสสถานะ 5xx สำหรับ API ทั้งหมด/ทั้งหมด ตั้งค่าการแจ้งเตือนรหัสสถานะ 5xx สำหรับพร็อกซี API ตั้งค่าการแจ้งเตือนรหัสสถานะ 5xx สำหรับพร็อกซี API โดยใช้ API
เวลาในการตอบสนองของ P95 สำหรับพร็อกซี API ตั้งค่าการแจ้งเตือนเวลาในการตอบสนอง P95 สำหรับพร็อกซี API ตั้งค่าการแจ้งเตือนเวลาในการตอบสนอง P95 สำหรับพร็อกซี API โดยใช้ API
รหัสสถานะ 404 (ไม่พบแอปพลิเคชัน) สำหรับพร็อกซี API ทั้งหมด ตั้งค่าการแจ้งเตือนรหัสสถานะ 404 (Application Not Found) สำหรับพร็อกซี API ทั้งหมด ตั้งค่าการแจ้งเตือนรหัสสถานะ 404 (Application Not Found) สำหรับพร็อกซี API ทั้งหมดที่ใช้ API
จำนวนพร็อกซี API สำหรับ API ตั้งค่าการแจ้งเตือนจำนวนพร็อกซี API สำหรับ API ตั้งค่าการแจ้งเตือนจำนวนพร็อกซี API สำหรับ API ที่ใช้ API
อัตราข้อผิดพลาดสำหรับบริการเป้าหมาย ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับบริการเป้าหมาย ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับบริการเป้าหมายโดยใช้ API
อัตราข้อผิดพลาดสำหรับนโยบาย Serviceต้องระบุ (หากมี) ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับนโยบาย Serviceส่วนขยายไฮไลต์ ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับนโยบาย ServiceAPI โดยใช้ API
รหัสข้อผิดพลาดเฉพาะ ซึ่งรวมถึง
  • ข้อผิดพลาดโปรโตคอล API (โดยทั่วไปคือ 4xx)
    • UI: โปรโตคอล API > ทั้งหมด
    • API:
      "faultCodeCategory":"API Protocol",
      "faultCodeSubCategory":"ALL"
  • ข้อผิดพลาด HTTP ที่รับทั้งหมด
    • UI: เกตเวย์ > อื่นๆ > Gateway HTTPErrorResponseCode
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Others",
      "faultCodeName": "Gateway HTTPErrorResponseCode"
  • ข้อผิดพลาดในการเรียกใช้คำขอราคาเสนอของบริการ Java (หากมี)
    • UI: นโยบายการดำเนินการ > Java ที่แตกต่างกัน > Javaที่แตกต่างกัน Execution เกิดข้อผิดพลาด
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Java Callout",
      "faultCodeName": "JavaCallout ExecutionFailed"
  • ข้อผิดพลาดในการเรียกใช้สคริปต์โหนด (หากมี)
    • UI: นโยบายการดำเนินการ > สคริปต์โหนด > NodeScript ExecutionError
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Node Script",
      "faultCodeName": "NodeScript ExecutionError"
  • การละเมิดโควต้า
    • UI: นโยบายการจัดการการรับส่งข้อมูล > โควต้า > การละเมิดโควต้า
    • API:
      "faultCodeCategory": "Traffic Mgmt Policy",
      "faultCodeSubCategory": "Quota",
      "faultCodeName": "Quota Violation"
  • ข้อผิดพลาดของนโยบายความปลอดภัย
    • UI: นโยบายความปลอดภัย > อะไรก็ได้
    • API:
      "faultCodeCategory": "Security Policy",
      "faultCodeName": "Any"
  • ข้อผิดพลาดด้านการรับรู้ (หากมี)
    • UI: Sense > Sense > Sense RaiseFault
    • API:
      "faultCodeCategory": "Sense",
      "faultCodeSubCategory": "Sense",
      "faultCodeName": "Sense RaiseFault"
  • ข้อผิดพลาดในการเรียกใช้คําขอบริการ (หากมี)
    • UI: นโยบายการดำเนินการ > การเรียกบริการ > การดำเนินการ ServiceIdentifier ล้มเหลว
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Service Callout",
      "faultCodeName": "ServiceCallout ExecutionFailed"
  • ข้อผิดพลาดของเป้าหมาย
    • UI: เกตเวย์ > เป้าหมาย > ระยะหมดเวลาของเกตเวย์ด้วยเป้าหมายหรือไฮไลต์
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TimeoutWithTargetOrCallout"
  • ข้อผิดพลาดของเป้าหมาย ไม่มีเป้าหมายที่ใช้งานอยู่
    • UI: เกตเวย์ > เป้าหมาย > Gateway TargetServerConfiguredInLoadBalancersIsDown
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TargetServerConfiguredInLoadBalancerIsDown
  • ข้อผิดพลาดเกี่ยวกับเป้าหมาย, EOF ที่ไม่คาดคิด
    • UI: เกตเวย์ > เป้าหมาย > เกตเวย์ที่ไม่คาดคิดEOFAtTarget
    • API:
      "faultCodeCategory": "Gateway", "faultCodeSubCategory": "Target", "faultCodeName" : "Gateway UnexpectedEOFAtTarget"
  • ข้อผิดพลาดของโฮสต์เสมือน
    • UI: เกตเวย์ > โฮสต์เสมือน > VirtualHost invalidKeystoreOrTrustStore
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Virtual Host",
      "faultCodeName": "VirtualHost InvalidKeystoreOrTrustStore"
ตั้งค่าการแจ้งเตือนรหัสข้อผิดพลาดของนโยบาย ตั้งค่าการแจ้งเตือนเกี่ยวกับรหัสข้อผิดพลาดของนโยบายโดยใช้ API

ตั้งค่าการแจ้งเตือนรหัสสถานะ 5xx สำหรับพร็อกซี API

ตัวอย่างต่อไปนี้แสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่เรียกให้แสดงเมื่อธุรกรรมต่อวินาที (TPS) ของรหัสสถานะ 5xx สำหรับพร็อกซี API โรงแรมเกิน 100 เป็นเวลา 10 นาทีสำหรับทุกภูมิภาค โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเพิ่มการแจ้งเตือน

สำหรับข้อมูลเกี่ยวกับการใช้ API โปรดดูตั้งค่าการแจ้งเตือนรหัสสถานะ 5xx สำหรับพร็อกซีโดยใช้ API

ตั้งค่าการแจ้งเตือนเวลาในการตอบสนอง P95 สำหรับพร็อกซี API

ตัวอย่างต่อไปนี้จะแสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่ระบบเรียกให้แสดงเมื่อเวลาในการตอบสนองของการตอบสนองรวมสำหรับเปอร์เซ็นไทล์ที่ 95 มากกว่า 100 มิลลิวินาทีเป็นเวลา 5 นาทีสําหรับพร็อกซี Hotel API สําหรับภูมิภาคใดๆ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเพิ่มการแจ้งเตือน

ดูข้อมูลเกี่ยวกับการใช้ API ได้ที่ตั้งค่าการแจ้งเตือนเวลาในการตอบสนอง P95 สำหรับพร็อกซี API โดยใช้ API

ตั้งค่าการแจ้งเตือน 404 (ไม่พบแอปพลิเคชัน) สำหรับพร็อกซี API ทั้งหมด

ต่อไปนี้เป็นตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่จะถูกเรียกใช้เมื่อเปอร์เซ็นต์ของรหัสสถานะ 404 สำหรับพร็อกซี API ทั้งหมดเกิน 5% เป็นเวลา 5 นาทีสำหรับทุกภูมิภาค โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเพิ่มการแจ้งเตือน

สำหรับข้อมูลเกี่ยวกับการใช้ API โปรดดูตั้งค่าการแจ้งเตือน 404 (ไม่พบแอปพลิเคชัน) สำหรับพร็อกซี API ทั้งหมดที่ใช้ API

ตั้งค่าการแจ้งเตือนจำนวนพร็อกซี API สำหรับ API

ตัวอย่างต่อไปนี้แสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่จะทริกเกอร์เมื่อจำนวนรหัส 5xx สำหรับ API เกิน 200 เป็นเวลา 5 นาทีในภูมิภาคใดก็ตาม ในตัวอย่างนี้ API จะได้รับการบันทึกไว้ในคอลเล็กชัน Critical API Proxies ดูข้อมูลเพิ่มเติมได้ที่

สำหรับข้อมูลเกี่ยวกับการใช้ API โปรดดูที่ตั้งค่าการแจ้งเตือนจำนวนพร็อกซี API สำหรับ API ที่ใช้ API

ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับบริการเป้าหมาย

ตัวอย่างต่อไปนี้แสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่เรียกให้แสดงเมื่ออัตราโค้ด 500 สําหรับบริการเป้าหมายเกิน 10% เป็นเวลา 1 ชั่วโมงสําหรับภูมิภาคใดก็ตาม ในตัวอย่างนี้ บริการเป้าหมายจะได้รับการบันทึกไว้ในคอลเล็กชันเป้าหมายที่สำคัญ ดูข้อมูลเพิ่มเติมได้ที่

ดูข้อมูลเกี่ยวกับการใช้ API ได้ที่ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับบริการเป้าหมายโดยใช้ API

ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับนโยบาย Serviceต้องระบุ

ตัวอย่างต่อไปนี้แสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่จะทริกเกอร์เมื่ออัตราโค้ด 500 สำหรับบริการที่ระบุโดยนโยบาย Serviceที่แตกต่างกัน เกิน 10% เป็นเวลา 1 ชั่วโมงในทุกภูมิภาค ดูข้อมูลเพิ่มเติมได้ที่

ดูข้อมูลเกี่ยวกับการใช้ API ได้ที่ตั้งค่าการแจ้งเตือนอัตราข้อผิดพลาดสำหรับนโยบายการเรียกบริการโดยใช้ API

ตั้งค่าการแจ้งเตือนรหัสข้อผิดพลาดของนโยบาย

ตัวอย่างต่อไปนี้แสดงตัวอย่างวิธีตั้งค่าการแจ้งเตือนโดยใช้ UI ที่ทริกเกอร์เมื่อจำนวนรหัสข้อผิดพลาด JWT AlgorithmMismatch สำหรับนโยบาย ConfirmJWT มากกว่า 5 เป็นเวลา 10 นาทีสำหรับ API ทั้งหมด ดูข้อมูลเพิ่มเติมได้ที่

สำหรับข้อมูลเกี่ยวกับการใช้ API โปรดดูตั้งค่าการแจ้งเตือนโค้ดข้อผิดพลาดสำหรับโค้ดความผิดพลาดของนโยบายโดยใช้ API