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.
Hãy xem tài liệu về Apigee X.

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

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

Cải thiện API thông qua số liệu phân tích

Analytics API Edge thu thập và tính toán lượng thông tin phong phú qua các proxy API. Bạn có thể trực quan hoá dữ liệu này bằng các biểu đồ và đồ thị trong giao diện người dùng Edge hoặc có thể tải dữ liệu thô xuống để 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 API là khi nào nhanh nhất? Chậm nhất?
Theo khu vực đị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ư vậy sẽ giúp bạn cải thiện API, khắc phục sự cố và đưa ra quyết định kinh doanh tốt hơn liên quan đến chương trình API.

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

Thông qua quy trình liên tục thu thập, phân tích và trực quan hóa dữ liệu, Edge API Analytics 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 những API thú vị. Nhóm API muốn biết về hiệu suất tổng thể của chương trình API, cách từng API riêng lẻ hoạt động 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 các nhà phát triển ứng dụng, bạn sẽ có được ứng dụng tốt hơn. Các nhà phát triển này đang cải tiến API của bạn và xây dựng các ứng dụng sáng tạo giúp họ tăng doanh thu cho doanh nghiệp của bạn. Analytics giúp nhà phát triển ứng dụng biết hiệu quả hoạt động của ứng dụng và mức đóng góp vào kết quả kinh doanh của bạn. Nhà phát triển ứng dụng muốn biết cách cải thiện ứng dụng của họ.
Nhóm hoạt động – 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 thêm tài nguyên phụ trợ hoặc điều chỉnh các yếu tố quan trọng khác.
Chủ sở hữu doanh nghiệp – Chủ sở hữu doanh nghiệp muốn xem kết quả đầu tư cho API của họ và cách đầu tư vốn vào API trong tương lai.

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

Analytics API Edge thu thập và phân tích nhiều loại dữ liệu chuyển qua các API API 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 nhà cung cấp khác

Để xem danh sách đầy đủ dữ liệu mà API Analytics thu thập, hãy xem Tài liệu tham khảo về các chỉ số, thứ nguyên và bộ lọc của Analytics.

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

Edge vốn dĩ thu thập rất nhiều dữ liệu. Bạn cũng có thể muốn thu thập dữ liệu phân tích tùy chỉnh cụ thể cho các API, ứng dụng, sản phẩm hoặc nhà phát triển API của mình. Ví dụ: bạn có thể muốn thu thập dữ liệu phân tích từ các tham số truy vấn, tiêu đề của 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 tùy chỉnh bằng cách sử dụng chính sách StatsCollector. 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 Analytics hoặc API để kiểm tra dữ liệu. Xem bài viết Phân tích nội dung thông báo API bằng công cụ phân tích tuỳ chỉnh để xem ví dụ đầy đủ về 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 Giám sát API

Phần này mô tả một số điểm khác biệt nhỏ giữa dữ liệu do Edge Analytics thu thập và tính năng Giám sát API. Vì Theo dõi API và Analytics sử dụng quy trình dữ liệu khác nhau, bạn có thể thấy sự khác biệt nhỏ giữa báo cáo tuỳ chỉnh do Giám sát tạo và báo cáo do Analytics tạo. Ví dụ: bạn có thể thấy sự khác biệt trong kết quả được báo cáo về lỗi hết thời gian chờ — cả 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 máy khách (mã trạng thái HTTP 499). Các báo cáo 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 Analytics, nhưng sẽ hiển thị cùng với mã trạng thái 504 hoặc 499 trong Báo cáo tuỳ chỉnh theo dõi.

Khi nào và dữ liệu phân tích của tôi có sẵn?

Có hai khoảng thời gian kiểm soát thời gian 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 thực hiện lệnh gọi đến proxy API, có thể mất tối đa 10 phút để dữ liệu có thể truy cập được để hiển thị hoặc thông qua lệnh gọi API quản lý.
Lưu giữ dữ liệu – Khoảng thời gian dữ liệu phân tích được Edge thay đổi theo kế hoạch. Tùy 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?

Analytics API Edge cung cấp các công cụ trực quan hóa dữ liệu được tích hợp trong giao diện người dùng Edge. Các công cụ này bao gồm trang tổng quan phân tích được xác định trước và báo cáo tùy chỉnh hiển thị dữ liệu trong biểu đồ và đồ thị, đồng thời cho phép bạn xem chi tiết dữ liệu được nhóm thành các thứ nguyê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ác công cụ trực quan hóa 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ể sử dụng để xem dữ liệu phân tích. Ví dụ: các hình ảnh sau hiển thị trang tổng quan về Hiệu suất proxy:

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

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 không được tính.
Lỗi lưu lượng truy cập – Tổng số yêu cầu API không thành công; nghĩa là yêu cầu không gửi 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ố lượt phản hồi nhận được mỗi giây.

Trang tổng quan được xác định trước bổ sung bao gồm:

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

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

Báo cáo tùy chỉnh cho phép bạn xem chi tiết các chỉ số API cụ thể và xem dữ liệu chính xác mà bạn muốn xem. 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 vào Edge hoặc dữ liệu phân tích tuỳ chỉnh do chính sách StatsCollector thu thập.

Khi tạo báo cáo tùy chỉnh, bạn chọn dữ liệu bạn muốn xem (chỉ số), nhóm dữ liệu theo cách có ý nghĩa (thứ nguyên) và tùy ý giới hạn dữ liệu được trả về dựa trên đặc điểm cụ thể của dữ liệu (lọc).

Bạn cũng có thể đặt loại biểu đồ được hiển thị trong báo cáo tùy chỉnh dưới dạng biểu đồ cột hoặc đường. Các hình ảnh sau đây hiển thị ví dụ về biểu đồ cho 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 nhau:
Dòng - Mỗi proxy API được biểu thị là một dòng khác nhau:

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

API Analytics

Sử 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 mình mà bạn có thể nhúng vào các 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

Cuộc gọi này sẽ trả về:

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

Tham số truy vấn timeRange chỉ định khoảng thời gian trong biểu mẫu:

?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 phải có một ký tự dấu cách được mã hoá trong 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 bài viết Sử 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 sang kho lưu trữ dữ liệu riêng, chẳng hạn như Google Cloud Storage hoặc BigQuery. Sau đó, bạn có thể tận dụng khả năng truy vấn và công nghệ máy học mạnh mẽ mà Google Cloud BigQuery và TensorFlow cung cấp để 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 nghĩ 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ó sẵn các công cụ và thông tin để tận dụng API của bạn hiệu quả nhất.

Các nhà phát triển ứng dụng không chỉ quan tâm đến chất lượng ứng dụng mà còn rất quan tâm đến API của bạn. Cổng nhà phát triển có trụ sở tại Drupal bao gồm 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ó chậm không? Hiện tại, phương thức API nào thường bị chậm hoặc chậm?
Khả năng lập chỉ mục: API hiện đang tăng hay giảm?
Hạn mức: API của bạn có hạn mức không? Và với tư cách là nhà phát triển ứng dụng, tôi sẽ làm gì với hạn ngạch?

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

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

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

Tạo báo cáo tùy chỉnh và chia sẻ báo cáo với các 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 để ghi lại dữ liệu trong một khoảng thời gian dài hơn để chia sẻ với các nhà phát triển ứng dụng khi không có mạng. Để biết thêm thông tin, hãy xem phần 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 hoàn chỉnh?

Toàn bộ số liệu phân tích 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 đó. Nhưng còn các chỉ số cho nhà phát triển hoặc ứng dụng gọi là proxy API thì sao? 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 vài bước để Edge có thể tìm ra nhà phát triển và ứng dụng nào đang gọi proxy API của bạn. Dưới đây là danh sách các bước đó cùng với 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 Quản lý sản phẩm API.
Đăng ký nhà phát triển ứng dụng với Edge. Xem nội dung Đăng ký nhà phát triển ứng dụng.
Đăng ký ứng dụng và tạo khóa API cho các nhà phát triển của bạn. Hãy xem phần Đă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 khóa API và/hoặc mã thông báo bảo mật. Hãy xem các chủ đề sau:Xác minh chính sách khoá API, chính sách OAuthV2 và Xác minh chính sách JWT.
Nếu bạn đang sử dụng Edge Microgateway, hãy nhớ bật trình bổ trợ phân tích (được bật theo mặc định). Nếu bạn tắt trình bổ trợ Analytics, Edge Microgateway sẽ không gửi dữ liệu phân tích đến Analytics.

Các hướng dẫn sau đây sẽ hướng dẫn bạn qua các bước cần thiết cho phép bạn xem số liệu phân tích dành 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 API Analytics với tính năng theo dõi API

Bạn có thể tận dụng cả Giám sát API Edge và API Analytics. Tính năng 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 API, cho phép bạn nhanh chóng chẩn đoán vấn đề và tạo điều kiện hành động khắc phục để duy trì hoạt động kinh doanh. Tính năng theo dõi API được thiết kế để nhanh chóng tìm thấy các điểm gặp sự cố trong API và phần phụ trợ. API Analytics được thiết kế để thu thập nhiều loại dữ liệu phân tích để nhiều nhóm 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 điểm khác biệt chính giữa API theo dõi và API Analytics là cơ chế cảnh báo được tích hợp vào API theo dõi. Với thông báo, bạn chỉ định mã trạng thái HTTP (2xx/4xx/5xx), độ trễ hoặc ngưỡng mã lỗi mà khi vượt quá sẽ kích hoạt thông báo cảnh báo cho Nhóm hoạt động 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 phần So sánh API theo dõi với Edge API Analytics để biết thông tin so sánh chi tiết hơn giữa các dịch vụ này.