Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
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. Trên trang tổng quan Giám sát API, bạn có thể tạo báo cáo tuỳ chỉnh bằng bộ lọc và chỉ số được thiết lập sẵn dựa trên các điều kiện được thiết lập tại thời điểm tạo. Ngoài ra, một nhóm các phương diện và chỉ số mặc định cũng được định cấu hình trong báo cáo cho bạn.
Tạo báo cáo tuỳ chỉnh dựa trên ngữ cảnh của bạn
Nhanh chóng tạo báo cáo tuỳ chỉnh dựa trên ngữ cảnh của bạn như được tóm tắt trong bảng sau. Trên trang Báo cáo tùy chỉnh, các báo cáo tùy chỉnh tạo bằng tính năng Giám sát API được đặt tên riêng biệt (theo mặc định) như được nêu trong bảng; bạn có thể thay đổi tên này khi chỉnh sửa báo cáo tùy chỉnh.
| Ngữ cảnh báo cáo tuỳ chỉnh | Quy ước đặt tên mặc định cho báo cáo tuỳ chỉnh |
|---|---|
| Trang tổng quan gần đây | API Monitoring Recent Generated |
| Trang tổng quan của dòng thời gian | API Monitoring Timeline Generated |
| Tìm hiểu trang tổng quan | API Monitoring Investigate Generated |
| Điều kiện cảnh báo | API Monitoring Generated: alert-name |
Phương diện và chỉ số mặc định
Theo mặc định, báo cáo tuỳ chỉnh sẽ bao gồm các phương diện và chỉ số được liệt kê trong bảng sau cho tất cả báo cáo được tạo cho chức năng Giám sát API.
| Thành phần | Mặc định |
|---|---|
| Kích thước | URI yêu cầu |
| Chỉ số |
|
Chỉnh sửa báo cáo tuỳ chỉnh
Như đã đề cập trong phần trước, một nhóm phương diện và chỉ số mặc định của chức năng Giám sát API được xác định trước trong báo cáo tuỳ chỉnh. Sau khi tạo báo cáo, bạn có thể chỉnh sửa báo cáo tuỳ chỉnh để thêm hoặc xoá các chỉ số và phương diện (nếu cần). Ví dụ: có thể bạn sẽ muốn thu hẹp điều tra của mình đối với một mã truy cập, ứng dụng của nhà phát triển, proxy API hoặc mã yêu cầu cụ thể.
Trong báo cáo tuỳ chỉnh sau đây, bạn sẽ thêm phương diện Gateway Flow ID được xác định trước, trong đó Gateway Flow ID chứa mã nhận dạng duy nhất (UUID) duy nhất của mỗi yêu cầu API được gửi đến Edge.
Xin lưu ý rằng báo cáo đã sử dụng phương diện Request URI:
Ví dụ sau đây sẽ thêm phương diện Client ID vào báo cáo tuỳ chỉnh.
Phương diện Client ID chứa khoá người dùng (khoá API) của nhà phát triển thực hiện lệnh gọi API, cho dù được chuyển trong yêu cầu dưới dạng khoá API hay được đưa vào mã thông báo OAuth:
Báo cáo tuỳ chỉnh chứa thông tin cho tất cả giá trị Client ID.
Ví dụ tiếp theo sẽ thêm một bộ lọc để bạn có thể tạo báo cáo tuỳ chỉnh cho một Client ID cụ thể:
Để biết thêm thông tin về tất cả các phương diện và chỉ số được xác định trước mà bạn có thể thêm vào báo cáo, hãy xem Tài liệu tham khảo về chỉ số, phương diện và bộ lọc của Analytics.
Trong ví dụ tiếp theo, bạn sẽ thêm Bộ lọc vào báo cáo tuỳ chỉnh để thu thập các chỉ số và phương diện mặc định cho mã lỗi policies.ratelimit.QuotaViolation và mã trạng thái 5xx:
Để biết toàn bộ thông tin chi tiết về cách chỉnh sửa báo cáo tuỳ chỉnh, hãy xem bài viết Quản lý báo cáo tuỳ chỉnh.
Ví dụ: Sử dụng báo cáo tuỳ chỉnh để chẩn đoán các vấn đề về việc triển khai
Đính kèm chính sáchChính sách thu thập vào các proxy API để thu thập dữ liệu phân tích tuỳ chỉnh, chẳng hạn như mã nhận dạng người dùng hoặc mã sản phẩm, giá, hành động Kiến trúc chuyển trạng thái đại diện (REST), phiên bản mục tiêu, URL mục tiêu và độ dài thông báo. Dữ liệu có thể đến từ các biến luồng do Apigee xác định trước, tiêu đề yêu cầu, tham số truy vấn hoặc biến tuỳ chỉnh mà bạn xác định.
Ví dụ: các yêu cầu tới proxy API của bạn bao gồm các tiêu đề cho mã sản phẩm, mã nhận dạng người dùng và phiên bản máy chủ đích. Yêu cầu này có thể có dạng:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Sau đó, bạn có thể sử dụng thông tin trong tiêu đề để giúp chẩn đoán các vấn đề về thời gian chạy bằng proxy API của mình.
Cách tạo báo cáo tuỳ chỉnh cho các tiêu đề này:
Thêm chính sáchXem dữ liệu thu thập vào API của bạn để thu thập giá trị của tiêu đề tuỳ chỉnh:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Triển khai proxy của bạn và cho phép thời gian để truy cập proxy.
Nhấp vào Analyze > API Monitoring > Recent (Phân tích > Giám sát API > Gần đây) trong giao diện người dùng Edge để xem mọi vấn đề với API của bạn. Lưu ý rằng bạn gặp lỗi 4xx và 5xx cho proxy myapi:
Chọn hàng proxy myapi để xem thêm thông tin chi tiết trong ngăn bên phải của Trang tổng quan gần đây.
Trong ngăn bên phải của Trang tổng quan gần đây, hãy chọn
> Xem trong mục Điều tra để truy cập vào trang Điều tra trang tổng quan:
Lọc trang Điều tra trang tổng quan theo proxy myapi rồi xem Mã trạng thái trong biểu đồ trên cùng. Lưu ý rằng bạn sẽ gặp lỗi 403 và 501:
Trong giao diện người dùng Edge, hãy chọn Analytics > Báo cáo tuỳ chỉnh > Báo cáo để tạo báo cáo tuỳ chỉnh bao gồm giá trị của các chỉ số tuỳ chỉnh này dưới dạng Phương diện.
Chọn + Báo cáo tuỳ chỉnh để tạo một báo cáo tuỳ chỉnh có tên là myapi_ lỗi.
Chọn Lỗi proxy cho chỉ số và đặt Hàm tổng hợp thành Tổng. Bạn có thể thêm các chỉ số khác nếu muốn.
Chọn Phương diện Mã trạng thái phản hồi được xác định trước, sau đó thêm ba số liệu thống kê tùy chỉnh là chẳng hạn, targetersion và userid vào Thứ nguyên:
Thiết lập Bộ lọc để chỉ bao gồm dữ liệu cho proxy API myapi
(apiproxy eq 'myapi'):
Lưu báo cáo.
Chạy báo cáo cho 24 giờ trước. Khi báo cáo mở ra lần đầu tiên, bạn sẽ thấy biểu đồ về các lỗi HTTP 403 và 501:
Trong mục Tóm tắt, hãy nhấp vào 403 hoặc 510 để xem sản phẩm nào đang tạo ra lỗi. Ví dụ: bạn chọn 403:
Hãy nhấp vào một mã sản phẩm trong mục Tóm tắt để xem lỗi theo phiên bản mục tiêu (alpha hoặc beta):
Nhấp vào phiên bản đích trong phần Tóm tắt để xem lỗi theo người dùng:
