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

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

• 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