หน้านี้ได้รับการแปลโดย Cloud Translation API

ภาพรวม API ของ Analytics

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

หัวข้อนี้จะแนะนำข้อมูลวิเคราะห์ของ Edge API

วิดีโอ: ดูวิดีโอสั้นๆ สำหรับภาพรวมของบริการข้อมูลวิเคราะห์ Edge API

ปรับปรุง API ผ่านข้อมูลวิเคราะห์

Edge API Analytics จะรวบรวมและคำนวณข้อมูลจำนวนมากที่ไหลผ่านพร็อกซี API คุณสามารถดูข้อมูลนี้ด้วยกราฟและแผนภูมิใน Edge UI หรือจะดาวน์โหลดข้อมูลดิบสำหรับ การวิเคราะห์แบบออฟไลน์โดยใช้ Edge Management API

Analytics ช่วยตอบคําถามที่พบบ่อย เช่น

การเข้าชม API ของฉันมีแนวโน้มอย่างไรเมื่อเวลาผ่านไป
เมธอด API ใดได้รับความนิยมมากที่สุด
นักพัฒนาซอฟต์แวร์ยอดนิยมของฉันคือใคร
เวลาในการตอบกลับของ API เร็วที่สุดเมื่อใด ช้าที่สุดไหม
ฉันจะดูการเข้าชม API ส่วนใหญ่ได้จากที่ใดในทางภูมิศาสตร์

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

Analytics API ช่วยให้ทุกคนปรับปรุงได้

การวิเคราะห์ Edge API ช่วยทีม API ของคุณปรับปรุง API และช่วยให้นักพัฒนาแอปปรับปรุงแอปของตนผ่านกระบวนการรวบรวม วิเคราะห์ และแสดงข้อมูลเป็นภาพอย่างต่อเนื่อง

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

มีการรวบรวมและวิเคราะห์ข้อมูลประเภทใด

ข้อมูลวิเคราะห์ Edge API จะรวบรวมและวิเคราะห์ข้อมูลหลากหลายรูปแบบที่ไหลผ่านพร็อกซี API เช่น

เวลาตอบสนอง
ส่งคำขอเวลาในการตอบสนอง
ขนาดคำขอ
ข้อผิดพลาดเป้าหมาย
ชื่อผลิตภัณฑ์ API
อีเมลของนักพัฒนาแอป
ชื่อแอป
อื่นๆ อีกมากมาย

ดูรายการข้อมูลทั้งหมดที่รวบรวมโดย API Analytics ได้ที่ ข้อมูลอ้างอิงเมตริก มิติข้อมูล และตัวกรองของ Analytics

ฉันจะเก็บรวบรวมข้อมูลข้อมูลวิเคราะห์ที่กำหนดเองได้อย่างไร

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

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

ความแตกต่างระหว่างข้อมูล Analytics และข้อมูลการตรวจสอบ API

ส่วนนี้จะอธิบายความแตกต่างเล็กๆ น้อยๆ ระหว่างข้อมูลที่รวบรวมโดย การวิเคราะห์ Edge เทียบกับการตรวจสอบ API เนื่องจากการตรวจสอบ API และ Analytics ใช้ไปป์ไลน์ข้อมูลที่ต่างกัน คุณจึงอาจเห็นความแตกต่างเล็กน้อยระหว่างรายงานที่กําหนดเองซึ่งการตรวจสอบสร้างขึ้นกับรายงานที่ Analytics สร้างขึ้น ตัวอย่างเช่น คุณอาจเห็น ความคลาดเคลื่อนในผลลัพธ์ที่รายงานสำหรับข้อผิดพลาดการหมดเวลา ทั้งการหมดเวลาของแบ็กเอนด์ (รหัสสถานะ HTTP 504 ในคำขอ) และระยะหมดเวลาของไคลเอ็นต์ (รหัสสถานะ HTTP 499) ซึ่งอาจแสดงโดยมีรหัสสถานะ 200 ในรายงานที่กำหนดเองของ Analytics แต่จะแสดงพร้อมกับรหัสสถานะ 504 หรือ 499 ในรายงานการตรวจสอบที่กำหนดเองของ

ข้อมูลการวิเคราะห์ของฉันจะพร้อมใช้งานเมื่อใดและนานเท่าใด

มีช่วงเวลา 2 ช่วงที่ควบคุมเวลาและระยะเวลาที่สามารถดูข้อมูลการวิเคราะห์ของคุณได้ ดังนี้

ช่วงการหน่วงเวลาของข้อมูล - หลังจากเรียกพร็อกซี API แล้ว ระบบอาจใช้เวลาถึง ใช้เวลา 10 นาทีในการเข้าถึงข้อมูลสำหรับการแสดงผลหรือผ่านการเรียก API การจัดการ
การเก็บรักษาข้อมูล - ระยะเวลาที่ Edge เก็บรักษาข้อมูลวิเคราะห์ไว้ แตกต่างกันไปตามแพ็กเกจ อาจมีข้อมูลวิเคราะห์ในช่วง 30, 60, 90 หรือ 365 วันที่ผ่านมา ทั้งนี้ขึ้นอยู่กับแพ็กเกจของคุณ

ฉันจะเข้าถึงข้อมูล Analytics ของฉันได้อย่างไร

การวิเคราะห์ Edge API มีเครื่องมือการแสดงข้อมูลผ่านภาพอยู่ใน Edge UI เครื่องมือเหล่านี้รวมถึงแดชบอร์ดข้อมูลวิเคราะห์ที่กําหนดไว้ล่วงหน้าและรายงานที่กําหนดเองซึ่งแสดงข้อมูลในกราฟและแผนภูมิ และให้คุณเจาะลึกเพื่อดูข้อมูลที่จัดกลุ่มเป็นมิติข้อมูลต่างๆ ได้ (เช่น ตามพร็อกซี API, ที่อยู่ IP หรือรหัสสถานะ HTTP)

นอกจากนี้ คุณยังดาวน์โหลดข้อมูลวิเคราะห์โดยใช้ Edge Management API ได้ด้วย เมื่อดาวน์โหลดแล้ว คุณจะนำเข้าข้อมูลนั้นลงในเครื่องมือแสดงข้อมูลเป็นภาพหรือระบบการวิเคราะห์ได้

แดชบอร์ด Analytics

Edge UI มีชุดแดชบอร์ดที่กำหนดไว้ล่วงหน้าซึ่งใช้ดูข้อมูลการวิเคราะห์ได้ ตัวอย่างเช่น รูปภาพต่อไปนี้จะแสดงหน้าแดชบอร์ดประสิทธิภาพของพร็อกซี

แดชบอร์ดนี้มีแผนภูมิสำหรับข้อมูลต่อไปนี้

การรับส่งข้อมูลทั้งหมด - จำนวนคำขอ API ทั้งหมดที่ Edge ได้รับสำหรับสภาพแวดล้อม API ในองค์กร
ความสำเร็จของการเข้าชม - จำนวนคำขอทั้งหมดที่ส่งผลให้การตอบสนองสำเร็จ โดยจะไม่นับการตอบกลับที่มีข้อผิดพลาด
ข้อผิดพลาดด้านการเข้าชม - จำนวนคำขอ API ทั้งหมดที่ดำเนินการไม่สำเร็จ กล่าวคือ คำขอจะไม่ตอบกลับ จำนวนนี้รวมทั้งข้อผิดพลาดของพร็อกซี (ฝั่ง Apigee) และข้อผิดพลาดของเป้าหมาย (บริการแบ็กเอนด์)
TPS เฉลี่ย - จำนวนคำขอ API โดยเฉลี่ยและการตอบกลับที่ได้ต่อวินาที

แดชบอร์ดที่กำหนดไว้ล่วงหน้าเพิ่มเติมมีดังนี้

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

รายงานที่กำหนดเอง

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

เมื่อสร้างรายงานที่กำหนดเอง คุณต้องเลือกข้อมูลที่ต้องการดู (เมตริก) จัดกลุ่มข้อมูลใน ด้วยวิธีที่มีความหมาย (มิติข้อมูล) และเลือกที่จะจำกัดข้อมูลที่แสดงผลตามลักษณะที่เฉพาะเจาะจงของข้อมูล (การกรอง) ได้

นอกจากนี้ยังตั้งค่าประเภทแผนภูมิที่แสดงในรายงานที่กําหนดเองเป็นแผนภูมิหรือแผนภูมิเส้นได้ด้วย รูปภาพต่อไปนี้แสดงตัวอย่างแผนภูมิของธุรกรรมต่อวินาทีที่จัดกลุ่มตามพร็อกซี API

คอลัมน์ - พร็อกซี API แต่ละรายการจะแสดงด้วยคอลัมน์ต่างๆ ดังนี้
บรรทัด - พร็อกซี API แต่ละรายการจะแสดงเป็นบรรทัดที่แตกต่างกัน ดังนี้

ดูข้อมูลเพิ่มเติมได้ที่สร้างและจัดการรายงานที่กำหนดเอง

API ของ Analytics

ใช้ Edge Management API เพื่อดาวน์โหลดข้อมูลวิเคราะห์ ตัวอย่างเช่น คุณสามารถใช้ 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

คุณใช้ Edge Management API เพื่อส่งออกข้อมูลการวิเคราะห์ทั้งหมดจาก Edge ได้ตลอดวัน ลงในที่เก็บข้อมูลของคุณเอง เช่น Google Cloud Storage หรือ BigQuery จากนั้นคุณจะใช้ประโยชน์จากความสามารถในการค้นหาและแมชชีนเลิร์นนิงที่มีประสิทธิภาพซึ่ง Google Cloud BigQuery และ TensorFlow เพื่อวิเคราะห์ข้อมูลของคุณเอง

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อส่งออกข้อมูลจากข้อมูลวิเคราะห์

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

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

ข้อผิดพลาด: แอปของฉันเห็นข้อผิดพลาด API ใด
ประสิทธิภาพ: API ทํางานช้าอยู่ในตอนนี้ไหม เมธอด API ใดที่มักทำงานช้า หรือช้าในตอนนี้
ความพร้อมให้บริการ: API ใช้งานได้หรือใช้งานไม่ได้ในขณะนี้
โควต้า: API มีโควต้าไหม และในฐานะนักพัฒนาแอป ประสิทธิภาพการทำงาน เมื่อเทียบกับโควต้า

ดูข้อมูลเพิ่มเติมได้จากหัวข้อต่อไปนี้

Drupal 7: การแสดงข้อมูลวิเคราะห์สำหรับการใช้งานแอป
Drupal 8: ตรวจสอบแอป
พอร์ทัลที่ผสานรวม: ไม่พร้อมใช้งาน

นอกจากนี้ คุณยังแชร์ข้อมูลวิเคราะห์กับนักพัฒนาแอปได้โดยทำดังนี้

สร้างรายงานที่กำหนดเองและแชร์กับนักพัฒนาแอป ดูข้อมูลเพิ่มเติมได้ที่สร้างรายงานที่กําหนดเอง
การใช้ Edge Management API เพื่อบันทึกข้อมูลตามระยะเวลาที่กว้างขึ้นเพื่อแชร์กับแอป ออฟไลน์ สำหรับข้อมูลเพิ่มเติม โปรดดู ใช้ 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 ตรวจสอบให้แน่ใจว่าคุณได้เปิดใช้ปลั๊กอิน Analytics แล้ว (ซึ่งเปิดใช้อยู่โดยค่าเริ่มต้น) หากปิดใช้ปลั๊กอินการวิเคราะห์ Edge Microgateway จะไม่ส่งข้อมูลการวิเคราะห์ไปยังข้อมูลวิเคราะห์ Edge

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

เปรียบเทียบการวิเคราะห์ API กับการตรวจสอบ API

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

ความแตกต่างหลักอย่างหนึ่งระหว่างการตรวจสอบ API และข้อมูลวิเคราะห์ API คือกลไกการแจ้งเตือนที่สร้างขึ้น ไปยังการตรวจสอบ API เมื่อใช้การแจ้งเตือน คุณจะระบุรหัสสถานะ HTTP (2xx/4xx/5xx), เวลาในการตอบสนอง หรือเกณฑ์รหัสข้อบกพร่อง ซึ่งเมื่อเกินเกณฑ์แล้ว ระบบจะทริกเกอร์การแจ้งเตือนไปยังทีมปฏิบัติการ การแจ้งเตือนสามารถ ส่งผ่านช่องทางที่หลากหลาย เช่น อีเมล, Slack, เพจเจอร์ หรือเว็บฮุค เพื่อช่วยให้คุณตอบกลับได้ ปัญหาได้ทันที

โปรดดูหัวข้อเปรียบเทียบการตรวจสอบ API กับข้อมูลวิเคราะห์ Edge API เพื่อเปรียบเทียบระหว่างบริการเหล่านี้อย่างละเอียดมากขึ้น