Bạn đang xem tài liệu về Apigee Edge.
Hãy xem tài liệu về Apigee X.
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. Từ trang tổng quan Giám sát API, bạn có thể tạo báo cáo tùy chỉnh với bộ lọc và đặt trước chỉ số dựa trên các điều kiện được định cấu hình tại thời điểm tạo. Ngoài ra, một nhóm thứ nguyên và chỉ số mặc định được định cấu hình trong báo cáo cho bạn.
Tạo báo cáo tùy chỉnh dựa trên ngữ cảnh của bạn
Nhanh chóng tạo báo cáo tùy 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, báo cáo tùy chỉnh được tạo bằng cách sử dụng Giám sát API được đặt tên duy nhất (theo mặc định), như được chỉ ra trong bảng; bạn có thể thay đổi tên khi chỉnh sửa báo cáo tùy chỉnh.
| Ngữ cảnh báo cáo tùy chỉnh | Quy ước đặt tên mặc định cho báo cáo tùy chỉnh |
|---|---|
| Trang tổng quan gần đây | API Monitoring Recent Generated |
| Trang tổng quan về dòng thời gian | API Monitoring Timeline Generated |
| Điều tra trang tổng quan | API Monitoring Investigate Generated |
| Điều kiện cảnh báo | API Monitoring Generated: alert-name |
Thứ nguyên và chỉ số mặc định
Theo mặc định, báo cáo tùy chỉnh sẽ bao gồm các thứ nguyên và chỉ số được liệt kê trong bảng sau đây cho tất cả các báo cáo đã tạo 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 tùy chỉnh
Như đã đề cập trong phần trước, một bộ phương diện và chỉ số mặc định của tính năng Giám sát API đã được định cấu hình trước trong báo cáo tuỳ chỉnh. Sau khi tạ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ụ: bạn có thể muốn thu hẹp phạm vi điều tra để chỉ tìm một mã thông báo truy cập, ứng dụng của nhà phát triển, proxy API hoặc mã yêu cầu.
Trong báo cáo tùy chỉnh sau, bạn thêm thứ nguyên Gateway Flow ID được xác định trước, trong đó Gateway Flow ID chứa UUID duy nhất của từng yêu cầu API được thực hiện cho Edge.
Xin lưu ý rằng báo cáo này đã sử dụng tham số Request URI:
Ví dụ sau đây thêm thứ nguyên Client ID vào báo cáo tùy 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 truyề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 tùy 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 thứ nguyê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 tham chiếu, chỉ số và bộ lọc Analytics.
Trong ví dụ tiếp theo, bạn thêm một Bộ lọc vào báo cáo tuỳ chỉnh, trong đó chứa 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 chi tiết đầy đủ về cách chỉnh sửa báo cáo tùy chỉnh, hãy xem Quản lý báo cáo tùy chỉnh.
Ví dụ: Sử dụng báo cáo tùy chỉnh để chẩn đoán vấn đề triển khai
Đính kèm chính sách StatsCollector vào các API API để thu thập dữ liệu phân tích tùy 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 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 được Apigee, tiêu đề yêu cầu, tham số truy vấn hoặc biến tùy chỉnh mà bạn xác định xác định trước.
Ví dụ: yêu cầu tới proxy API bao gồm tiêu đề cho ID sản phẩm, user ID và phiên bản máy chủ mục tiêu. Yêu cầu này có thể ở 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 với proxy API của mình.
Để tạo báo cáo tùy chỉnh cho các tiêu đề này:
Thêm chính sách StatsCollector vào API của bạn để thu thập giá trị của tiêu đề tùy 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 (Phân tích) > API Monitoring > Recent (Gần đây) trong giao diện người dùng Edge để xem vấn đề với API của bạn. Lưu ý rằng bạn đang 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 chế độ điều tra để truy cập vào trang tổng quan Điều tra:
Lọc trang tổng quan Điều tra 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ẽ nhận được lỗi 403 và 501:
Trong giao diện người dùng Edge, hãy chọn Analytics > Báo cáo tùy chỉnh > Báo cáo để tạo báo cáo tùy chỉnh bao gồm giá trị của các chỉ số tùy chỉnh này dưới dạng Thứ nguyên.
Chọn + Báo cáo tùy chỉnh để tạo báo cáo tùy chỉnh có tên myapi_errors.
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 nhiều chỉ số khác nếu muốn.
Chọn Thứ nguyê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 prodid, targetersion và userid vào Thứ nguyên:
Đặt 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 trong 24 giờ trước. Khi báo cáo mở lần đầu, bạn sẽ thấy biểu đồ lỗi HTTP 403 và 501:
Trong Tóm tắt, hãy nhấp vào 403 hoặc 510 để xem sản phẩm nào đang gây ra lỗi. Ví dụ: bạn chọn 403:
Nhấp vào id sản phẩm trong 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 mục tiêu trong Tóm tắt để xem lỗi theo người dùng:
