คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
หัวข้อนี้จะแนะนำข้อมูลวิเคราะห์ API ของ Edge
วิดีโอ: ดูวิดีโอสั้นๆ เพื่อดูภาพรวมของบริการข้อมูลวิเคราะห์ API ของ Edge
ปรับปรุง API ผ่านข้อมูลวิเคราะห์
ข้อมูลวิเคราะห์ API ของ Edge จะรวบรวมและคำนวณข้อมูลจำนวนมากที่ไหลผ่านพร็อกซี API คุณสามารถแสดงข้อมูลนี้เป็นภาพด้วยกราฟและแผนภูมิใน UI ของ Edge หรือดาวน์โหลดข้อมูลดิบเพื่อ วิเคราะห์แบบออฟไลน์โดยใช้ API การจัดการของ Edge
ข้อมูลวิเคราะห์ช่วยให้คุณตอบคำถามที่พบบ่อยได้ เช่น
- การเข้าชม API ของฉันมีแนวโน้มเป็นอย่างไรในช่วงเวลาต่างๆ
- เมธอด API ใดได้รับความนิยมมากที่สุด
- ใครคือนักพัฒนาแอปยอดนิยมของฉัน
- เวลาในการตอบกลับของ API เร็วที่สุดเมื่อใด ช้าที่สุดเมื่อใด
- การเข้าชม API ส่วนใหญ่มาจากที่ใดในเชิงภูมิศาสตร์
คำตอบของคำถามเหล่านี้จะช่วยให้คุณปรับปรุง API แก้ปัญหา และตัดสินใจทางธุรกิจได้ดียิ่งขึ้นเกี่ยวกับโปรแกรม API
ข้อมูลวิเคราะห์ API ช่วยให้ทุกคนปรับปรุงได้
ข้อมูลวิเคราะห์ API ของ Edge ช่วยให้ทีม API ปรับปรุง API และช่วยให้นักพัฒนาแอปปรับปรุงแอปของตนเองผ่านกระบวนการรวบรวม วิเคราะห์ และแสดงข้อมูลเป็นภาพอย่างต่อเนื่อง
- ทีม API - ทีม API กำลังใช้ประโยชน์จากระบบภายในเพื่อสร้าง API ที่น่าสนใจ ทีม API ต้องการทราบภาพรวมของโปรแกรม API ประสิทธิภาพของ API แต่ละรายการ และวิธีปรับปรุง API
- นักพัฒนาแอป - การแชร์ข้อมูลวิเคราะห์กับนักพัฒนาแอป, จะช่วยให้คุณได้แอปที่ดีขึ้น นักพัฒนาแอปเหล่านี้กำลังสร้างสรรค์สิ่งใหม่ๆ ด้วย API ของคุณและสร้างแอปที่สร้างสรรค์ซึ่งช่วยเพิ่มรายได้ให้กับองค์กรของคุณ ข้อมูลวิเคราะห์ช่วยให้นักพัฒนาแอปทราบประสิทธิภาพของแอปและจำนวนเงินที่แอปสร้างรายได้ให้กับองค์กร นักพัฒนาแอปต้องการทราบวิธีปรับปรุงแอปของตนเอง
- ทีมปฏิบัติการ - ทีมปฏิบัติการ ต้องการทำความเข้าใจรูปแบบการเข้าชมและ คาดการณ์เวลาที่จะเพิ่มทรัพยากรแบ็กเอนด์หรือทำการปรับเปลี่ยนที่สำคัญอื่นๆ
- เจ้าของธุรกิจ \- เจ้าของธุรกิจ ต้องการดูผลตอบแทนจากการลงทุน API และจุดที่จะลงทุนกับ API ในอนาคต
ระบบรวบรวมและวิเคราะห์ข้อมูลประเภทใด
ข้อมูลวิเคราะห์ API ของ Edge จะรวบรวมและวิเคราะห์ข้อมูลที่หลากหลายซึ่งไหลผ่านพร็อกซี API เช่น
- เวลาในการตอบกลับ
- เวลาในการตอบสนองของคำขอ
- ขนาดคำขอ
- ข้อผิดพลาดเป้าหมาย
- ชื่อผลิตภัณฑ์ API
- อีเมลของนักพัฒนาแอป
- ชื่อแอป
- และอื่นๆ อีกมากมาย
หากต้องการดูรายการข้อมูลทั้งหมดที่ข้อมูลวิเคราะห์ API รวบรวม โปรดดู เอกสารอ้างอิงเมตริก มิติข้อมูล และตัวกรองของข้อมูลวิเคราะห์
ฉันจะรวบรวมข้อมูลวิเคราะห์ที่กำหนดเองได้อย่างไร
Edge จะรวบรวมข้อมูลจำนวนมากโดยค่าเริ่มต้น นอกจากนี้ คุณอาจต้องการรวบรวมข้อมูลวิเคราะห์ที่กำหนดเองซึ่งเฉพาะเจาะจงกับพร็อกซี API, แอป, ผลิตภัณฑ์ หรือนักพัฒนาแอป เช่น คุณอาจต้องการรวบรวมข้อมูลวิเคราะห์จากพารามิเตอร์การค้นหา, ส่วนหัวของคำขอ, เนื้อหาของคำขอและการตอบกลับ หรือตัวแปรที่คุณกำหนดใน API
คุณรวบรวมข้อมูลวิเคราะห์ที่กำหนดเองได้โดยใช้นโยบาย StatisticsCollector เมื่อแยกข้อมูลที่กำหนดเองแล้ว คุณสามารถใช้ UI หรือ API ของข้อมูลวิเคราะห์เพื่อตรวจสอบข้อมูลได้ ดูตัวอย่างที่สมบูรณ์ซึ่งแสดงวิธีรวบรวมข้อมูลวิเคราะห์ที่กำหนดเองได้ที่วิเคราะห์เนื้อหาข้อความ API โดยใช้ข้อมูลวิเคราะห์ที่กำหนดเอง
ความแตกต่างระหว่างข้อมูลวิเคราะห์กับข้อมูลการตรวจสอบ API
ส่วนนี้จะอธิบายความแตกต่างเล็กน้อยระหว่างข้อมูลที่รวบรวมโดยข้อมูลวิเคราะห์ของ Edge กับการตรวจสอบ API เนื่องจากการตรวจสอบ API และข้อมูลวิเคราะห์ใช้ไปป์ไลน์ข้อมูลที่แตกต่างกัน คุณจึงอาจเห็นความแตกต่างเล็กน้อยระหว่างรายงานที่กำหนดเองซึ่งสร้างโดยการตรวจสอบกับรายงานที่สร้างโดยข้อมูลวิเคราะห์ เช่น คุณอาจเห็นความคลาดเคลื่อนในผลลัพธ์ที่รายงานสำหรับข้อผิดพลาดการหมดเวลา ทั้งการหมดเวลาของแบ็กเอนด์ (รหัสสถานะ HTTP 504 ในคำขอ) และการหมดเวลาของไคลเอ็นต์ (รหัสสถานะ HTTP 499) ข้อผิดพลาดเหล่านี้อาจปรากฏพร้อมรหัสสถานะ 200 ในรายงานที่กำหนดเองของข้อมูลวิเคราะห์ แต่จะแสดงพร้อมรหัสสถานะ 504 หรือ 499 ในรายงานที่กำหนดเองของการตรวจสอบข้อมูลวิเคราะห์ของฉันพร้อมใช้งานเมื่อใดและนานเท่าใด
มีช่วงเวลา 2 ช่วงที่ควบคุมเวลาและระยะเวลาที่คุณจะดูข้อมูลวิเคราะห์ได้
- ช่วงเวลาหน่วงของข้อมูล - หลังจากเรียกพร็อกซี API แล้ว ระบบอาจใช้เวลาถึง 10 นาทีเพื่อให้เข้าถึงข้อมูลเพื่อแสดงหรือผ่านการเรียก API การจัดการได้
- การเก็บรักษาข้อมูล -
ระยะเวลาที่เก็บรักษาข้อมูลวิเคราะห์จะขึ้นอยู่กับแพ็กเกจการสมัครใช้บริการ ดังนี้:
- Standard: 30 วัน
- Enterprise: 3 เดือน
- Enterprise Plus: 14 เดือน
ฉันจะเข้าถึงข้อมูลวิเคราะห์ได้อย่างไร
ข้อมูลวิเคราะห์ API ของ Edge มีเครื่องมือแสดงข้อมูลเป็นภาพที่สร้างขึ้นใน UI ของ Edge เครื่องมือเหล่านี้ประกอบด้วยแดชบอร์ดข้อมูลวิเคราะห์ที่กำหนดไว้ล่วงหน้าและรายงานที่กำหนดเองซึ่งแสดงข้อมูลในกราฟและแผนภูมิ รวมถึงช่วยให้คุณเจาะลึกเพื่อดูข้อมูลที่จัดกลุ่มตามมิติข้อมูลต่างๆ (เช่น ตามพร็อกซี API, ที่อยู่ IP หรือรหัสสถานะ HTTP)
นอกจากนี้ คุณยังดาวน์โหลดข้อมูลวิเคราะห์ได้โดยใช้ API การจัดการของ Edge เมื่อดาวน์โหลดแล้ว คุณสามารถนำเข้าข้อมูลดังกล่าวลงในเครื่องมือแสดงข้อมูลเป็นภาพหรือระบบข้อมูลวิเคราะห์ของคุณเองได้
แดชบอร์ดข้อมูลวิเคราะห์
UI ของ Edge มีแดชบอร์ดที่กำหนดไว้ล่วงหน้าซึ่งคุณใช้เพื่อดูข้อมูลวิเคราะห์ได้ ตัวอย่างเช่น รูปภาพต่อไปนี้แสดงแดชบอร์ดประสิทธิภาพของพร็อกซี
แดชบอร์ดนี้มีแผนภูมิสำหรับข้อมูลต่อไปนี้
- การเข้าชมทั้งหมด - จำนวนคำขอ API ทั้งหมดที่ Edge ได้รับสำหรับสภาพแวดล้อม API ในองค์กร
- การเข้าชมที่สำเร็จ - จำนวนคำขอทั้งหมดที่ส่งผลให้การตอบกลับสำเร็จ การตอบกลับข้อผิดพลาดจะไม่นับ
- ข้อผิดพลาดในการเข้าชม - จำนวนคำขอ API ทั้งหมดที่ไม่สำเร็จ ซึ่งหมายความว่าคำขอไม่ส่งการตอบกลับ จำนวนนี้รวมทั้งข้อผิดพลาดของพร็อกซี (ฝั่ง Apigee) และข้อผิดพลาดเป้าหมาย (บริการแบ็กเอนด์)
- TPS เฉลี่ย - จำนวนคำขอ API และการตอบกลับที่ได้เฉลี่ยต่อวินาที
แดชบอร์ดที่กำหนดไว้ล่วงหน้าอื่นๆ ได้แก่
- ประสิทธิภาพของแคช
- การมีส่วนร่วมของนักพัฒนาแอป
- การใช้อุปกรณ์
- การวิเคราะห์รหัสข้อผิดพลาด
- GeoMap
- การวิเคราะห์เวลาในการตอบสนอง
- ประสิทธิภาพเป้าหมาย
- องค์ประกอบการเข้าชม
ดูข้อมูลเพิ่มเติมเกี่ยวกับแดชบอร์ดที่กำหนดไว้ล่วงหน้าเหล่านี้ได้ที่ การใช้แดชบอร์ดข้อมูลวิเคราะห์
รายงานที่กำหนดเอง
รายงานที่กำหนดเองช่วยให้คุณเจาะลึกเมตริก API ที่เฉพาะเจาะจงและดูข้อมูลที่ต้องการได้ คุณสามารถสร้างรายงานที่กำหนดเองได้โดยใช้ข้อมูลวิเคราะห์ที่สร้างขึ้นใน Edge หรือข้อมูลวิเคราะห์ที่กำหนดเอง ซึ่งรวบรวมโดย นโยบาย StatisticsCollector
เมื่อสร้างรายงานที่กำหนดเอง คุณจะต้องเลือกข้อมูลที่ต้องการดู (เมตริก) จัดกลุ่มข้อมูลในลักษณะที่มีความหมาย (มิติข้อมูล) และเลือกจำกัดข้อมูลที่แสดงผลตามลักษณะเฉพาะของข้อมูล (การกรอง)
นอกจากนี้ คุณยังตั้งค่าประเภทแผนภูมิที่แสดงในรายงานที่กำหนดเองเป็นแผนภูมิคอลัมน์หรือแผนภูมิเส้นได้ด้วย รูปภาพต่อไปนี้แสดงตัวอย่างแผนภูมิสำหรับธุรกรรมต่อวินาทีที่จัดกลุ่มตามพร็อกซี API
คอลัมน์ - พร็อกซี API แต่ละรายการแสดงด้วยคอลัมน์ที่ต่างกัน

เส้น - พร็อกซี API แต่ละรายการแสดงด้วยเส้นที่ต่างกัน

ดูข้อมูลเพิ่มเติมได้ที่ สร้างและจัดการรายงานที่กำหนดเอง
API ของข้อมูลวิเคราะห์
ใช้ API การจัดการของ Edge เพื่อดาวน์โหลดข้อมูลวิเคราะห์ เช่น คุณสามารถใช้ API เพื่อสร้างเครื่องมือแสดงข้อมูลเป็นภาพของคุณเองซึ่งฝังไว้ในพอร์ทัลหรือแอปที่กำหนดเองได้
นี่คือตัวอย่างการเรียก API เพื่อดึงข้อมูลวิเคราะห์สำหรับพร็อกซี API
curl https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \ -u email:password
การเรียกนี้จะแสดงผลข้อมูลต่อไปนี้
- ผลรวมของคำขอ (จำนวนข้อความ) ต่อพร็อกซี API
- สำหรับช่วงเวลา 24 ชั่วโมง
- จัดกลุ่มตามชั่วโมง
พารามิเตอร์การค้นหา timeRange จะระบุช่วงเวลาในรูปแบบต่อไปนี้
?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM
โปรดสังเกต %20 ก่อน HH:MM พารามิเตอร์ timeRange ต้องมี
อักขระช่องว่างที่เข้ารหัส URL ก่อน HH:MM หรืออักขระ + เช่น
MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM
ดูข้อมูลเพิ่มเติมได้ที่ ใช้ API เมตริกเพื่อวัดประสิทธิภาพของโปรแกรม API
ส่งออกข้อมูลวิเคราะห์ไปยัง Google Cloud
คุณสามารถใช้ API การจัดการของ Edge เพื่อส่งออกข้อมูลวิเคราะห์ทั้งหมดสำหรับทั้งวันจาก Edge ไปยังที่เก็บข้อมูลของคุณเอง เช่น Google Cloud Storage หรือ BigQuery จากนั้นใช้ประโยชน์จากความสามารถในการค้นหาและการเรียนรู้ของเครื่องอันทรงพลังที่ Google Cloud BigQuery และ TensorFlow มีให้เพื่อทำการวิเคราะห์ข้อมูลของคุณเอง
ดูข้อมูลเพิ่มเติมได้ที่ ส่งออกข้อมูลจากข้อมูลวิเคราะห์
ฉันจะแชร์ข้อมูลกับนักพัฒนาแอปได้อย่างไร
เมื่อคุณคิดว่านักพัฒนาแอปเป็นลูกค้า คุณจะต้องการตรวจสอบว่านักพัฒนาแอปมีเครื่องมือและข้อมูลที่พร้อมใช้งานเพื่อใช้ API ของคุณให้เกิดประโยชน์สูงสุด
นักพัฒนาแอปไม่เพียงกังวลเกี่ยวกับคุณภาพของแอปเท่านั้น แต่ยังสนใจ API ของคุณด้วย พอร์ทัลสำหรับนักพัฒนาแอปที่ใช้ Drupal มีหน้าประสิทธิภาพของแอป ที่ไม่บังคับ ซึ่งออกแบบมาเพื่อให้สิทธิ์เข้าถึง เมตริกที่สำคัญสำหรับแอปแก่นักพัฒนาแอป หน้านี้จะให้ข้อมูลต่อไปนี้แก่นักพัฒนาแอป
- ข้อผิดพลาด: แอปของฉันพบข้อผิดพลาด API ใดบ้าง
- ประสิทธิภาพ: ตอนนี้ API ช้าหรือไม่ เมธอด API ใดที่มักจะช้า หรือช้าในขณะนี้
- ความพร้อมใช้งาน: ตอนนี้ API พร้อมใช้งานหรือไม่
- โควต้า: API ของคุณมีโควต้าหรือไม่ และในฐานะนักพัฒนาแอป ฉันมีประสิทธิภาพเป็นอย่างไรเมื่อเทียบกับโควต้า
ดูข้อมูลเพิ่มเติมได้ที่
- Drupal 7: การแสดงข้อมูลวิเคราะห์สำหรับการใช้งานแอป
- Drupal 8: ตรวจสอบแอป
- พอร์ทัลแบบผสานรวม: ไม่พร้อมใช้งาน
นอกจากนี้ คุณยังแชร์ข้อมูลวิเคราะห์กับนักพัฒนาแอปได้โดยทำดังนี้
- สร้างรายงานที่กำหนดเองและแชร์กับนักพัฒนาแอป ดูข้อมูลเพิ่มเติมได้ที่ ดูสร้างรายงานที่กำหนดเอง
- ใช้ API การจัดการของ Edge เพื่อรวบรวมข้อมูลในช่วงเวลาที่ยาวนานขึ้นเพื่อแชร์กับนักพัฒนาแอป แบบออฟไลน์ ดูข้อมูลเพิ่มเติมได้ที่ ใช้ API เมตริกเพื่อวัดประสิทธิภาพของโปรแกรม API
ฉันจะสร้างข้อมูลวิเคราะห์ที่สมบูรณ์ได้อย่างไร
ข้อมูลวิเคราะห์ที่สมบูรณ์หมายถึงอะไร เช่น คุณสามารถสร้างพร็อกซี API และ Edge จะรวบรวมข้อมูลวิเคราะห์เกี่ยวกับพร็อกซีนั้น แต่เมตริกสำหรับนักพัฒนาแอปหรือแอปที่เรียกพร็อกซี API ล่ะ หาก Edge ไม่ทราบว่าใครเป็นผู้เรียก API ระบบก็จะไม่สามารถรวบรวมข้อมูลนั้นได้
คุณต้องทำตามขั้นตอน 2-3 ขั้นตอนเพื่อให้ Edge ทราบว่านักพัฒนาแอปและแอปของนักพัฒนาแอปใดที่เรียกพร็อกซี API ของคุณ ต่อไปนี้คือรายการขั้นตอนเหล่านั้นพร้อมลิงก์ไปยังข้อมูลโดยละเอียดเพิ่มเติม
- สร้างผลิตภัณฑ์ API อย่างน้อย 1 รายการ ซึ่งเป็นการจัดกลุ่มพร็อกซี API พร้อมกับ แพ็กเกจบริการ ดูจัดการผลิตภัณฑ์ API
- ลงทะเบียนนักพัฒนาแอป กับ Edge ดู ลงทะเบียนนักพัฒนาแอป
- ลงทะเบียนแอป และสร้างคีย์ API ให้นักพัฒนาแอป ดู ลงทะเบียนแอปและจัดการคีย์ API
- เพิ่มนโยบายความปลอดภัยลงในพร็อกซี API ที่ตรวจสอบคีย์ API และ/หรือโทเค็นความปลอดภัย ดูหัวข้อต่อไปนี้ นโยบายตรวจสอบคีย์ API, นโยบาย OAuthV2 และ นโยบายตรวจสอบ JWT
- หากคุณใช้ Edge Microgateway, ให้ตรวจสอบว่าได้เปิดใช้ปลั๊กอินข้อมูลวิเคราะห์ แล้ว (ซึ่งเปิดใช้โดยค่าเริ่มต้น) หากปิดใช้ปลั๊กอินข้อมูลวิเคราะห์ Edge Microgateway จะไม่ส่งข้อมูลวิเคราะห์ไปยังข้อมูลวิเคราะห์ของ Edge
บทแนะนำต่อไปนี้จะแนะนำขั้นตอนที่จำเป็นซึ่งช่วยให้คุณดูข้อมูลวิเคราะห์สำหรับ นักพัฒนาแอปและแอปได้ ปลอดภัย API โดยกำหนดให้ใช้คีย์ API และ ปลอดภัย API ด้วย OAuth
เปรียบเทียบข้อมูลวิเคราะห์ API กับการตรวจสอบ API
คุณสามารถใช้ประโยชน์จากการตรวจสอบ API ของ Edge และข้อมูลวิเคราะห์ API ได้ การตรวจสอบ API จะตรวจสอบข้อมูลวิเคราะห์เพื่อมอบข้อมูลเชิงลึกตามบริบทแบบเรียลไทม์เกี่ยวกับประสิทธิภาพของ API ซึ่งช่วยให้คุณวินิจฉัยปัญหาได้อย่างรวดเร็วและอำนวยความสะดวกในการดำเนินการแก้ไขเพื่อความต่อเนื่องทางธุรกิจ การตรวจสอบ API ออกแบบมาเพื่อค้นหาจุดที่มีปัญหาใน API และแบ็กเอนด์ได้อย่างรวดเร็ว ข้อมูลวิเคราะห์ API ออกแบบมาเพื่อรวบรวมข้อมูลวิเคราะห์ที่หลากหลายเพื่อให้ทีมต่างๆ นำไปใช้ แต่โดยทั่วไปแล้วข้อมูลจะใช้สำหรับการวิเคราะห์ในสถานการณ์ที่ไม่ใช่แบบเรียลไทม์
ความแตกต่างหลักอย่างหนึ่งระหว่างการตรวจสอบ API กับข้อมูลวิเคราะห์ API คือกลไกการแจ้งเตือนที่สร้างขึ้นในการตรวจสอบ API การแจ้งเตือนช่วยให้คุณระบุรหัสสถานะ HTTP (2xx/4xx/5xx), เวลาในการตอบสนอง หรือเกณฑ์รหัสข้อผิดพลาดที่เมื่อเกินแล้วจะทริกเกอร์การแจ้งเตือนไปยังทีมปฏิบัติการ การแจ้งเตือนสามารถส่งผ่านช่องทางต่างๆ เช่น อีเมล, Slack, เพจเจอร์ หรือเว็บฮุก ซึ่งช่วยให้คุณตอบสนองต่อปัญหาได้ทันที
ดูการเปรียบเทียบโดยละเอียดเพิ่มเติมระหว่างบริการเหล่านี้ได้ที่เปรียบเทียบการตรวจสอบ API กับข้อมูลวิเคราะห์ API ของ Edge