Trang này được dịch bởi Cloud Translation API.

Tổng quan về API Analytics

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Chủ đề này giới thiệu về công cụ Analytics API Edge.

Video: Xem video ngắn để biết thông tin tổng quan về các dịch vụ Analytics của Edge API.

Cải thiện API thông qua Analytics

Edge API Analytics thu thập và tính toán rất nhiều thông tin được lưu chuyển qua proxy API. Bạn có thể trực quan hoá dữ liệu này bằng đồ thị và biểu đồ trong giao diện người dùng Edge hoặc bạn có thể tải dữ liệu thô về bản phân tích ngoại tuyến bằng API quản lý Edge.

Analytics giúp bạn trả lời các câu hỏi thường gặp, chẳng hạn như:

Lưu lượng truy cập API của tôi có xu hướng như thế nào theo thời gian?
Phương thức API nào phổ biến nhất?
Những nhà phát triển hàng đầu của tôi là ai?
Thời gian phản hồi của API nhanh nhất khi nào? Chậm nhất?
Về mặt địa lý, tôi thấy lưu lượng truy cập API nhiều nhất ở đâu?

Câu trả lời cho các câu hỏi như thế này sẽ giúp bạn cải thiện API, khắc phục sự cố và cải thiện liên quan đến chương trình API của bạn.

API Analytics giúp mọi người cải thiện

Thông qua một quy trình liên tục thu thập, phân tích và trực quan hoá dữ liệu, Edge API Analytics sẽ giúp nhóm API của bạn cải thiện API và giúp nhà phát triển ứng dụng cải thiện ứng dụng của họ:

Nhóm API – Nhóm API đang khai thác các hệ thống nội bộ để tạo ra các API thú vị. Nhóm API muốn biết hiệu quả hoạt động tổng thể của chương trình API, hiệu quả hoạt động của từng API, và cách cải thiện các API.
Nhà phát triển ứng dụng - Bằng cách chia sẻ thông tin phân tích với nhà phát triển ứng dụng, bạn sẽ nhận được những ứng dụng tốt hơn. Những nhà phát triển này đang đổi mới thông qua API của bạn và xây dựng các ứng dụng sáng tạo giúp thúc đẩy doanh thu cho doanh nghiệp của mình. Analytics giúp nhà phát triển ứng dụng biết ứng dụng của họ đang hoạt động như thế nào và hiệu quả hoạt động đóng góp vào lợi nhuận sau thuế của doanh nghiệp. Nhà phát triển ứng dụng muốn biết cách họ có thể cải thiện ứng dụng của mình.
Nhóm vận hành - Nhóm vận hành muốn hiểu các mẫu lưu lượng truy cập và dự đoán thời điểm cần thêm tài nguyên phụ trợ hoặc thực hiện những điều chỉnh quan trọng khác.
Chủ doanh nghiệp - Chủ sở hữu doanh nghiệp muốn biết cách Việc đầu tư vào API sẽ mang lại kết quả và nên đầu tư tiền vào API nào trong tương lai.

Loại dữ liệu nào được thu thập và phân tích?

Edge API Analytics thu thập và phân tích nhiều loại dữ liệu được truyền qua các proxy API, chẳng hạn như:

Thời gian phản hồi
Độ trễ của yêu cầu
Kích thước yêu cầu
Lỗi mục tiêu
Tên sản phẩm API
Địa chỉ email của nhà phát triển
Tên ứng dụng
Nhiều quốc gia khác

Để xem danh sách đầy đủ dữ liệu do API Analytics thu thập, hãy xem Tài liệu tham khảo về chỉ số, phương diện và bộ lọc trong Analytics.

Làm cách nào để thu thập dữ liệu phân tích tuỳ chỉnh?

Edge thu thập nhiều dữ liệu ngay từ đầu. Bạn cũng có thể muốn thu thập dữ liệu phân tích tuỳ chỉnh dành riêng cho proxy API, ứng dụng, sản phẩm hoặc nhà phát triển của mình. Ví dụ: bạn nên thu thập dữ liệu phân tích từ tham số truy vấn, tiêu đề yêu cầu, nội dung yêu cầu và phản hồi hoặc các biến mà bạn xác định trong API của mình.

Bạn thu thập dữ liệu phân tích tuỳ chỉnh bằng cách sử dụng chính sách StatisticsCollector. Sau khi trích xuất dữ liệu tuỳ chỉnh, bạn có thể sử dụng giao diện người dùng hoặc API của Analytics để kiểm tra dữ liệu. Xem bài viết Phân tích nội dung thông báo qua API bằng số liệu phân tích tuỳ chỉnh để xem ví dụ đầy đủ minh hoạ cách thu thập dữ liệu phân tích tuỳ chỉnh.

Sự khác biệt giữa dữ liệu Analytics và dữ liệu Theo dõi API

Phần này mô tả một số khác biệt nhỏ giữa dữ liệu do Analytics cạnh so với Giám sát API. Vì Giám sát API và Analytics sử dụng các quy trình dữ liệu, bạn có thể thấy những điểm khác biệt nhỏ giữa báo cáo tuỳ chỉnh do tính năng Giám sát tạo và báo cáo được tạo bởi Số liệu phân tích. Ví dụ: bạn có thể thấy sự khác biệt trong kết quả được báo cáo cho lỗi hết thời gian chờ—cả hai thời gian chờ phụ trợ (Mã trạng thái HTTP 504 theo yêu cầu) và thời gian chờ của ứng dụng khách (Mã trạng thái HTTP 499). Các chỉ số này có thể xuất hiện cùng với mã trạng thái 200 trong báo cáo tuỳ chỉnh của Analytics, nhưng sẽ hiển thị với mã trạng thái 504 hoặc 499 trong báo cáo tuỳ chỉnh Theo dõi.

Dữ liệu phân tích của tôi có sẵn khi nào và trong bao lâu?

Có hai khoảng thời gian kiểm soát thời điểm và khoảng thời gian bạn có thể xem dữ liệu phân tích của mình:

Khoảng thời gian trễ dữ liệu – Sau khi bạn thực hiện lệnh gọi đến proxy API, thời gian có thể mất tới 10 phút để truy cập dữ liệu để hiển thị hoặc thông qua các lệnh gọi API quản lý.
Giữ lại dữ liệu – Khoảng thời gian mà Edge giữ lại dữ liệu phân tích khác nhau tuỳ theo gói. Tuỳ thuộc vào gói của bạn, dữ liệu phân tích có thể có sẵn trong 30, 60, 90 hoặc 365 ngày qua.

Làm cách nào để truy cập vào dữ liệu phân tích của tôi?

Edge API Analytics cung cấp các công cụ trực quan hoá dữ liệu được tích hợp vào giao diện người dùng Edge. Các công cụ này bao gồm trang tổng quan số liệu phân tích định sẵn và báo cáo tuỳ chỉnh trình bày dữ liệu ở dạng biểu đồ và cho phép bạn xem chi tiết để xem dữ liệu được nhóm thành các phương diện khác nhau (chẳng hạn như theo proxy API, địa chỉ IP hoặc mã trạng thái HTTP).

Ngoài ra, bạn có thể tải dữ liệu phân tích xuống bằng cách sử dụng API Quản lý Edge. Sau khi tải xuống, bạn có thể nhập dữ liệu đó vào công cụ trực quan hoá dữ liệu hoặc hệ thống phân tích của riêng mình.

Trang tổng quan Analytics

Giao diện người dùng Edge cung cấp một tập hợp các trang tổng quan được xác định trước mà bạn có thể dùng để xem dữ liệu phân tích. Ví dụ: các hình ảnh sau đây cho thấy trang tổng quan Hiệu suất proxy:

Trang tổng quan này bao gồm các biểu đồ về:

Tổng lưu lượng truy cập – Tổng số yêu cầu API mà Edge nhận được cho một môi trường API trong một tổ chức.
Lưu lượng truy cập thành công – Tổng số yêu cầu dẫn đến một phản hồi thành công. Các phản hồi lỗi sẽ không được tính.
Lỗi lưu lượng truy cập – Tổng số tất cả yêu cầu API không thành công; tức là yêu cầu không đưa ra phản hồi. Số lượng này bao gồm cả lỗi Proxy (phía Apigee) và Lỗi mục tiêu (các dịch vụ phụ trợ).
TPS trung bình – Số yêu cầu API trung bình và số phản hồi nhận được mỗi giây.

Các trang tổng quan được xác định trước khác bao gồm:

Để biết thêm thông tin về các trang tổng quan được xác định trước này, hãy xem Sử dụng trang tổng quan về số liệu phân tích.

Báo cáo tùy chỉnh

Báo cáo tuỳ chỉnh cho phép bạn xem chi tiết các chỉ số API cụ thể và xem chính xác dữ liệu mà bạn muốn. Bạn có thể tạo báo cáo tuỳ chỉnh bằng cách sử dụng bất kỳ dữ liệu phân tích nào được tích hợp sẵn trong Edge hoặc dữ liệu phân tích tuỳ chỉnh được thu thập theo chính sách StatisticsCollector.

Khi tạo một báo cáo tuỳ chỉnh, bạn chọn dữ liệu mình muốn xem (chỉ số), nhóm dữ liệu đó lại cách có ý nghĩa (phương diện) và tuỳ ý giới hạn dữ liệu được trả về dựa trên các đặc điểm cụ thể của dữ liệu (lọc).

Bạn cũng có thể đặt loại biểu đồ xuất hiện trong báo cáo tuỳ chỉnh dưới dạng biểu đồ cột hoặc biểu đồ dạng đường. Các hình ảnh sau đây minh hoạ ví dụ về biểu đồ cho các giao dịch mỗi giây được nhóm theo proxy API:

Cột – Mỗi proxy API được biểu thị bằng một cột khác:
Dòng – Mỗi proxy API được biểu thị bằng một dòng khác:

Để biết thêm thông tin, hãy xem bài viết Tạo và quản lý báo cáo tuỳ chỉnh.

API Analytics

Bạn có thể dùng API Quản lý Edge để tải dữ liệu phân tích xuống. Ví dụ: bạn có thể sử dụng API để tạo công cụ trực quan hoá của riêng bạn mà bạn có thể nhúng vào cổng thông tin hoặc ứng dụng tuỳ chỉnh.

Dưới đây là ví dụ về lệnh gọi API để truy xuất dữ liệu phân tích cho proxy 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

Lệnh gọi này trả về:

Tổng số yêu cầu (số lượng tin nhắn) trên mỗi proxy API
Trong khoảng thời gian 24 giờ
Nhóm theo giờ

Tham số truy vấn timeRange chỉ định khoảng thời gian ở dạng:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Hãy lưu ý %20 trước HH:MM. Tham số timeRange yêu cầu một ký tự dấu cách được mã hoá URL trước HH:MM hoặc một ký tự +, như trong: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Để biết thêm thông tin, hãy xem Dùng các API chỉ số để đo lường hiệu suất của chương trình API.

Xuất dữ liệu phân tích sang Google Cloud

Bạn có thể sử dụng API quản lý Edge để xuất tất cả dữ liệu phân tích cho cả ngày từ Edge vào kho lưu trữ dữ liệu của riêng bạn, chẳng hạn như Google Cloud Storage hoặc BigQuery. Sau đó, bạn có thể tận dụng các tính năng truy vấn và học máy mạnh mẽ mà Google Cloud BigQuery và TensorFlow cung cấp để tự phân tích dữ liệu.

Để biết thêm thông tin, hãy xem bài viết Xuất dữ liệu từ Analytics.

Khi coi nhà phát triển ứng dụng là khách hàng của mình, bạn nên đảm bảo rằng họ có các công cụ và thông tin được cung cấp để họ sử dụng API của bạn một cách hiệu quả nhất.

Nhà phát triển ứng dụng không chỉ quan tâm đến chất lượng của ứng dụng mà còn quan tâm đến API của bạn. Cổng thông tin dành cho nhà phát triển dựa trên Drupal có một trang Hiệu suất ứng dụng không bắt buộc, được thiết kế để giúp nhà phát triển ứng dụng truy cập vào các chỉ số quan trọng cho ứng dụng của họ. Trang này cung cấp cho nhà phát triển thông tin về:

Lỗi: Ứng dụng của tôi gặp lỗi API nào?
Hiệu suất: API hiện có bị chậm không? Những phương thức API nào thường có tốc độ chậm hay đang chạy chậm?
Khả năng sử dụng: Hiện tại, API đang tăng hay giảm?
Hạn mức: API của bạn có hạn mức không? Là nhà phát triển ứng dụng, hiệu quả hoạt động của tôi so với hạn mức không?

Để biết thêm thông tin, hãy xem:

Drupal 7: Hiển thị số liệu phân tích về việc sử dụng ứng dụng
Drupal 8: Theo dõi ứng dụng
Cổng tích hợp: không có

Ngoài ra, bạn có thể chia sẻ số liệu phân tích với nhà phát triển bằng cách:

Tạo báo cáo tuỳ chỉnh và chia sẻ báo cáo đó với nhà phát triển ứng dụng. Để biết thêm thông tin, hãy xem bài viết Tạo báo cáo tuỳ chỉnh.
Sử dụng API quản lý Edge để thu thập dữ liệu trong khoảng thời gian rộng hơn để chia sẻ với ứng dụng ngoại tuyến. Để biết thêm thông tin, hãy xem Sử dụng các API chỉ số để đo lường hiệu suất của chương trình API.

Làm cách nào để tạo dữ liệu phân tích đầy đủ?

Số liệu phân tích đầy đủ có nghĩa là gì? Ví dụ: bạn có thể tạo một proxy API và Edge sẽ thu thập dữ liệu phân tích về proxy đó. Thế còn các chỉ số cho nhà phát triển hoặc ứng dụng đã gọi proxy API? Nếu không biết ai đã thực hiện lệnh gọi API, thì Edge không thể thu thập dữ liệu đó.

Bạn cần thực hiện một vài bước để cho phép Edge xác định nhà phát triển và ứng dụng nào của nhà phát triển gọi proxy API của bạn. Dưới đây là danh sách các bước đó cùng với đường liên kết đến thông tin chi tiết hơn:

Tạo một hoặc nhiều sản phẩm API, đây là một nhóm các proxy API cùng với một gói dịch vụ. Xem bài viết Quản lý sản phẩm API.
Đăng ký nhà phát triển ứng dụng với Edge. Xem Đăng ký dành cho nhà phát triển ứng dụng.
Đăng ký ứng dụng và tạo khoá API cho nhà phát triển. Xem Đăng ký ứng dụng và quản lý khoá API.
Thêm chính sách bảo mật vào proxy API để xác minh khoá API và/hoặc mã thông báo bảo mật. Xem các chủ đề sau:Chính sách về việc xác minh khoá API, Chính sách về OAuthV2 và Chính sách về việc xác minh JWT.
Nếu bạn đang sử dụng Edge Microgateway, hãy đảm bảo rằng bạn đã bật trình bổ trợ phân tích (trình bổ trợ này được bật theo mặc định). Nếu trình bổ trợ phân tích bị tắt, thì Edge Microgateway sẽ không gửi dữ liệu phân tích đến số liệu phân tích của Edge.

Các hướng dẫn sau đây sẽ hướng dẫn bạn thực hiện các bước cần thiết để xem số liệu phân tích cho nhà phát triển và ứng dụng: Bảo mật API bằng cách yêu cầu khoá API và Bảo mật API bằng OAuth.

So sánh Phân tích API với API Giám sát

Bạn có thể tận dụng cả tính năng Giám sát API Edge và API Analytics. Dịch vụ Giám sát API kiểm tra dữ liệu phân tích để cung cấp thông tin chi tiết theo bối cảnh theo thời gian thực về Hiệu suất của API, từ đó giúp bạn nhanh chóng chẩn đoán các vấn đề và thực hiện các biện pháp khắc phục để đảm bảo hoạt động kinh doanh có thể diễn ra liên tục. Chức năng Giám sát API được thiết kế để nhanh chóng tìm ra những điểm rắc rối trong API và phần phụ trợ của bạn. API Analytics được thiết kế để thu thập nhiều dữ liệu phân tích cho một số nhóm khác nhau sử dụng nhưng dữ liệu này thường được dùng để phân tích trong các tình huống không theo thời gian thực.

Một trong những khác biệt chính giữa Giám sát API và API Analytics là cơ chế cảnh báo được tạo vào Giám sát API. Với cảnh báo, bạn chỉ định mã trạng thái HTTP (2xx/4xx/5xx), độ trễ hoặc mã lỗi khi vượt quá ngưỡng này sẽ kích hoạt một thông báo cảnh báo đến Nhóm vận hành của bạn. Thông báo cảnh báo có thể được gửi qua nhiều kênh, chẳng hạn như email, Slack, máy nhắn tin hoặc webhook, cho phép bạn phản hồi các vấn đề ngay lập tức.

Xem bài viết So sánh hoạt động giám sát API với Analytics API của Edge để so sánh chi tiết hơn giữa các dịch vụ này.