Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Xem qua một kịch bản mẫu minh hoạ cách khắc phục các vấn đề 5xx với API của bạn.
| # | Bước | Mô tả |
|---|---|---|
| 1 | Theo dõi lưu lượng truy cập API gần đây | Xem dữ liệu giám sát API gần đây cho tất cả các đích đến và proxy API có lưu lượng truy cập trong giờ qua. Tìm hiểu kỹ về các đích đến hoặc proxy API có tỷ lệ lỗi cao. |
| 2 | Xác định xu hướng trong dữ liệu giám sát API | Truy cập vào chế độ xem dữ liệu giám sát API trong quá khứ (tối đa 3 tháng gần nhất) để có được thông tin tổng quan hơn. |
| 3 | Điều tra các vấn đề 5xx | Xem mã lỗi có số lượng tương đối cao nhất theo thời gian để điều tra thêm nguồn gốc của các vấn đề 5xx. (Thông thường, bạn có thể phân loại mã trạng thái 5xx bằng một hoặc nhiều mã lỗi.) |
| 4 | Thiết lập cảnh báo 5xx | Thiết lập một cảnh báo để nhận thông báo khi số lượng mã trạng thái 5xx vượt quá một ngưỡng cụ thể. |
| 5 | Tạo báo cáo tuỳ chỉnh có thông tin chi tiết về khách hàng (Không bắt buộc) | Bạn có thể tạo một báo cáo tuỳ chỉnh để xác định thông tin chi tiết về ứng dụng đang kích hoạt lỗi 5xx. Lưu ý: Bạn phải là quản trị viên tổ chức thì mới có thể tạo báo cáo tuỳ chỉnh. |
| 6 | Nhóm các proxy API thành một tập hợp | Tạo một bộ sưu tập để nhóm các proxy API và thiết lập các giá trị ngưỡng cảnh báo thích hợp cho tất cả thành viên trong nhóm để chẩn đoán vấn đề nhanh hơn.
|
| 7 | Giải quyết các vấn đề 5xx | Dựa trên kết quả điều tra và chẩn đoán, hãy thực hiện các biện pháp thích hợp để giải quyết vấn đề 5xx. |
Bước 1: Theo dõi lưu lượng truy cập API gần đây
Cách xem dữ liệu giám sát API cho các đích đến và proxy API có lưu lượng truy cập trong giờ qua:
- Chọn Phân tích > Giám sát API > Gần đây trong Giao diện người dùng Edge để truy cập vào trang tổng quan Gần đây.
Lưu ý các đích đến và proxy API có tỷ lệ lỗi cao trong giờ qua.
Nhấp vào đích hoặc proxy API có tỷ lệ lỗi cao để xem thông tin chi tiết trong ngăn bên phải. Lưu ý rằng tỷ lệ lỗi 5xx trong ví dụ này là rất cao.
Để biết thêm thông tin về bước này, hãy xem phần Giám sát lưu lượng truy cập API gần đây.
Bước 2: Xác định xu hướng trong dữ liệu giám sát API
Cách truy cập vào chế độ xem dữ liệu giám sát API trong quá khứ cho các đích đến và proxy API có lưu lượng truy cập trong tối đa 3 tháng qua:
- Trong ngăn bên phải của trang tổng quan Gần đây, hãy chọn
> Xem trên Dòng thời gian để truy cập vào trang tổng quan Dòng thời gian.
Ngoài ra, bạn có thể nhấp vào Phân tích > Giám sát API > Dòng thời gian trong giao diện người dùng Edge.
- Xem xu hướng của proxy API hoặc mục tiêu theo thời gian. Xin lưu ý rằng xu hướng này vẫn nhất quán trong 7 ngày qua.
Để biết thêm thông tin về bước này, hãy xem bài viết Xác định xu hướng trong dữ liệu giám sát API.
Bước 3: Điều tra các vấn đề 5xx
Apigee cung cấp một bộ mã lỗi giúp bạn chẩn đoán vấn đề. Thông thường, bạn có thể phân loại mã trạng thái 5xx bằng một hoặc nhiều mã lỗi.
Cách điều tra các vấn đề 5xx:
- Trong ngăn bên phải của trang tổng quan Dòng thời gian, hãy chọn > Xem trong phần Điều tra để truy cập vào trang tổng quan Điều tra.
Ngoài ra, bạn có thể nhấp vào Phân tích > Giám sát API > Điều tra trong giao diện người dùng Edge.
Trang tổng quan Điều tra cho phép bạn so sánh hoạt động tương quan giữa các chỉ số, chẳng hạn như mã lỗi so với thời gian. Xem ma trận mã lỗi theo thời gian để xem hoạt động của mã lỗi trong một giờ qua. Lưu ý các mã lỗi có số lượng tương đối cao nhất dựa trên màu sắc của một khối. Khối càng đậm thì âm lượng tương đối càng cao.
Ví dụ: mã lỗi
policies.ratelimit.SpikeArrestViolationvàpolicies.ratelimit.QuotaViolationcho thấy khối lượng tương đối cao hơn trong ma trận sau:
Nhấp vào khối tối nhất (khối đầu tiên) trong hàng
policies.ratelimit.SpikeArrestViolationđể xem thêm thông tin chi tiết trong ngăn bên phải.
Lưu ý rằng nguồn lỗi là proxy API perfBenchmark_invalid_v1 và mã trạng thái HTTP là 500. Mã trạng thái 500 là mã lỗi thời gian chạy phổ biến cho các lỗi vi phạm chính sách Chặn đột biến.
Xem Phân phối theo ứng dụng của nhà phát triển, ngay bên dưới bảng điều khiển Nguyên nhân bị nghi ngờ, để xác định những ứng dụng của nhà phát triển có tỷ lệ lỗi cao nhất.
Để biết thêm thông tin về bước này, hãy xem phần Xác định vấn đề.
Bước 4: Thiết lập cảnh báo 5xx
Thiết lập một cảnh báo dựa trên bối cảnh đã chọn trong ngăn Điều tra chi tiết để nhận thông báo khi số lượng mã trạng thái 5xx vượt quá một ngưỡng cụ thể.
Trong ngăn bên phải của trang tổng quan Điều tra, hãy chọn
> Tạo cảnh báo.
Điền vào các trường trong hộp thoại cảnh báo. Các trường điều kiện được điền sẵn dữ liệu từ ngữ cảnh hiện tại. Ví dụ:
Nhấp vào Lưu.
Trong tương lai, khi tỷ lệ lỗi 5xx vượt quá 5% trong khoảng thời gian 5 phút đối với proxy API perfBenchmark_invalid_v1, một thông báo sẽ được gửi đến email đã chỉ định và một cảnh báo trực quan sẽ xuất hiện trong giao diện người dùng. Ví dụ:
Để biết thêm thông tin về bước này, hãy xem bài viết Thiết lập cảnh báo và thông báo.
Bước 5: Tạo báo cáo tuỳ chỉnh có thông tin chi tiết về khách hàng (Không bắt buộc)
Nếu muốn, bạn có thể tạo một báo cáo tuỳ chỉnh để xác định thêm thông tin chi tiết về ứng dụng đang kích hoạt lỗi 5xx.
Trên trang Báo cáo, các báo cáo tuỳ chỉnh được tạo dựa trên một cảnh báo sẽ có tên theo định dạng sau: API Monitoring Generated: alert-name.
Truy cập vào báo cáo tuỳ chỉnh được tạo khi thiết lập cảnh báo theo một trong những cách sau:
Chọn Phân tích > Báo cáo tuỳ chỉnh > Báo cáo trong thanh điều hướng bên trái để hiển thị trang Báo cáo. Nhấp vào tên của báo cáo trong danh sách: API Monitoring Generated: 5xx Alert (Đã tạo tính năng giám sát API: Cảnh báo 5xx)
Nhấp vào thông báo xuất hiện khi cảnh báo được tạo. Ví dụ:
Thêm các phương diện sau:
- Ứng dụng dành cho nhà phát triển
- ID khách hàng
- Địa chỉ IP của ứng dụng khách
Để xem báo cáo dựa trên một ứng dụng cụ thể của nhà phát triển có tỷ lệ lỗi cao, hãy thêm một bộ lọc tương tự như sau:
and (developer_app eq 'perfBenchmarkApp0')Lưu ý: Trong trường hợp này, hãy xoá Ứng dụng nhà phát triển khỏi danh sách phương diện.
Nhấp vào Lưu.
Chạy báo cáo để xem thông tin chi tiết về ứng dụng và máy khách của nhà phát triển đang kích hoạt mã trạng thái 5xx.
Để biết thêm thông tin về bước này, hãy xem bài viết Tạo báo cáo tuỳ chỉnh.
Bước 6: Nhóm các proxy API thành một tập hợp
Tạo một bộ sưu tập để nhóm các proxy API và thiết lập các giá trị ngưỡng cảnh báo thích hợp cho tất cả thành viên trong nhóm để chẩn đoán vấn đề nhanh hơn.
- Chọn Analyze > API Monitoring > Collections (Phân tích > Giám sát API > Tập hợp) trong giao diện người dùng Edge để hiển thị trang tổng quan Tập hợp.
- Nhấp vào + Bộ sưu tập.
- Chọn Proxy.
- Chọn prod trong trình đơn thả xuống môi trường.
- Nhấp vào Tiếp theo.
- Điền thông tin vào các trường trong hộp thoại bộ sưu tập.
- Nhấp vào Lưu
Tiếp theo, bạn có thể thiết lập cảnh báo, tương tự như bước 4, đồng thời đặt phương diện thành tập hợp mà bạn đã xác định ở trên.
Để biết thêm thông tin về bước này, hãy xem bài viết Quản lý bộ sưu tập.
Bước 7: Giải quyết các vấn đề 5xx
Hãy thực hiện các biện pháp thích hợp để giải quyết vấn đề 5xx. Ví dụ: dựa trên kết quả chẩn đoán, bạn có thể thực hiện một trong các thao tác sau:
- Sử dụng Apigee Sense để xác định xem sự gia tăng đột biến về số lượng yêu cầu có đáng ngờ hay không và quyết định xem bạn có muốn chặn địa chỉ IP của máy khách được xác định trong báo cáo tuỳ chỉnh hay không.
- Thêm một chính sách hạn mức để giới hạn số lượng kết nối mà các ứng dụng dành cho nhà phát triển có thể thực hiện với proxy API của bạn trong một khoảng thời gian cụ thể.
- Kiếm tiền từ API để tính phí nhà phát triển khi sử dụng quá một số lượng lệnh gọi nhất định.