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

ภาพรวม API ของ Analytics

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

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

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

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

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

Analytics จะช่วยคุณตอบคําถามทั่วไป เช่น

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ข้อมูล Analytics ของฉันจะใช้ได้เมื่อใดและนานเท่าไร

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

ช่วงความล่าช้าของข้อมูล - หลังจากเรียกพร็อกซี API แล้ว ระบบอาจใช้เวลาถึง 10 นาทีเพื่อเข้าถึงข้อมูลเพื่อแสดงหรือผ่านการเรียก Management 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 Analytics กับ API Monitoring

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

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

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