สร้างรายงานที่กําหนดเอง

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

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

สร้างรายงานที่กำหนดเองตามบริบท

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

บริบทของรายงานที่กำหนดเอง	แบบแผนการตั้งชื่อเริ่มต้นสำหรับรายงานที่กำหนดเอง
แดชบอร์ดล่าสุด	API Monitoring Recent Generated
แดชบอร์ดไทม์ไลน์	API Monitoring Timeline Generated
ตรวจสอบแดชบอร์ด	API Monitoring Investigate Generated
เงื่อนไขในการแจ้งเตือน	API Monitoring Generated: alert-name

มิติข้อมูลและเมตริกเริ่มต้น

รายงานที่กำหนดเองจะรวมมิติข้อมูลและเมตริกที่ระบุไว้ในตารางต่อไปนี้สำหรับรายงานที่สร้างของ API Monitoring ทั้งหมดโดยค่าเริ่มต้น

ส่วนประกอบ	ค่าเริ่มต้น
ขนาด	URI คำขอ
เมตริก	เวลาในการตอบกลับทั้งหมด เวลาตอบสนองเป้าหมาย ข้อผิดพลาดของพร็อกซี ข้อผิดพลาดของเป้าหมาย

แก้ไขรายงานที่กำหนดเอง

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

ในรายงานที่กำหนดเองต่อไปนี้ คุณเพิ่มมิติข้อมูล Gateway Flow ID ที่กำหนดไว้ล่วงหน้า โดยที่ Gateway Flow ID จะมี UUID ที่ไม่ซ้ำกันของคำขอ API แต่ละรายการที่ส่งไปยัง Edge โปรดทราบว่ารายงานใช้มิติข้อมูล Request URI อยู่แล้ว ดังนี้

ตัวอย่างต่อไปนี้เพิ่มมิติข้อมูล Client ID ลงในรายงานที่กำหนดเอง มิติข้อมูล Client ID มีคีย์ผู้ใช้ (คีย์ API) ของนักพัฒนาซอฟต์แวร์ที่ทำการเรียก API ไม่ว่าจะส่งในคำขอเป็นคีย์ API หรือรวมอยู่ในโทเค็น OAuth

รายงานที่กําหนดเองมีข้อมูลสําหรับค่า Client ID ทั้งหมด ตัวอย่างถัดไปจะเพิ่มตัวกรองเพื่อให้คุณสร้างรายงานที่กำหนดเองสำหรับ Client ID ที่ต้องการได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับมิติข้อมูลและเมตริกที่กําหนดไว้ล่วงหน้าทั้งหมดที่คุณเพิ่มลงในรายงานได้ที่หัวข้อข้อมูลอ้างอิงเมตริก มิติข้อมูล และตัวกรองของ Analytics

ในตัวอย่างถัดไป คุณเพิ่มตัวกรองลงในรายงานที่กำหนดเองซึ่งบันทึกเมตริกและมิติข้อมูลเริ่มต้นสำหรับรหัสข้อผิดพลาด policies.ratelimit.QuotaViolation และรหัสสถานะ 5xx ดังนี้

สำหรับรายละเอียดทั้งหมดเกี่ยวกับวิธีแก้ไขรายงานที่กำหนดเอง โปรดดูจัดการรายงานที่กำหนดเอง

ตัวอย่าง: ใช้รายงานที่กำหนดเองเพื่อวินิจฉัยปัญหาการทำให้ใช้งานได้

แนบนโยบายเครื่องมือรวบรวมข้อมูลสถิติกับพร็อกซี API เพื่อรวบรวมข้อมูลวิเคราะห์ที่กำหนดเอง เช่น รหัสผู้ใช้หรือผลิตภัณฑ์, ราคา, การดำเนินการ REST, เวอร์ชันเป้าหมาย, URL เป้าหมาย และความยาวของข้อความ ข้อมูลอาจมาจากตัวแปรโฟลว์ที่ Apigee, ส่วนหัวของคำขอ, พารามิเตอร์การค้นหา หรือตัวแปรที่กำหนดเองที่คุณกำหนด

ตัวอย่างเช่น คำขอที่ส่งไปยังพร็อกซี API จะมีส่วนหัวสำหรับรหัสผลิตภัณฑ์ รหัสผู้ใช้ และเวอร์ชันของเซิร์ฟเวอร์เป้าหมาย คำขอนี้สามารถอยู่ในรูปแบบ:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

จากนั้นคุณจะใช้ข้อมูลในส่วนหัวเพื่อช่วยวินิจฉัยปัญหารันไทม์กับพร็อกซี API ได้

หากต้องการสร้างรายงานที่กำหนดเองสำหรับส่วนหัวเหล่านี้ ให้ทำดังนี้

1. เพิ่มนโยบายเครื่องมือรวบรวมข้อมูลสถิติลงใน API เพื่อบันทึกค่าของส่วนหัวที่กำหนดเอง ดังนี้

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>
   

2. ทำให้พร็อกซีใช้งานได้และเผื่อเวลาในการเข้าถึง

3. คลิกวิเคราะห์ > การตรวจสอบ API > ล่าสุดใน Edge UI เพื่อดูปัญหาเกี่ยวกับ API ของคุณ โปรดทราบว่าคุณได้รับข้อผิดพลาด 4xx และ 5xx สำหรับพร็อกซี myapi ดังนี้

   

4. เลือกแถวพร็อกซี myapi เพื่อดูรายละเอียดเพิ่มเติมในแผงด้านขวาของหน้าแดชบอร์ดล่าสุด

5. ในแผงด้านขวาของหน้าแดชบอร์ดล่าสุด ให้เลือก > ดูในการตรวจสอบ เพื่อเข้าถึงหน้าแดชบอร์ดการตรวจสอบ ดังนี้

   

6. กรองหน้าแดชบอร์ดการตรวจสอบตามพร็อกซี myapi จากนั้นดูรหัสสถานะในอันดับสูงสุด โปรดทราบว่าคุณได้รับข้อผิดพลาด 403 และ 501

   

7. ใน Edge UI ให้เลือก Analytics > รายงานที่กำหนดเอง > รายงาน เพื่อสร้างรายงานที่กำหนดเองที่รวมค่าของเมตริกที่กำหนดเองเหล่านี้เป็นมิติข้อมูล

8. เลือก + รายงานที่กำหนดเอง เพื่อสร้างรายงานที่กำหนดเองชื่อ myapi_errors

9. เลือกข้อผิดพลาดพร็อกซีเป็นเมตริก แล้วตั้งค่าฟังก์ชันรวมเป็นผลรวม คุณเพิ่มเมตริกได้อีกหากต้องการ

10. เลือกมิติข้อมูลรหัสสถานะการตอบกลับที่กำหนดไว้ล่วงหน้า จากนั้นเพิ่มสถิติที่กำหนดเอง 3 รายการ prodid, targetersion และ userid ลงในมิติข้อมูล ดังนี้

    

11. ตั้งค่าตัวกรองให้รวมเฉพาะข้อมูลสำหรับพร็อกซี myapi API (apiproxy eq 'myapi') ดังนี้

    

12. บันทึกรายงาน

13. เรียกใช้รายงานสำหรับ 24 ชั่วโมงที่ผ่านมา เมื่อเปิดรายงานครั้งแรก คุณจะเห็นแผนภูมิข้อผิดพลาด HTTP 403 และ 501 ดังนี้

    

14. ในส่วนสรุป ให้คลิก 403 หรือ 510 เพื่อดูว่าผลิตภัณฑ์ใดทําให้เกิดข้อผิดพลาด ตัวอย่างเช่น คุณเลือก 403

    

15. คลิกรหัสผลิตภัณฑ์ในส่วนสรุปเพื่อดูข้อผิดพลาดตามเวอร์ชันเป้าหมาย (อัลฟ่าหรือเบต้า)

    

16. คลิกเวอร์ชันเป้าหมายในส่วนสรุปเพื่อดูข้อผิดพลาดตามผู้ใช้ ดังนี้