คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
ดูตัวอย่างสถานการณ์จำลองที่แสดงวิธีแก้ปัญหาเกี่ยวกับ 5xx เกี่ยวกับ API
# | ขั้นตอน | คำอธิบาย |
---|---|---|
1 | ตรวจสอบการรับส่งข้อมูลของ API ล่าสุด | ดูข้อมูลการตรวจสอบ API ล่าสุดสำหรับพร็อกซีและเป้าหมาย API ทั้งหมดที่มีการเข้าชมในชั่วโมงที่ผ่านมา เจาะลึกพร็อกซี API หรือเป้าหมายที่มีอัตรา % ข้อผิดพลาดสูง |
2 | ระบุแนวโน้มในข้อมูลการตรวจสอบ API | เข้าถึงมุมมองข้อมูลย้อนหลังของข้อมูลการตรวจสอบ API สูงสุดถึง 3 เดือนที่ผ่านมา เพื่อรับมุมมองที่กว้างขึ้น |
3 | ตรวจสอบปัญหา 5xx | ดูโค้ดข้อผิดพลาดที่มีปริมาณสัมพัทธ์สูงสุดตลอดช่วงเวลาเพื่อตรวจสอบแหล่งที่มาของปัญหา 5xx เพิ่มเติม (โดยทั่วไป รหัสสถานะ 5xx สามารถแยกประเภทได้โดยใช้รหัสข้อผิดพลาดอย่างน้อย 1 รหัส) |
4 | ตั้งค่าการแจ้งเตือน 5xx | ตั้งค่าการแจ้งเตือนเพื่อรับการแจ้งเตือนเมื่อรหัสสถานะ 5xx มีจำนวนเกินเกณฑ์ที่กำหนด |
5 | สร้างรายงานที่กำหนดเองพร้อมรายละเอียดของลูกค้า (ไม่บังคับ) | (ไม่บังคับ) สร้างรายงานที่กำหนดเองเพื่อระบุรายละเอียดเกี่ยวกับไคลเอ็นต์ที่ทริกเกอร์ข้อผิดพลาด 5xx หมายเหตุ: คุณต้องเป็นผู้ดูแลระบบขององค์กรจึงจะสร้างรายงานที่กำหนดเองได้ |
6 | จัดกลุ่มพร็อกซี API ไว้ในคอลเล็กชัน | สร้างคอลเล็กชันเพื่อจัดกลุ่มพร็อกซี API และตั้งค่าเกณฑ์การแจ้งเตือนที่เหมาะสมสำหรับสมาชิกทุกคนในกลุ่มเพื่อให้วินิจฉัยปัญหาได้เร็วขึ้น
|
7 | แก้ปัญหาเกี่ยวกับ 5xx | จากการตรวจสอบและการวินิจฉัยของคุณ โปรดดําเนินการตามความเหมาะสมเพื่อแก้ไขปัญหา 5xx |
ขั้นตอนที่ 1: ตรวจสอบการรับส่งข้อมูลของ API ล่าสุด
หากต้องการดูข้อมูลการตรวจสอบ API สำหรับพร็อกซีและเป้าหมาย API ที่มีการเข้าชมในช่วงชั่วโมงที่ผ่านมา ให้ทำดังนี้
- เลือกวิเคราะห์ > การตรวจสอบ API > ล่าสุดใน Edge UI เพื่อเข้าถึงแดชบอร์ดล่าสุด
โปรดสังเกตพร็อกซีและเป้าหมาย API ที่มีอัตรา % ข้อผิดพลาดสูงในช่วงชั่วโมงที่ผ่านมา
คลิกพร็อกซี API หรือเป้าหมายที่มีอัตรา % ข้อผิดพลาดสูงเพื่อดูรายละเอียดในแผงด้านขวา ในตัวอย่างนี้ ให้สังเกตข้อผิดพลาด 5xx ที่มีเปอร์เซ็นต์สูง
ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ได้ที่ตรวจสอบการรับส่งข้อมูลของ API ล่าสุด
ขั้นตอนที่ 2: ระบุแนวโน้มในข้อมูลการตรวจสอบ API ของคุณ
หากต้องการเข้าถึงมุมมองประวัติของข้อมูลการตรวจสอบ API สำหรับพร็อกซีและเป้าหมาย API ที่มีการเข้าชมในช่วง 3 เดือนที่ผ่านมา ให้ทำดังนี้
- ในแผงด้านขวาของหน้าแดชบอร์ดล่าสุด ให้เลือก > ดูในไทม์ไลน์ เพื่อเข้าถึงแดชบอร์ดไทม์ไลน์
หรือจะคลิกวิเคราะห์ > การตรวจสอบ API > ไทม์ไลน์ใน Edge UI ก็ได้เช่นกัน
- ดูแนวโน้มของพร็อกซีหรือเป้าหมาย API ในช่วงระยะเวลาหนึ่ง โปรดสังเกตว่าแนวโน้มมีความสม่ำเสมอในช่วง 7 วันที่ผ่านมา
ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ได้ที่หัวข้อระบุแนวโน้มในข้อมูลการตรวจสอบ API
ขั้นตอนที่ 3: ตรวจสอบปัญหา 5xx
Apigee ประกอบไปด้วยชุดโค้ดข้อผิดพลาดที่ช่วยให้คุณวินิจฉัยปัญหาได้ โดยปกติแล้ว รหัสสถานะ 5xx จะจัดประเภทได้โดยใช้รหัสข้อผิดพลาดอย่างน้อย 1 รหัส
ในการตรวจสอบปัญหา 5xx ให้ทำดังนี้
- ในแผงด้านขวาของหน้าแดชบอร์ดไทม์ไลน์ ให้เลือก > ดูในการตรวจสอบ เพื่อเข้าถึงหน้าแดชบอร์ดการตรวจสอบ
หรือจะคลิกวิเคราะห์ > การตรวจสอบ API > ตรวจสอบใน Edge UI ก็ได้เช่นกัน
หน้าแดชบอร์ดการตรวจสอบช่วยให้คุณเปรียบเทียบกิจกรรมที่สัมพันธ์กันระหว่างเมตริกต่างๆ เช่น โค้ดข้อผิดพลาดกับเวลาได้ ดูโค้ดข้อผิดพลาดเทียบกับเมทริกซ์เวลา เพื่อดูกิจกรรมของโค้ดข้อผิดพลาดในช่วง 1 ชั่วโมงที่ผ่านมา สังเกตโค้ดข้อผิดพลาดที่มีระดับเสียงที่สัมพันธ์กันสูงสุดโดยอิงตามเฉดสีของบล็อก ยิ่งบล็อกมีสีเข้มมาก ระดับเสียงสัมพัทธ์ก็จะสูงขึ้น
ตัวอย่างเช่น รหัสข้อผิดพลาด
policies.ratelimit.SpikeArrestViolation
และpolicies.ratelimit.QuotaViolation
แสดงปริมาณสัมพัทธ์ที่สูงกว่าในเมทริกซ์ต่อไปนี้คลิกบล็อกที่มืดที่สุด (บล็อกแรก) ในแถว
policies.ratelimit.SpikeArrestViolation
เพื่อดูรายละเอียดเพิ่มเติมในแผงด้านขวา
โปรดสังเกตว่าแหล่งที่มาของข้อผิดพลาดคือพร็อกซี API perfBenchmark_invalid_v1 และรหัสสถานะ HTTP คือ perfBenchmark_invalid_v1 รหัสสถานะ 500 เป็นรหัสข้อผิดพลาดรันไทม์ที่พบบ่อยสำหรับการละเมิดนโยบายการจับกุมของ Spike
ดู "การเผยแพร่โดยแอปสำหรับนักพัฒนาซอฟต์แวร์" ใต้แผง "สาเหตุที่น่าสงสัย" เพื่อระบุแอปของนักพัฒนาซอฟต์แวร์ที่มีอัตราข้อผิดพลาดสูงสุด
ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ได้ที่หัวข้อระบุปัญหา
ขั้นตอนที่ 4: ตั้งค่าการแจ้งเตือน 5xx
ตั้งค่าการแจ้งเตือนตามบริบทที่เลือกในแผงรายละเอียดการตรวจสอบเพื่อรับการแจ้งเตือนเมื่อรหัสสถานะ 5xx มีจำนวนเกินเกณฑ์ที่ระบุ
ในแผงด้านขวาของหน้าแดชบอร์ดการตรวจสอบ ให้เลือก > สร้างการแจ้งเตือน
กรอกข้อมูลในช่องต่างๆ ในกล่องโต้ตอบการแจ้งเตือน ระบบจะป้อนข้อมูลในช่องเงื่อนไขล่วงหน้าด้วยข้อมูลจากบริบทปัจจุบัน เช่น
คลิกบันทึก
ในอนาคต เมื่ออัตราข้อผิดพลาด 5xx มีค่าเกิน 5% เป็นระยะเวลา 5 นาทีของพร็อกซี API perfBenchmark_invalid_v1 ระบบจะส่งperfBenchmark_invalid_v1ไปยังอีเมลที่ระบุและperfBenchmark_invalid_v1จะแสดงใน UI เช่น
โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ในหัวข้อตั้งค่าการแจ้งเตือน
ขั้นตอนที่ 5: สร้างรายงานที่กำหนดเองพร้อมรายละเอียดของลูกค้า (ไม่บังคับ)
(ไม่บังคับ) สร้างรายงานที่กำหนดเองเพื่อระบุรายละเอียดเพิ่มเติมเกี่ยวกับไคลเอ็นต์ที่ทริกเกอร์ข้อผิดพลาด 5xx
ในหน้ารายงาน ระบบจะตั้งชื่อรายงานที่กำหนดเองซึ่งสร้างตามการแจ้งเตือนโดยใช้รูปแบบต่อไปนี้ API Monitoring Generated: alert-name
เข้าถึงรายงานที่กำหนดเองที่สร้างขึ้นเมื่อตั้งค่าการแจ้งเตือนด้วยวิธีใดวิธีหนึ่งต่อไปนี้
เลือก วิเคราะห์ > รายงานที่กำหนดเอง > รายงาน ในแถบนำทางด้านซ้ายเพื่อแสดงหน้ารายงาน คลิกชื่อรายงานในรายการ: การตรวจสอบ API ที่สร้าง: การแจ้งเตือน 5xx
คลิกภายในการแจ้งเตือนที่ปรากฏขึ้นเมื่อมีการสร้างการแจ้งเตือนขึ้น เช่น
เพิ่มมิติข้อมูลต่อไปนี้
- แอปนักพัฒนาซอฟต์แวร์
- Client-ID
- ที่อยู่ IP ของไคลเอ็นต์
หากต้องการดูรายงานที่อิงตามแอปนักพัฒนาแอปที่เฉพาะเจาะจงซึ่งมีอัตราข้อผิดพลาดสูง ให้เพิ่มตัวกรองที่คล้ายกับรายการต่อไปนี้
and (developer_app eq 'perfBenchmarkApp0')
หมายเหตุ: ในกรณีนี้ ให้นําแอปนักพัฒนาซอฟต์แวร์ออกจากรายการมิติข้อมูล
คลิกบันทึก
เรียกใช้รายงานเพื่อดูรายละเอียดเกี่ยวกับแอปนักพัฒนาแอปและไคลเอ็นต์ที่เรียกใช้รหัสสถานะ 5xx
สำหรับข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ โปรดดูที่สร้างรายงานที่กำหนดเอง
ขั้นตอนที่ 6: จัดกลุ่มพร็อกซี API ลงในคอลเล็กชัน
สร้างคอลเล็กชันเพื่อจัดกลุ่มพร็อกซี API และตั้งค่าเกณฑ์การแจ้งเตือนที่เหมาะสมสำหรับสมาชิกทุกคนในกลุ่มเพื่อให้วินิจฉัยปัญหาได้เร็วขึ้น
- เลือกวิเคราะห์ > การตรวจสอบ API > คอลเล็กชันใน Edge UI เพื่อแสดงแดชบอร์ดคอลเล็กชัน
- คลิก + คอลเล็กชัน
- เลือกพร็อกซี
- เลือก prod จากเมนูแบบเลื่อนลงของสภาพแวดล้อม
- คลิกถัดไป
- กรอกข้อมูลในช่องต่างๆ ในกล่องโต้ตอบคอลเล็กชัน
- คลิกบันทึก
จากนั้นคุณสามารถตั้งค่าการแจ้งเตือนซึ่งคล้ายกับขั้นตอนที่ 4 และตั้งค่ามิติข้อมูลเป็นคอลเล็กชันที่คุณกำหนดไว้ข้างต้นได้
ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ได้ที่หัวข้อจัดการคอลเล็กชัน
ขั้นตอนที่ 7: แก้ปัญหาเกี่ยวกับ 5xx
ดำเนินการตามความเหมาะสมเพื่อแก้ไขปัญหา 5xx ตัวอย่างเช่น เมื่อพิจารณาจากการวิเคราะห์ของคุณแล้ว คุณอาจดำเนินการอย่างใดอย่างหนึ่งต่อไปนี้
- ใช้ Apigee Sense เพื่อพิจารณาว่าคำขอที่เพิ่มขึ้นอย่างฉับพลันนั้นน่าสงสัยหรือไม่ แล้วตัดสินใจว่าจะบล็อกที่อยู่ IP ของไคลเอ็นต์ที่ระบุในรายงานที่กำหนดเองหรือไม่
- เพิ่มนโยบายโควต้าเพื่อจำกัดจำนวนการเชื่อมต่อที่แอปของนักพัฒนาซอฟต์แวร์สามารถทำกับพร็อกซี API ของคุณได้ในระยะเวลาหนึ่ง
- สร้างรายได้จาก API ของคุณเพื่อเรียกเก็บเงินนักพัฒนาซอฟต์แวร์สำหรับการใช้งานผ่านการโทรตามจำนวนที่กำหนด