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

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

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

คุณตั้งค่าช่วงเวลาเป็น

  • 1 ชั่วโมง
  • 1 วัน
  • 7 วัน
  • 15 วัน (API เท่านั้น)
  • 30 วัน (API เท่านั้น)

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

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

ค่าบวกหมายถึงการเข้าชมเพิ่มขึ้น และค่าลบหมายถึงการเข้าชมลดลง

จากนั้นคุณจะตั้งค่าเกณฑ์ที่จะทริกเกอร์การแจ้งเตือนการเข้าชมเป็นเปอร์เซ็นต์ที่เพิ่มขึ้นหรือลดลงของการเข้าชม API ในช่วงระยะเวลาที่ระบุ

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับการแจ้งเตือนได้ที่ตั้งค่าการแจ้งเตือนและการแจ้งเตือน

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

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

    ระบุให้เพิ่มการแจ้งเตือนเมื่อการเข้าชมเพิ่มขึ้นหรือ ลดลงเป็นเปอร์เซ็นต์ที่เฉพาะเจาะจงเมื่อเทียบกับช่วงเวลาก่อนหน้า

    ตั้งค่าเปอร์เซ็นต์เพิ่มขึ้นเป็นค่าที่มากกว่าหรือเท่ากับ 0% ตั้งค่าเปอร์เซ็นต์ลดลงให้มีค่ามากกว่าหรือเท่ากับ 0% และน้อยกว่าหรือเท่ากับ 100%

    คุณเลือกช่วงเวลาได้ดังนี้

    • 1 ชั่วโมง
    • 1 วัน
    • 1 สัปดาห์
    มิติข้อมูล

    คลิก +เพิ่มมิติข้อมูล แล้วระบุรายละเอียดมิติข้อมูลที่จะแสดงผลลัพธ์ ซึ่งรวมถึง พร็อกซี API และภูมิภาค

    ตั้งค่ามิติข้อมูลที่เฉพาะเจาะจงเป็น

    • พร็อกซี - ตั้งค่าเป็นพร็อกซีที่เฉพาะเจาะจงหรือเป็นพร็อกซีทั้งหมด พร็อกซีไม่รองรับค่า "Any" แต่คุณสามารถเพิ่มการแจ้งเตือนแยกต่างหากสำหรับพร็อกซีแต่ละรายการที่คุณสนใจได้
    • ภูมิภาค - ตั้งค่าเป็นภูมิภาคที่เฉพาะเจาะจงหรือเป็นทุกภูมิภาค ภูมิภาคไม่รองรับค่า "Any" แต่คุณสามารถเพิ่มการแจ้งเตือนแยกต่างหากสำหรับแต่ละภูมิภาคที่คุณสนใจได้
  5. คลิก + การแจ้งเตือนเพื่อเพิ่มการแจ้งเตือน
    รายละเอียดการแจ้งเตือน คำอธิบาย
    ช่อง เลือกช่องทางการแจ้งเตือนที่ต้องการใช้และระบุปลายทาง ได้แก่ อีเมล, 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

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

ดูการแจ้งเตือนในแดชบอร์ดเหตุการณ์

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

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

  1. คลิกวิเคราะห์ > เหตุการณ์ใน UI ของ Edge แดชบอร์ดเหตุการณ์ใหม่จะปรากฏขึ้น

  2. กรองแดชบอร์ดเหตุการณ์ตามรายการต่อไปนี้

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

ใช้ API การแจ้งเตือนกับการแจ้งเตือนการจราจร

API ส่วนใหญ่ที่คุณใช้เพื่อสร้างและจัดการการแจ้งเตือนการเข้าชมจะเหมือนกับ API ที่คุณใช้ กับการแจ้งเตือนประเภทอื่นๆ

อย่างไรก็ตาม API บางรายการมีพร็อพเพอร์ตี้เพิ่มเติมที่ใช้เพื่อรองรับการแจ้งเตือนความผิดปกติ ซึ่งรวมถึง

  • รับการแจ้งเตือน - แสดงการแจ้งเตือนทั้งหมด รวมถึงการแจ้งเตือนที่แก้ไขแล้วและการแจ้งเตือนความผิดปกติ
  • สร้างการแจ้งเตือน - สร้างการแจ้งเตือนแบบคงที่หรือการแจ้งเตือนความผิดปกติ
  • อัปเดตการแจ้งเตือน - อัปเดตคำจำกัดความของการแจ้งเตือนที่แก้ไขแล้วหรือการแจ้งเตือนความผิดปกติ

สร้างหรืออัปเดตการแจ้งเตือนการจราจร

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

  • เพิ่มพร็อพเพอร์ตี้ใหม่ต่อไปนี้เพื่อระบุว่าการแจ้งเตือนเป็นการแจ้งเตือนการจราจร

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    ค่าเริ่มต้นของพร็อพเพอร์ตี้เหล่านี้คือ

    "alertType": "runtime"
"alertSubType": "fixed"
  • ในdimensionsองค์ประกอบของอาร์เรย์ conditions ให้ทำดังนี้
    • คุณต้องตั้งค่าพร็อพเพอร์ตี้ org, env, proxy และ region ระบบจะรองรับเฉพาะพร็อพเพอร์ตี้เหล่านั้น คุณตั้งค่า proxy และ region เป็น ALL ได้
    • คุณต้องตั้งค่าพร็อพเพอร์ตี้ traffic เป็น total

  • ในอาร์เรย์ conditions ให้ทำดังนี้

    • พร็อพเพอร์ตี้ metrics ต้องมีค่าเป็น trafficChange
    • ต้องตั้งค่าพร็อพเพอร์ตี้ comparator เป็น increasedBy หรือ decreasedBy
    • พร็อพเพอร์ตี้ threshold มีค่าบวกที่ระบุเปอร์เซ็นต์การเพิ่มขึ้นหรือลดลงของการเข้าชม โดยค่า 1.0 จะสอดคล้องกับ 100% สำหรับ increasedBy ค่าต้องมากกว่าหรือเท่ากับ 0.0 (0%) สำหรับ decreasedBy ค่าต้องมากกว่าหรือเท่ากับ 0.0 (0%) และน้อยกว่าหรือเท่ากับ 1.0 (100%)
    • ต้องตั้งค่าพร็อพเพอร์ตี้ durationSeconds เป็นค่าใดค่าหนึ่งต่อไปนี้ 3600 (1 ชั่วโมง), 86400 (1 วัน), 604800 (7 วัน), 1296000 (15 วัน), 2592000 (30 วัน)
  • การแจ้งเตือนการเข้าชมไม่รองรับพร็อพเพอร์ตี้ reportEnabled
ตัวอย่างต่อไปนี้แสดงวิธีตั้งค่าการแจ้งเตือนที่จะทริกเกอร์เมื่อการเข้าชมของ องค์กรและสภาพแวดล้อมเพิ่มขึ้น 50% ในช่วงเวลา 1 ชั่วโมง ระบบจะส่งการแจ้งเตือนไปยังรหัส PagerDuty ที่ระบุเมื่อมีการทริกเกอร์การแจ้งเตือน 
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 Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ใน รับโทเค็นเพื่อการเข้าถึง OAuth 2.0 ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL

ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ API นี้ได้ที่ดูกิจกรรม

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

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

  • enabled - หาก true ระบุให้แสดงเฉพาะการแจ้งเตือนที่เปิดใช้ ค่าเริ่มต้นคือ false
  • alertType - ระบุประเภทการแจ้งเตือนที่จะแสดง ค่าที่อนุญาตคือ runtime (ค่าเริ่มต้น) และ cert
  • alertSubType - ระบุประเภทย่อยของการแจ้งเตือนที่จะแสดง ค่าเริ่มต้นคือไม่ได้ตั้งค่า ซึ่งหมายความว่าให้แสดงผลประเภทการแจ้งเตือนย่อยทั้งหมด

เช่น ใช้การเรียก 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=runtime&alertSubType=trafficfixed'

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในรับโทเค็นเพื่อการเข้าถึง OAuth 2.0 ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL