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

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

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

คุณกำหนดช่วงเวลาเป็น

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

5. คลิก + การแจ้งเตือนเพื่อเพิ่มการแจ้งเตือน

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

6. หากต้องการเพิ่มการแจ้งเตือนอื่นๆ ให้ทำซ้ำขั้นตอนก่อนหน้า
7. หากคุณเพิ่มการแจ้งเตือน ให้ตั้งค่าช่องต่อไปนี้

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

8. คลิกบันทึก

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

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

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

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

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

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

ใช้ 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 รับการแจ้งเตือน API จะแสดงข้อมูลเกี่ยวกับการแจ้งเตือนที่กำหนดไว้ทั้งหมด ตอนนี้ 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