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ề Edge API Analytics.

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

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

Edge API Analytics thu thập và tính toán lượng thông tin phong phú thông qua các proxy API. Bạn có thể trực quan hoá dữ liệu này bằng biểu đồ và biểu đồ 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.

Số liệu phân tích giúp bạn trả lời các câu hỏi phổ biến, 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?
  • Những 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?
  • Khi nào API phản hồi nhanh nhất? Chậm nhất?
  • Theo vị trí địa lý, tôi thấy nhiều lưu lượng truy cập API nhất ở đâu?

Câu trả lời cho những 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à đưa ra các quyết định kinh doanh sáng suốt hơn liên quan đến chương trình API của mình.

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 giúp nhóm API của bạn cải thiện các API và giúp nhà phát triển ứng dụng cải thiện ứng dụng của họ:

alt_text
  • 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 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 ứng dụng tốt hơn. Những nhà phát triển này đang đổi mới với API của bạn và xây dựng các ứng dụng sáng tạo giúp tăng doanh thu cho doanh nghiệp của bạn. Số liệu phân tích 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 của họ cho lợi nhuận 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ànhNhó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 các điều chỉnh quan trọng khác.
  • Chủ doanh nghiệpChủ doanh nghiệp muốn biết hiệu quả đầu tư vào API của họ và những nơi họ nên đầu tư tiền API 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 trên 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 ngôn ngữ khác

Để biết 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 của Analytics.

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

Edge tự nhiên 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 tuỳ chỉnh dành riêng cho proxy API, ứng dụng, sản phẩm hoặc nhà phát triển. Ví dụ: bạn nên thu thập dữ liệu phân tích từ các 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 các 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 Bộ thu thập dữ liệu thống kê. Sau khi dữ liệu tuỳ chỉnh được trích xuất, bạn có thể sử dụng giao diện người dùng hoặc API Analytics để kiểm tra dữ liệu. Hãy xem bài viết Phân tích nội dung thông báo API bằng cách sử dụng số liệu phân tích tuỳ chỉnh để biết 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ố khác biệt nhỏ giữa dữ liệu do tính năng Giám sát API biên và dữ liệu do Edge Analytics thu thập. Vì tính năng Giám sát API và Analytics sử dụng các quy trình dữ liệu khác nhau, nên bạn có thể thấy những điểm khác biệt nhỏ giữa các báo cáo tuỳ chỉnh do tính năng Giám sát tạo ra và các báo cáo do Analytics tạo. Ví dụ: bạn có thể thấy sự khác biệt trong các kết quả được báo cáo về lỗi hết thời gian chờ – cả thời gian chờ của phần 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). Những vấn đề này có thể xuất hiện với mã trạng thái 200 trong báo cáo tuỳ chỉnh của Analytics, nhưng sẽ xuất hiện cùng với mã trạng thái 504 hoặc 499 trong mục Theo dõi báo cáo tuỳ chỉnh.

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:

  • Khoảng thời gian trễ dữ liệu – Sau khi thực hiện lệnh gọi đến một proxy API, có thể mất tới 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ý.
  • Giữ lại dữ liệu – Khoảng thời gian mà Edge giữ lại dữ liệu phân tích sẽ khác nhau tuỳ 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?

Edge API Analytics cung cấp các công cụ trực quan hoá 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 định sẵn và báo cáo tuỳ chỉnh hiển thị 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 nhiều phương diện (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 Edge Management API. Sau khi tải xuống, bạn có thể nhập dữ liệu đó vào các công cụ tạo hình ảnh 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 của Edge cung cấp một tập hợp các trang tổng quan tạo sẵn mà bạn có thể 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 Proxy Performance:

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 tổ chức.
  • Lưu lượng truy cập thành công – Tổng số yêu cầu dẫn đến phản hồi thành công. Phản hồi lỗi 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; nghĩa là yêu cầu không gửi phản hồi. Số lượng bao gồm cả lỗi Proxy (phía API) và lỗi mục tiêu (dịch vụ phụ trợ).
  • TPS trung bình – Số lượng yêu cầu API trung bình và phản hồi kết quả mỗi giây.

Các trang tổng quan tạo sẵn khác bao gồm:

Để biết thêm thông tin về các trang tổng quan tạo sẵn này, hãy xem bài viết Sử dụng trang tổng quan Analytics.

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 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 dữ liệu phân tích bất kỳ được tích hợp trong Edge hoặc dữ liệu phân tích tuỳ chỉnh mà chính sách Thu thập dữ liệu thống kê thu thập.

Khi tạo báo cáo tuỳ chỉnh, bạn chọn dữ liệu muốn xem (chỉ số), nhóm dữ liệu theo 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 đ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 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ạ biểu đồ ví dụ về số 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:

    Biểu đồ cột tuỳ chỉnh

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

    Biểu đồ dạng đường tuỳ chỉnh

Để 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

Sử dụng Edge Management API để tải dữ liệu phân tích xuống. Ví dụ: bạn có thể sử dụng API để tạo các công cụ tạo hình ảnh của riêng mình mà bạn có thể nhúng trong các cổng thông tin hoặc ứng dụng tuỳ chỉnh.

Dưới đây là ví dụ về một lệnh gọi API để truy xuất dữ liệu phân tích cho các 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ố 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 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 bài viết Sử dụng 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 Edge Management API để xuất tất cả dữ liệu phân tích trong 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 các khả năng truy vấn và học máy mạnh mẽ do Google Cloud BigQuery và TensorFlow cung cấp để thực hiện việc phân tích dữ liệu của riêng mình.

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

Làm cách nào để chia sẻ dữ liệu với nhà phát triển ứng dụng?

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

alt_text

Nhà phát triển ứng dụng không chỉ quan tâm đến chất lượng ứng dụng mà họ còn rất quan tâm đến API của bạn. Cổng thông tin cho nhà phát triển dựa trên Drupal bao gồm một trang Hiệu suất ứng dụng (không bắt buộc) được thiết kế để cung cấp cho nhà phát triển ứng dụng quyền truy cập vào các chỉ số quan trọng về ứ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 đang gặp phải lỗi API nào?
  • Hiệu suất: API hiện có chậm không? Hiện tại, những phương thức API nào thường chậm hoặc chậm?
  • Khả năng sử dụng: API hiện đang hoạt động hay đang ngừng hoạt động?
  • 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 việc nào so với hạn mức?

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

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

Làm cách nào để tạo dữ liệu phân tích hoàn chỉnh?

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 đó. 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 đó.

Cần thực hiện một vài bước để Edge tìm ra nhà phát triển và ứng dụng nào của nhà phát triển đang 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:

  1. Tạo một hoặc nhiều sản phẩm API, nghĩa là một nhóm các proxy API cùng với một gói dịch vụ. Xem Quản lý các sản phẩm API.
  2. Đăng ký nhà phát triển ứng dụng với Edge. Xem phần Đăng ký cho nhà phát triển ứng dụng.
  3. Đăng ký ứng dụng và tạo khoá API cho nhà phát triển của bạn. Xem phần Đăng ký ứng dụng và quản lý khoá API.
  4. Thêm chính sách bảo mật vào proxy API của bạn để xác minh khoá API và/hoặc mã thông báo bảo mật. Xem các chủ đề sau:Xác minh chính sách Khoá API, chính sách OAuthV2Xác minh chính sách JWT.
  5. 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 (được bật theo mặc định). Nếu bạn tắt trình bổ trợ phân tích, Edge Microgateway sẽ không gửi dữ liệu phân tích đến nền tảng phân tích của Edge.

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

So sánh API Analytics với Giám sát API

Bạn có thể tận dụng cả tính năng Giám sát API và Phân tích API. 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 thời gian thực về hiệu suất của API, giúp bạn nhanh chóng chẩn đoán các vấn đề và hỗ trợ các biện pháp khắc phục để duy trì hoạt động kinh doanh liên tục. Giám sát API được thiết kế để nhanh chóng tìm ra các điểm sự cố trong API và phần phụ trợ của bạn. 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 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 tính năng Giám sát API và Phân tích API là cơ chế cảnh báo được tích hợp trong tính năng Giám sát API. Với các cảnh 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 vận hành. 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. Nhờ đó, bạn có thể phản hồi các vấn đề ngay lập tức.

Hãy xem bài viết So sánh tính năng giám sát API 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.

Thông tin khác