ภาพรวม API ของ Analytics

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

หัวข้อนี้จะแนะนํา Analytics สําหรับ Edge API

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

Edge API Analytics จะรวบรวมและคํานวณข้อมูลจํานวนมากที่ส่งผ่านพร็อกซี API คุณสามารถแสดงข้อมูลนี้ด้วยกราฟและแผนภูมิใน UI ของ Edge หรือจะดาวน์โหลดข้อมูลดิบเพื่อการวิเคราะห์แบบออฟไลน์โดยใช้ 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 Analytics จะรวบรวมและวิเคราะห์ข้อมูลหลากหลายประเภทที่ส่งผ่านพร็อกซี API เช่น

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

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

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

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

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

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

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

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

• ช่วงเวลาที่ข้อมูลล่าช้า - หลังจากมีการเรียกใช้พร็อกซี API ระบบอาจใช้เวลาถึง 10 นาทีในการเข้าถึงข้อมูลเพื่อแสดงหรือผ่านการเรียกใช้ Management API
• การเก็บรักษาข้อมูล - ระยะเวลาการเก็บรักษาข้อมูล Analytics ขึ้นอยู่กับแพ็กเกจการสมัครใช้บริการของคุณ ดังนี้
  • มาตรฐาน: 30 วัน
  • Enterprise: 3 เดือน
  • Enterprise Plus: 14 เดือน
  ดูข้อมูลเพิ่มเติมที่ราคา Apigee API Management

ฉันจะเข้าถึงข้อมูลวิเคราะห์ของฉันได้อย่างไร

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

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

แดชบอร์ด Analytics

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

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

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

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

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

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

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

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

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

นอกจากนี้ คุณยังตั้งค่าประเภทแผนภูมิที่แสดงในรายงานที่กําหนดเองเป็นแผนภูมิคอลัมน์หรือแผนภูมิเส้นได้ด้วย รูปภาพต่อไปนี้แสดงตัวอย่างแผนภูมิสําหรับธุรกรรมต่อวินาทีที่จัดกลุ่มตามพร็อกซี 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 มอบให้เพื่อทําการวิเคราะห์ข้อมูลของคุณเอง

ดูข้อมูลเพิ่มเติมได้ที่ส่งออกข้อมูลจาก Analytics

ฉันจะแชร์ข้อมูลกับนักพัฒนาแอปได้อย่างไร

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่

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

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

• การสร้างรายงานที่กําหนดเองและแชร์กับนักพัฒนาแอป ดูข้อมูลเพิ่มเติมได้ที่สร้างรายงานที่กําหนดเอง
• การใช้ Edge Management API เพื่อบันทึกข้อมูลเป็นระยะเวลานานขึ้นเพื่อแชร์กับนักพัฒนาแอปแบบออฟไลน์ ดูข้อมูลเพิ่มเติมได้ที่ ใช้ API ของเมตริกเพื่อวัดประสิทธิภาพโปรแกรม API

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

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

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

1. สร้างผลิตภัณฑ์ API อย่างน้อย 1 รายการ ซึ่งเป็นการรวมพร็อกซี API เข้ากับแพ็กเกจบริการ ดูจัดการผลิตภัณฑ์ API
2. ลงทะเบียนนักพัฒนาแอปด้วย Edge ดู ลงทะเบียนนักพัฒนาแอป
3. ลงทะเบียนแอปและสร้างคีย์ API สําหรับนักพัฒนาแอป ดู ลงทะเบียนแอปและจัดการคีย์ API
4. เพิ่มนโยบายความปลอดภัยลงในพร็อกซี API ที่ยืนยันคีย์ API และ/หรือโทเค็นความปลอดภัย โปรดดูหัวข้อต่อไปนี้ นโยบายการยืนยันคีย์ API, นโยบาย OAuthV2 และนโยบายการยืนยัน JWT
5. หากใช้ Edge Microgateway ให้ตรวจสอบว่าคุณได้เปิดใช้ปลั๊กอิน Analytics (ซึ่งเปิดใช้โดยค่าเริ่มต้น) แล้ว หากปิดใช้ปลั๊กอินข้อมูลวิเคราะห์ Microgateway ของ Edge จะไม่ส่งข้อมูลวิเคราะห์ไปยังการวิเคราะห์ของ Edge

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

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

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

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

ดูการเปรียบเทียบบริการเหล่านี้อย่างละเอียดได้ที่หัวข้อเปรียบเทียบการตรวจสอบ API กับ Analytics สําหรับ Edge API

ข้อมูลเพิ่มเติม

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