Thiết lập cảnh báo và thông báo

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Điều kiện cảnh báo xác định mã trạng thái cụ thể (ví dụ: 404/502/2xx/4xx/5xx), độ trễ và ngưỡng mã sự cố mà khi vượt quá sẽ kích hoạt cảnh báo bằng hình ảnh trong giao diện người dùng, đồng thời gửi thông báo qua nhiều kênh, chẳng hạn như email, trễ, máy nhắn tin hoặc webhook. Bạn có thể thiết lập cảnh báo ở cấp môi trường, proxy API hoặc dịch vụ mục tiêu hoặc cấp khu vực. Khi cảnh báo được kích hoạt, bạn sẽ nhận được thông báo bằng phương pháp mà bạn đã xác định khi thêm cảnh báo và thông báo.

Ví dụ: bạn có thể muốn kích hoạt cảnh báo và gửi thông báo đến nhóm Vận hành khi tỷ lệ lỗi 5xx vượt quá 23% trong khoảng thời gian 5 phút cho proxy API đơn đặt hàng được triển khai cho môi trường sản xuất của bạn.

Hình sau đây cho thấy cách cảnh báo xuất hiện trong giao diện người dùng:

Sau đây là ví dụ về thông báo qua email mà bạn có thể nhận được khi cảnh báo được kích hoạt.

Trong nội dung thông báo, hãy nhấp vào các đường liên kết sau để biết thêm thông tin:

  • Xem chi tiết để xem thêm chi tiết, bao gồm cả chế độ cài đặt cảnh báo và hoạt động cho từng điều kiện trong 1 giờ qua.
  • Định nghĩa cảnh báo để xem định nghĩa về cảnh báo.
  • Lịch sử cảnh báo để xem thêm thông tin về cảnh báo cụ thể.
  • Xem cẩm nang để biết các hành động được đề xuất (nếu có).
  • Xem báo cáo Analytics API để xem báo cáo tuỳ chỉnh cho điều kiện cảnh báo.

Các phần sau đây mô tả cách thiết lập và quản lý cảnh báo và thông báo.

Giới thiệu về các loại thông báo

Bản phát hành ban đầu của tính năng Giám sát API cho phép bạn tạo các quy tắc dựa trên mẫu, trong đó chỉ định thời điểm gửi cảnh báo dựa trên một nhóm các điều kiện xác định trước. Những loại cảnh báo này được gọi là cảnh báo khắc phục và là loại cảnh báo duy nhất được hỗ trợ trong bản phát hành ban đầu của tính năng Giám sát API.

Ví dụ: bạn có thể đưa ra cảnh báo cố định khi:

  • [tỷ lệ lỗi 5xx] [lớn hơn] [10%] trong [10 phút] từ [target mytarget1]
  • [số lượng lỗi 2xx] [nhỏ hơn] [50] trong [5 phút] ở [khu vực us-east-1]
  • [độ trễ p90] [lớn hơn] [750 mili giây] trong [10 phút] trên [proxy myproxy1]

Bản phát hành beta về Báo cáo bảo mật 19.11.13 thêm các loại cảnh báo mới:

  • Cảnh báo về Tổng lưu lượng truy cập (thử nghiệm). Loại cảnh báo cho phép bạn đưa ra cảnh báo khi lưu lượng truy cập thay đổi theo tỷ lệ phần trăm đã chỉ định trong một phạm vi thời gian.
  • Cảnh báo Điểm bất thường (Phiên bản thử nghiệm beta). Loại cảnh báo trong đó Edge phát hiện các vấn đề về lưu lượng truy cập và hiệu suất thay vì bạn phải tự xác định trước các vấn đề đó. Sau đó, bạn có thể đưa ra cảnh báo về những hoạt động bất thường này.
  • Cảnh báo TLS hết hạn (Beta). Loại cảnh báo cho phép bạn đưa ra thông báo khi chứng chỉ TLS sắp hết hạn.

Vì tính năng Giám sát API hiện hỗ trợ nhiều loại cảnh báo nên hộp thoại Tạo cảnh báo giờ đây sẽ hiển thị tuỳ chọn để chọn loại cảnh báo:

Hộp thoại tạo thông báo hiện có nhiều loại thông báo

Xem chế độ cài đặt thông báo

Để xem các chế độ cài đặt thông báo hiện đã được xác định, hãy nhấp vào Phân tích > Quy tắc thông báo trong Giao diện người dùng Edge.

Trang Cảnh báo sẽ xuất hiện, như minh hoạ trong hình sau:

Email cảnh báo

Như được đánh dấu trong hình, trang Cảnh báo cho phép bạn:

Xem nhật ký thông báo đã được kích hoạt cho tổ chức của bạn

Để xem nhật ký các cảnh báo đã được kích hoạt cho tổ chức của bạn trong 24 giờ qua, hãy nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge rồi nhấp vào thẻ Nhật ký.

Trang Nhật ký thông báo sẽ hiển thị.

Nhật ký thông báo

Nhấp vào tên cảnh báo để xem chi tiết về cảnh báo đó trong Điều tra trang tổng quan. Bạn có thể lọc danh sách bằng cách tìm kiếm toàn bộ hoặc một phần của tên thông báo.

Thêm cảnh báo và thông báo

Cách thêm cảnh báo và thông báo:

  1. Nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge.
  2. Nhấp vào +Cảnh báo.
  3. Nhập thông tin chung sau đây về cảnh báo:
    Trường Nội dung mô tả
    Tên thông báo Tên của cảnh báo. Sử dụng tên mô tả điều kiện kích hoạt và tên đó có ý nghĩa với bạn. Tên không được vượt quá 128 ký tự.
    Loại Cảnh báo Chọn Cố định. Để biết thêm thông tin về các loại thông báo, hãy xem bài viết Giới thiệu về các loại thông báo.
    Nội dung mô tả Nội dung mô tả về cảnh báo.
    Môi trường Chọn môi trường trong danh sách thả xuống.
    Trạng thái Gạt nút để bật hoặc tắt cảnh báo.
  4. Xác định chỉ số, ngưỡng và phương diện cho điều kiện đầu tiên sẽ kích hoạt cảnh báo.
    Trường điều kiện Nội dung mô tả
    Chỉ số

    Chọn một trong các chỉ số sau:

    • Mã trạng thái: Chọn một mã trạng thái trong danh sách, chẳng hạn như HTTP 401, 404, 2xx, 4xx hoặc 5xx.

      Lưu ý:

      • API này cho phép bạn đặt nhiều loại mã trạng thái hơn. Sử dụng API này để chỉ định bất kỳ mã trạng thái nào trong khoảng từ 200-299, 400-599 và các giá trị ký tự đại diện 2xx, 4xx hoặc 5xx. Xem Tạo thông báo.
      • Đối với cảnh báo giới hạn số lượng yêu cầu (mã trạng thái HTTP 429), hãy đặt chỉ số thành Mã lỗi Spike Bắt giữ.
      • Bạn có thể sử dụng AssignMessage chính sách để ghi lại mã phản hồi HTTP, từ lỗi proxy hoặc lỗi mục tiêu. Giám sát API sẽ bỏ qua mọi mã được viết lại và ghi lại các mã phản hồi HTTP thực tế.
    • Độ trễ: Chọn một giá trị độ trễ trong danh sách thả xuống. Cụ thể: p50 (phân vị thứ 50), p90 (phân vị thứ 90), p95 (phân vị thứ 95) hoặc p99 (phân vị thứ 99). Ví dụ: chọn p95 để thiết lập một cảnh báo được kích hoạt khi độ trễ phản hồi cho phân vị thứ 95 lớn hơn ngưỡng bạn đặt bên dưới.
    • Mã lỗi: Chọn một danh mục, danh mục con và mã lỗi trong danh sách. Hoặc chọn một trong các mục sau trong một danh mục hoặc danh mục phụ:

      • Tất cả – Tổng số lỗi được kết hợp trên tất cả các mã lỗi trong danh mục/danh mục phụ này phải đáp ứng các tiêu chí về chỉ số.
      • Bất kỳ – Mã lỗi đơn trong danh mục/danh mục phụ này phải đáp ứng các tiêu chí của chỉ số.

      Hãy xem bài viết Tài liệu tham khảo về mã lỗi để biết thêm thông tin.

    • Tổng lưu lượng truy cập (Beta): Chọn mức tăng hoặc giảm lưu lượng truy cập. Xem Cảnh báo giao thông (Beta) để biết thêm.

    Ngưỡng

    Định cấu hình ngưỡng cho chỉ số đã chọn:

    • Mã trạng thái: Đặt ngưỡng dưới dạng tỷ lệ phần trăm, số lượng hoặc số giao dịch mỗi giây (TPS) theo thời gian.
    • Độ trễ: Chọn ngưỡng làm tổng thời lượng độ trễ hoặc thời lượng độ trễ mục tiêu (mili giây) theo thời gian. Trong trường hợp này, một cảnh báo sẽ được kích hoạt nếu độ trễ quan sát được dưới dạng phân vị được chỉ định, được cập nhật mỗi phút nếu có lưu lượng truy cập, vượt quá điều kiện ngưỡng trong khoảng thời gian bao gồm khoảng thời gian đã chỉ định. Điều này có nghĩa là điều kiện về ngưỡng không được tổng hợp trong toàn bộ khoảng thời gian.
    • Mã lỗi: Đặt ngưỡng dưới dạng tỷ lệ phần trăm, số lượng hoặc số giao dịch trên mỗi giây (TPS) theo thời gian.
    Phương diện Nhấp vào +Thêm phương diện rồi chỉ định thông tin chi tiết về phương diện mà bạn muốn trả về kết quả, bao gồm proxy API, dịch vụ mục tiêu hoặc ứng dụng của nhà phát triển và khu vực.

    Nếu bạn đặt một phương diện cụ thể thành:

    • Tất cả – Tất cả các thực thể trong phương diện đều phải đáp ứng tiêu chí về chỉ số. Bạn không thể chọn Tất cả cho chỉ số thuộc loại Độ trễ.
    • Bất kỳ – Chỉ áp dụng cho khu vực. Mỗi thực thể trong phương diện phải đáp ứng tiêu chí về chỉ số cho bất kỳ khu vực nào.
      Lưu ý: Đối với proxy API hoặc dịch vụ mục tiêu, hãy chọn một Tập hợp để hỗ trợ Mọi chức năng.
    • Bộ sưu tập – Chọn một bộ sưu tập trong danh sách để chỉ định tập hợp proxy API hoặc dịch vụ đích. Trong trường hợp này, bất kỳ thực thể nào trong tập hợp đều phải đáp ứng tiêu chí.

    Nếu đặt phương diện thành Mục tiêu, bạn có thể chọn một dịch vụ mục tiêu hoặc dịch vụ được chỉ định trong Chính sách Chú thích dịch vụ. Mục tiêu của Chính sách Chú thích dịch vụ hiển thị dưới dạng một giá trị có tiền tố "sc://". Ví dụ: "sc://my.endpoint.net".

  5. Nhấp vào Hiển thị dữ liệu về tình trạng để hiển thị dữ liệu gần đây cho tình trạng đó trong 1 giờ qua.
    Tỷ lệ lỗi trong biểu đồ sẽ hiển thị màu đỏ khi vượt quá ngưỡng điều kiện cảnh báo.
    Hiển thị dữ liệu về tình trạng

    Nhấp vào Ẩn dữ liệu điều kiện để ẩn dữ liệu.

  6. Nhấp vào + Thêm điều kiện để thêm các điều kiện bổ sung rồi lặp lại bước 4 và 5.

    Lưu ý: Nếu bạn chỉ định nhiều điều kiện, cảnh báo sẽ được kích hoạt khi tất cả các điều kiện được đáp ứng.

  7. Nhấp vào Tạo báo cáo phân tích API dựa trên điều kiện cảnh báo nếu bạn muốn tạo báo cáo tuỳ chỉnh dựa trên các điều kiện cảnh báo mà bạn đã định cấu hình. Tùy chọn này sẽ có màu xám nếu bạn không phải là quản trị viên tổ chức.

    Để biết thêm thông tin, hãy xem bài viết Tạo báo cáo tuỳ chỉnh từ một cảnh báo.

    Lưu ý: Bạn có thể sửa đổi báo cáo tuỳ chỉnh sau khi lưu cảnh báo, như mô tả trong bài viết Quản lý báo cáo tuỳ chỉnh.

  8. Nhấp vào + Thông báo để thêm thông báo.
    Thông tin chi tiết về thông báo Nội dung mô tả
    Kênh Chọn kênh thông báo bạn muốn sử dụng và chỉ định đích đến: Email, Slack, PagerDuty hoặc Webhook.
    Đích đến Chỉ định đích đến dựa trên loại kênh đã chọn:
    • Email – Địa chỉ email, chẳng hạn như joe@company.com
    • Slack – URL của kênh Slack, chẳng hạn như https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – mã PagerDuty, chẳng hạn như abcd1234efgh56789
    • Webhook – URL webhook, chẳng hạn như https://apigee.com/test-webhook. Hãy xem phần Định dạng đối tượng webhook để biết nội dung mô tả về đối tượng được gửi đến URL.

      Chuyển bất kỳ thông tin xác thực nào vào URL của webhook. Ví dụ: https://apigee.com/test-webhook?auth_token=1234_abcd.

      Bạn có thể chỉ định URL đến một điểm cuối có thể phân tích cú pháp đối tượng webhook để sửa đổi hoặc xử lý đối tượng đó. Ví dụ: bạn có thể chỉ định URL tới một API (chẳng hạn như API Edge) hoặc tới bất kỳ điểm cuối nào khác có thể xử lý đối tượng.

      Lưu ý: Bạn chỉ có thể chỉ định một đích đến cho mỗi thông báo. Để chỉ định nhiều đích đến cho cùng một loại kênh, hãy thêm thông báo bổ sung.

  9. Để thêm các thông báo khác, hãy lặp lại bước 8.
  10. Nếu bạn đã thêm một thông báo, hãy thiết lập các trường sau:
    Trường Nội dung mô tả
    Cẩm nang (Không bắt buộc) Trường văn bản dạng tự do cung cấp nội dung mô tả ngắn về các hành động được đề xuất để giải quyết các cảnh báo khi chúng kích hoạt. Bạn cũng có thể chỉ định một liên kết tới trang wiki nội bộ hoặc trang cộng đồng của bạn nơi bạn tham khảo các phương pháp hay nhất. Thông tin trong trường này sẽ được đưa vào thông báo. Nội dung trong trường này không được vượt quá 1500 ký tự.
    Van tiết lưu Tần suất gửi thông báo. Chọn một giá trị trong danh sách thả xuống. Các giá trị hợp lệ bao gồm: 15 phút, 30 phút và 1 giờ.
  11. Nhấp vào Lưu.

Định dạng đối tượng webhook

Nếu bạn chỉ định một URL webhook làm đích đến của thông báo cảnh báo, thì đối tượng được gửi đến URL có định dạng như sau:
{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

Các thuộc tính thresholdViolationsthresholdViolationsFormatted chứa thông tin chi tiết về cảnh báo. Thuộc tính thresholdViolations chứa một chuỗi đơn kèm theo thông tin chi tiết, trong khi thresholdViolationsFormatted chứa một đối tượng mô tả cảnh báo. Thường thì bạn sử dụng thuộc tính thresholdViolationsFormatted vì thuộc tính này đơn giản hơn để giải mã.

Ví dụ trên cho thấy nội dung của các thuộc tính này cho một cảnh báo cố định khi bạn định cấu hình chỉ số cảnh báo để kích hoạt dựa trên mã trạng thái HTTP 2xx, như được chỉ định bởi thuộc tính statusCode.

Nội dung của các thuộc tính này phụ thuộc vào loại cảnh báo, chẳng hạn như cảnh báo đã khắc phục hoặc hoạt động bất thường, cũng như cấu hình cụ thể của cảnh báo. Ví dụ: nếu bạn tạo một cảnh báo cố định dựa trên mã lỗi, thì thuộc tính thresholdViolationsFormatted sẽ chứa thuộc tính faultCode thay vì thuộc tính statusCode.

Bảng sau đây cho thấy tất cả các thuộc tính có thể có của thuộc tính thresholdViolationsFormatted cho các loại cảnh báo khác nhau:

Loại cảnh báo Nội dung có thể vi phạm theo định dạng
Cố định
metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation
Tổng trafic
metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation
Hoạt động bất thường
metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation
Ngày hết hạn TLS (Bảo mật tầng truyền tải)
envName, certificateName, thresholdValue, violation

Tạo báo cáo tuỳ chỉnh từ cảnh báo

Cách tạo báo cáo tuỳ chỉnh từ một cảnh báo:

  1. Khi tạo cảnh báo, hãy nhấp vào Tạo báo cáo phân tích API dựa trên các điều kiện cảnh báo, như mô tả trong phần Thêm cảnh báo và thông báo.

    Sau khi bạn lưu cảnh báo, giao diện người dùng sẽ hiển thị thông báo sau:

    Alert alertName saved successfully. To customize the report generated, click here.

    Nhấp vào thông báo để mở báo cáo trong một thẻ mới đã điền sẵn các trường có liên quan. Theo mặc định, báo cáo tuỳ chỉnh sẽ có tên là: API Monitoring Generated alertName

  2. Chỉnh sửa báo cáo tuỳ chỉnh như mong muốn và nhấp vào Lưu.
  3. Nhấp vào tên của báo cáo trong danh sách rồi chạy báo cáo tuỳ chỉnh.

Cách quản lý báo cáo tuỳ chỉnh được tạo dựa trên các điều kiện cảnh báo:

  1. Nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge.
  2. Nhấp vào thẻ Cài đặt.
  3. Trong cột Báo cáo, hãy nhấp vào báo cáo tuỳ chỉnh được liên kết với cảnh báo mà bạn muốn quản lý.

    Trang báo cáo tuỳ chỉnh sẽ hiển thị trong một thẻ mới. Nếu cột Báo cáo trống thì tức là báo cáo tuỳ chỉnh chưa được tạo. Bạn có thể chỉnh sửa cảnh báo để thêm báo cáo tuỳ chỉnh, nếu muốn.

  4. Chỉnh sửa báo cáo tuỳ chỉnh như mong muốn và nhấp vào Lưu.
  5. Nhấp vào tên của báo cáo trong danh sách rồi chạy báo cáo tuỳ chỉnh.

Bật hoặc tắt cảnh báo

Để bật hoặc tắt cảnh báo:

  1. Nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge.
  2. Nhấp vào nút bật/tắt trong cột Trạng thái được liên kết với cảnh báo mà bạn muốn bật hoặc tắt.

Chỉnh sửa thông báo

Cách chỉnh sửa thông báo:

  1. Nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge.
  2. Nhấp vào tên của cảnh báo mà bạn muốn chỉnh sửa.
  3. Chỉnh sửa cảnh báo theo yêu cầu.
  4. Nhấp vào Lưu.

Xóa thông báo

Để xoá cảnh báo:

  1. Nhấp vào Analyze > Alert Rules (Phân tích > Quy tắc cảnh báo) trong giao diện người dùng Edge.
  2. Đặt con trỏ lên thông báo mà bạn muốn xoá rồi nhấp vào trong trình đơn thao tác.

Apigee bạn nên thiết lập các cảnh báo sau đây để nhận thông báo về các vấn đề thường gặp. Một số cảnh báo trong số này dành riêng cho việc triển khai các API của bạn và chỉ hữu ích trong một số trường hợp nhất định. Ví dụ: một số cảnh báo hiển thị bên dưới chỉ áp dụng nếu bạn đang sử dụng chính sách Chú thích dịch vụ hoặc chính sách Chú thích Java.

Cảnh báo Ví dụ về giao diện người dùng Ví dụ về API
Mã trạng thái 5xx cho tất cả/mọi API Thiết lập cảnh báo về mã trạng thái 5xx cho một proxy API Thiết lập cảnh báo mã trạng thái 5xx cho một proxy API bằng API
Độ trễ P95 cho proxy API Thiết lập cảnh báo độ trễ P95 cho một proxy API Thiết lập cảnh báo độ trễ P95 cho một proxy API bằng API
Mã trạng thái 404 (Không tìm thấy ứng dụng) cho tất cả proxy API Thiết lập cảnh báo mã trạng thái 404 (Không tìm thấy ứng dụng) cho tất cả proxy API Thiết lập cảnh báo mã trạng thái 404 (Không tìm thấy ứng dụng) cho tất cả proxy API bằng API
Số lượng proxy API cho API Thiết lập cảnh báo về số lượng proxy API cho API Thiết lập cảnh báo về số lượng proxy API cho các API sử dụng API
Tỷ lệ lỗi đối với dịch vụ mục tiêu Thiết lập cảnh báo tỷ lệ lỗi cho các dịch vụ mục tiêu Thiết lập cảnh báo tỷ lệ lỗi cho các dịch vụ mục tiêu bằng API
Tỷ lệ lỗi đối với Chính sách về chú thích dịch vụ (nếu có) Thiết lập cảnh báo tỷ lệ lỗi cho chính sách Chú thích dịch vụ Thiết lập cảnh báo tỷ lệ lỗi cho chính sách Chú thích dịch vụ bằng API
Mã lỗi cụ thể, bao gồm:
  • Lỗi giao thức API (thường là 4xx)
    • Giao diện người dùng: Giao thức API > Tất cả
    • API:
      "faultCodeCategory":"API Protocol",
      "faultCodeSubCategory":"ALL"
  • Lỗi HTTP tổng hợp
    • Giao diện người dùng: Gateway > Other > Gateway HTTPErrorResponseCode
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Others",
      "faultCodeName": "Gateway HTTPErrorResponseCode"
  • Lỗi thực thi chú thích dịch vụ Java (nếu có)
    • Giao diện người dùng: Chính sách thực thi > Chú thích Java > Hành động thực thi chú thích Java không thành công
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Java Callout",
      "faultCodeName": "JavaCallout ExecutionFailed"
  • Lỗi thực thi tập lệnh nút (nếu có)
    • Giao diện người dùng: Chính sách thực thi > Tập lệnh nút >Lỗi thực thi NodeScript
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Node Script",
      "faultCodeName": "NodeScript ExecutionError"
  • Lỗi vi phạm hạn mức
    • Giao diện người dùng: Chính sách quản lý lưu lượng truy cập > Hạn mức > Vi phạm hạn mức
    • API:
      "faultCodeCategory": "Traffic Mgmt Policy",
      "faultCodeSubCategory": "Quota",
      "faultCodeName": "Quota Violation"
  • Lỗi chính sách bảo mật
    • Giao diện người dùng: Chính sách bảo mật > Bất kỳ
    • API:
      "faultCodeCategory": "Security Policy",
      "faultCodeName": "Any"
  • Lỗi cảm nhận (nếu có)
    • Giao diện người dùng: Sense > Sense > Sense RaiseFault
    • API:
      "faultCodeCategory": "Sense",
      "faultCodeSubCategory": "Sense",
      "faultCodeName": "Sense RaiseFault"
  • Lỗi thực thi chú thích dịch vụ (nếu có)
    • Giao diện người dùng: Chính sách thực thi > Chú thích dịch vụ > ServiceTool ExecutionFailed
    • API:
      "faultCodeCategory": "Execution Policy",
      "faultCodeSubCategory": "Service Callout",
      "faultCodeName": "ServiceCallout ExecutionFailed"
  • Lỗi mục tiêu
    • Giao diện người dùng: Gateway > Target > Gateway TimeoutWithTargetOr Trận
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TimeoutWithTargetOrCallout"
  • Lỗi mục tiêu, không có mục tiêu đang hoạt động
    • Giao diện người dùng: Gateway > Target > Gateway TargetServerConfiguredInLoad BalancersIsDown
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Target",
      "faultCodeName": "Gateway TargetServerConfiguredInLoadBalancerIsDown
  • Lỗi mục tiêu, EOF ngoài dự kiến
    • Giao diện người dùng: Gateway > Target > Gateway EstimatedEOFAtTarget
    • API:
      "faultCodeCategory": "Gateway", "faultCodeSubCategory": "Target", "faultCodeName" : "Gateway UnexpectedEOFAtTarget"
  • Lỗi máy chủ ảo
    • Giao diện người dùng: Gateway > Virtual Host > VirtualHost InvalidKeystoreOrTrustStore
    • API:
      "faultCodeCategory": "Gateway",
      "faultCodeSubCategory": "Virtual Host",
      "faultCodeName": "VirtualHost InvalidKeystoreOrTrustStore"
Thiết lập cảnh báo mã lỗi chính sách Thiết lập cảnh báo mã lỗi chính sách bằng API

Thiết lập cảnh báo về mã trạng thái 5xx cho proxy API

Phần sau đây đưa ra ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi số lượt giao dịch mỗi giây (TPS) của mã trạng thái 5xx cho proxy API khách sạn vượt quá 100 giao dịch trong 10 phút đối với bất kỳ khu vực nào. Để biết thêm thông tin, hãy xem phần Thêm cảnh báo và thông báo.

Để biết thông tin về cách sử dụng API, hãy xem phần Thiết lập cảnh báo mã trạng thái 5xx cho một proxy bằng API.

Thiết lập cảnh báo độ trễ P95 cho một proxy API

Sau đây là ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi tổng độ trễ phản hồi cho phân vị thứ 95 lớn hơn 100 mili giây trong 5 phút đối với proxy API khách sạn tại bất kỳ khu vực nào. Để biết thêm thông tin, hãy xem phần Thêm cảnh báo và thông báo.

Để biết thông tin về cách sử dụng API, hãy xem phần Thiết lập cảnh báo độ trễ P95 cho một proxy API bằng API

Thiết lập cảnh báo 404 (Không tìm thấy ứng dụng) cho tất cả các proxy API

Sau đây là ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi tỷ lệ phần trăm mã trạng thái 404 cho tất cả proxy API vượt quá 5% trong 5 phút cho bất kỳ khu vực nào. Để biết thêm thông tin, hãy xem phần Thêm cảnh báo và thông báo.

Để biết thông tin về cách sử dụng API, hãy xem Thiết lập cảnh báo 404 (Không tìm thấy ứng dụng) cho tất cả các proxy API bằng API.

Thiết lập cảnh báo về số lượng proxy API cho các API

Phần sau đây đưa ra ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi số lượng mã 5xx cho API vượt quá 200 trong 5 phút đối với bất kỳ khu vực nào. Trong ví dụ này, các API được ghi lại trong bộ sưu tập Proxy API quan trọng. Để biết thêm thông tin, hãy xem các bài viết sau:

Để biết thông tin về cách sử dụng API, hãy xem bài viết Thiết lập cảnh báo về số lượng proxy API cho các API sử dụng API.

Thiết lập cảnh báo tỷ lệ lỗi cho các dịch vụ mục tiêu

Phần sau đây đưa ra ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi giá 500 mã cho các dịch vụ mục tiêu vượt quá 10% trong 1 giờ đối với bất kỳ khu vực nào. Trong ví dụ này, các dịch vụ mục tiêu được thu thập trong tập hợp Mục tiêu quan trọng. Để biết thêm thông tin, hãy xem các bài viết sau:

Để biết thông tin về cách sử dụng API này, hãy xem nội dung Thiết lập cảnh báo tỷ lệ lỗi cho các dịch vụ mục tiêu bằng API.

Thiết lập cảnh báo về tỷ lệ lỗi cho chính sách Chú thích dịch vụ

Phần sau đây đưa ra ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi tốc độ 500 mã cho dịch vụ được chỉ định theo chính sách ServiceChú thích vượt quá 10% trong 1 giờ cho bất kỳ khu vực nào. Để biết thêm thông tin, hãy xem các bài viết sau:

Để biết thông tin về cách sử dụng API, hãy xem nội dung Thiết lập cảnh báo tỷ lệ lỗi cho chính sách Chú thích dịch vụ bằng API.

Thiết lập cảnh báo mã lỗi chính sách

Phần sau đây đưa ra ví dụ về cách thiết lập cảnh báo bằng giao diện người dùng được kích hoạt khi số lượng mã lỗi JWT AlgorithmMismatch cho chính sáchVerifyJWT lớn hơn 5 trong 10 phút đối với tất cả các API. Để biết thêm thông tin, hãy xem các bài viết sau:

Để biết thông tin về cách sử dụng API này, hãy xem bài viết Thiết lập cảnh báo mã lỗi cho mã lỗi chính sách bằng API.