คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
ส่วนนี้จะเปรียบเทียบการตรวจสอบ API กับ Edge Analytics แม้ว่าทั้งการตรวจสอบ API และ Edge Analytics จะช่วยให้คุณรวบรวมและดูข้อมูล API ได้ แต่ก็มีวัตถุประสงค์ที่แตกต่างกัน ดังนี้
- เป้าหมายของการตรวจสอบ API คือการตรวจสอบว่า API ทำงานได้ตามที่ตั้งใจไว้ ด้วยเหตุนี้ คุณจึงต้องดูข้อมูลที่อัปเดตล่าสุด การตรวจสอบ API ให้ข้อมูลที่ใกล้เคียงกับแบบเรียลไทม์มาก และให้คุณสร้างการแจ้งเตือนที่จะแจ้งให้คุณทราบในกรณีที่เกิดปัญหา
- เป้าหมายของ Edge Analytics คือการทำความเข้าใจลักษณะการทํางานในระยะยาวของ API เพื่อให้มั่นใจว่า API รองรับข้อกําหนดทางธุรกิจ หรือทําการเปลี่ยนแปลงได้หากจําเป็น ด้วยเหตุนี้ การดูข้อมูลแบบเรียลไทม์จึงมีความสำคัญน้อยกว่า ด้วยเหตุนี้ ข้อมูล Analytics จึงล่าช้าเล็กน้อย แต่โดยปกติจะล่าช้าไม่เกิน 10 นาที
โปรดทราบว่าข้อมูลการตรวจสอบ API ซึ่งส่วนใหญ่เกี่ยวข้องกับรหัสข้อผิดพลาดและเวลาในการตอบสนอง เป็นเพียงข้อมูล Analytics ชุดย่อยเล็กๆ เท่านั้น
ความแตกต่างระหว่างข้อมูลการตรวจสอบ API กับข้อมูล Analytics
ส่วนนี้จะอธิบายความแตกต่างเล็กน้อยระหว่างข้อมูลที่รวบรวมโดย Edge Analytics กับการตรวจสอบ API เนื่องจากการตรวจสอบ API และ Analytics ใช้ไปป์ไลน์ข้อมูลที่ต่างกัน คุณจึงอาจเห็นความแตกต่างเล็กน้อยระหว่างรายงานที่กําหนดเองซึ่งการตรวจสอบสร้างขึ้นกับรายงานที่ Analytics สร้างขึ้น ตัวอย่างเช่น คุณอาจเห็นความคลาดเคลื่อนในผลลัพธ์ที่รายงานสำหรับข้อผิดพลาดเกี่ยวกับเวลาหมด ทั้งเวลาหมดของแบ็กเอนด์ (รหัสสถานะ HTTP 504 ในคำขอ) และเวลาหมดของไคลเอ็นต์ (รหัสสถานะ HTTP 499) รายการเหล่านี้อาจปรากฏขึ้นพร้อมรหัสสถานะ 200 ในรายงานที่กําหนดเองของ Analytics แต่จะปรากฏขึ้นพร้อมรหัสสถานะ 504 หรือ 499 ในรายงานที่กําหนดเองของการตรวจสอบการตรวจสอบ API
การตรวจสอบ API ให้ข้อมูลเชิงลึกแบบเรียลไทม์เกี่ยวกับประสิทธิภาพของ API และช่วยคุณวินิจฉัยและแก้ไขปัญหาได้อย่างรวดเร็วเพื่อให้ API ทำงานได้ตามที่ต้องการ
การตรวจสอบ API ช่วยให้คุณทำสิ่งต่อไปนี้ได้
- เพิ่มความพร้อมใช้งานของ API และลดเวลาเฉลี่ยในการวินิจฉัย (MTTD)
- ดำเนินการตามความเหมาะสมตามการแจ้งเตือนตามบริบทก่อนที่ผู้บริโภคจะได้รับผลกระทบ
- ใช้ประโยชน์จากรหัสข้อผิดพลาดของ Apigee เพื่อเร่งการวินิจฉัย
- แยกพื้นที่ที่มีปัญหาออกได้อย่างรวดเร็วเพื่อวินิจฉัยปัญหาข้อผิดพลาด ประสิทธิภาพ และเวลาในการตอบสนอง รวมถึงแหล่งที่มาของปัญหา
ข้อมูลวิเคราะห์ Edge API
Edge API Analytics จะรวบรวมและวิเคราะห์ข้อมูลที่ส่งผ่าน API Analytics API จะบันทึกข้อมูลต่อไปนี้
- แนวโน้มของการเข้าชม API เมื่อเวลาผ่านไป
- แอปยอดนิยมของคุณคือแอปใด
- นักพัฒนาแอปยอดนิยมของคุณคือใคร
- วิธีการ API ใดได้รับความนิยมมากที่สุด
- เวลาที่เวลาในการตอบกลับของ API เร็วที่สุด/ช้าที่สุด
- คุณเห็นการเข้าชม API มากที่สุดจากพื้นที่ทางภูมิศาสตร์ใด
ข้อมูลที่รวบรวมโดย API Analytics
Analytics สำหรับ API จะรวบรวมและวิเคราะห์ข้อมูลหลากหลายประเภทที่ส่งผ่าน API ตัวอย่างเช่น ขณะใช้งาน API อยู่ Analytics จะบันทึกจํานวนข้อความที่ได้รับ จํานวนนักพัฒนาแอป เวลาที่ใช้ในการตอบกลับ ข้อผิดพลาด จํานวนแอปที่ใช้อยู่ ขนาดคําขอ และข้อมูลอื่นๆ อีกมากมายอย่างต่อเนื่อง
ดูข้อมูลเบื้องต้นเกี่ยวกับเมตริกและวิธีใช้ได้ที่ใช้ API ของเมตริกเพื่อวัดประสิทธิภาพโปรแกรม API ดูรายการเมตริกทั้งหมดได้ที่การอ้างอิงมิติข้อมูล เมตริก และตัวกรอง Analytics
รวบรวมเมตริกที่กําหนดเอง
นอกจากนี้ คุณยังรวบรวมเมตริกที่กําหนดเองได้โดยใช้นโยบาย StatisticsCollector นโยบาย StatisticsCollector สามารถเขียนข้อมูลจากส่วนหัวของคําขอ เพย์โหลด XML/JSON พารามิเตอร์การค้นหา URI และตําแหน่งอื่นๆ ไปยังเซิร์ฟเวอร์ Analytics สําหรับการวิเคราะห์และการสร้างรายงาน
เข้าถึงข้อมูล Analytics
เมื่อสร้างแล้ว คุณจะเข้าถึงเมตริกที่กําหนดไว้ล่วงหน้าและเมตริกที่กําหนดเองได้โดยใช้เครื่องมือแสดงข้อมูลเป็นภาพ Analytics API ซึ่งรวมถึงหน้าแดชบอร์ด รายงานที่กําหนดเอง และแผนที่ภูมิศาสตร์ ดูข้อมูลเพิ่มเติมเกี่ยวกับเครื่องมือแสดงภาพซึ่ง Analytics API มีให้ได้ที่หน้าแดชบอร์ด Analytics ดูข้อมูลเพิ่มเติมเกี่ยวกับรายงานที่กําหนดเองได้ที่หัวข้อสร้างรายงานที่กําหนดเอง
เปรียบเทียบการตรวจสอบ API กับข้อมูลวิเคราะห์ API
นักพัฒนา API ใช้ทั้งการตรวจสอบ API และข้อมูลวิเคราะห์ API ความแตกต่างหลักอย่างหนึ่งระหว่างการตรวจสอบ API กับการตรวจสอบการเรียก API คือกลไกการแจ้งเตือนที่รวมอยู่ในการตรวจสอบ API การแจ้งเตือนช่วยให้ทีมปฏิบัติการสามารถตอบกลับปัญหาเกี่ยวกับ API แบบเรียลไทม์เพื่อให้มั่นใจว่า API พร้อมใช้งานและทำงานได้ตามที่คาดไว้
เงื่อนไขการแจ้งเตือนจะกำหนดรหัสสถานะ (2xx/4xx/5xx) เวลาในการตอบสนอง และเกณฑ์รหัสข้อบกพร่องที่เฉพาะเจาะจง ซึ่งเมื่อเกินเกณฑ์แล้ว ระบบจะเรียกให้แสดงการแจ้งเตือนแบบภาพใน UI และส่งการแจ้งเตือนผ่านช่องทางต่างๆ เช่น อีเมล, Slack, PagerDuty หรือ Webhook คุณสามารถตั้งค่าการแจ้งเตือนที่ระดับสภาพแวดล้อม พารามิเตอร์การเข้าถึง API หรือบริการเป้าหมาย หรือระดับภูมิภาค
หลังจากมีการทริกเกอร์การแจ้งเตือนแล้ว ทีมปฏิบัติการจะใช้ UI การตรวจสอบ API เพื่อตรวจสอบปัญหาและเจาะลึกสาเหตุของปัญหาได้ จากนั้นคุณจะสร้างรายงานที่กําหนดเองซึ่งมีข้อมูลที่กําหนดไว้ล่วงหน้าเกี่ยวกับการแจ้งเตือนได้ เช่น
- เวลาในการตอบกลับทั้งหมด
- เวลาในการตอบกลับเป้าหมาย
- ข้อผิดพลาดเกี่ยวกับพร็อกซี
- ข้อผิดพลาดเกี่ยวกับเป้าหมาย
- UUID ของคําขอ
- และอื่นๆ อีกมากมาย
Analytics ของ API ได้รับการออกแบบมาเพื่อเก็บรวบรวมข้อมูลหลากหลายประเภทไว้ให้หลายทีมใช้ เช่น
- ทีมปฏิบัติการสามารถใช้ข้อมูล Analytics เพื่อระบุช่วงเวลาที่มีการเข้าชมสูงหรือต่ำ เพื่อให้ปรับขนาดบริการให้เหมาะสมกับดีมานด์ที่เปลี่ยนแปลงไปได้
- ทีมการตลาดสามารถใช้ข้อมูล Analytics เพื่อระบุรูปแบบการใช้งานของลูกค้าที่ระบุโดย API, แอป, ลูกค้า หรือข้อมูลอื่นๆ แต่ละรายการ
- ทีมทั้งหมดสามารถเข้าถึงข้อมูลที่กําหนดเองซึ่งรวบรวมจากคําขอเพื่อติดตามข้อมูลเฉพาะ เช่น ค่าส่วนหัว พารามิเตอร์การค้นหา หรือเพย์โหลดคําขอ