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

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

Sử dụng cảnh báo giao thông để tăng thông báo khi lưu lượng truy cập của một môi trường, proxy hoặc khu vực thay đổi theo tỷ lệ phần trăm được chỉ định trong một khoảng thời gian.

Bạn đặt phạm vi thời gian thành:

  • 1 giờ
  • 1 ngày
  • 7 ngày
  • 15 ngày (chỉ API)
  • 30 ngày (chỉ API)

Cảnh báo hoạt động bằng cách so sánh lưu lượng truy cập trong phạm vi thời gian hiện tại với lưu lượng truy cập trong phạm vi thời gian trước đó. Ví dụ: bạn chỉ định phạm vi thời gian một giờ. Sau đó, cảnh báo so sánh lưu lượng truy cập trong một giờ gần đây nhất so với lưu lượng truy cập trong giờ trước đó để tính toán phần trăm thay đổi trong lưu lượng truy cập:

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

Giá trị dương có nghĩa là lưu lượng truy cập tăng và giá trị âm có nghĩa là lưu lượng truy cập giảm.

Sau đó, bạn đặt ngưỡng kích hoạt cảnh báo lưu lượng truy cập dưới dạng tỷ lệ phần trăm tăng hoặc giảm trong lưu lượng truy cập API trong khoảng thời gian cụ thể.

Trước khi bạn đặt tỷ lệ phần trăm đó, hãy đảm bảo rằng tỷ lệ này phù hợp với chế độ bình thường của bạn mô hình lưu lượng truy cập. Ví dụ: nếu lưu lượng truy cập API của bạn thường dao động trong ngày với mức tăng đột biến hằng giờ lên đến 100% vào một số thời điểm cao điểm, những mốc tăng đột biến này là bình thường và không nên kích hoạt cảnh báo. Tuy nhiên, nếu thì bạn định cấu hình một cảnh báo để kích hoạt khi lưu lượng truy cập hàng giờ tăng 50%, bạn sẽ nhận được các cảnh báo không cần thiết cho giao thông thông thường của mình.

Để biết thêm thông tin về cảnh báo, hãy xem bài viết Thiết lập cảnh báo và thông báo.

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

Để thêm cảnh báo và thông báo giao thông:
  1. Nhấp vào Analyze (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 Mô tả
    Tên cảnh 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à có ý nghĩa đối với bạn. Tên không được vượt quá 128 ký tự.
    Mô tả Nội dung mô tả về cảnh báo.
    Loại Cảnh báo Chọn Tổng lưu lượng truy cập. Xem Giới thiệu về các loại thông báo để tìm hiểu thêm.
    Môi trường Chọn môi trường từ danh sách thả xuống.
    Trạng thái Nhấp vào nút bật/tắt để bật hoặc tắt cảnh báo.
  4. Xác định ngưỡng và phương diện cho điều kiện sẽ kích hoạt cảnh báo.
    Trường điều kiện Mô tả
    Ngưỡng

    Chỉ định để tăng cảnh báo khi lưu lượng truy cập tăng lên hoặc giảm xuống một tỷ lệ phần trăm cụ thể khi so sánh với một khoảng thời gian trước đó.

    Đặt tỷ lệ phần trăm tăng thêm thành giá trị lớn hơn hoặc bằng 0%. Đặt giảm theo tỷ lệ phần trăm thành giá trị lớn hơn hoặc bằng 0%, và nhỏ hơn hoặc bằng 100%.

    Bạn có thể chọn khoảng thời gian:

    • 1 giờ
    • 1 ngày
    • Sau 1 tuần
    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 sẽ trả về kết quả, bao gồm proxy API và khu vực.

    Đặt phương diện cụ thể thành:

    • Proxy – Đặt thành một proxy cụ thể hoặc thành Tất cả proxy. Proxy không hỗ trợ giá trị của "Any". Thay vào đó bạn có thể thêm thông báo riêng cho mỗi proxy mà bạn quan tâm.
    • Khu vực – Đặt thành một khu vực cụ thể hoặc thành Tất cả khu vực. Region (Khu vực) không hỗ trợ giá trị "Any" (Bất kỳ). Thay vào đó bạn có thể thêm cảnh báo riêng cho từng khu vực mà bạn quan tâm.
  5. Nhấp vào + Thông báo để thêm thông báo cảnh báo.
    Chi tiết thông báo Mô tả
    Kênh Chọn kênh thông báo mà bạn muốn dùng rồi 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 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

      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 các thông báo bổ sung.

  6. Để thêm các thông báo khác, hãy lặp lại bước trước đó.
  7. 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 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 gọn về các hành động được đề xuất cho phân giải 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 wiki nội bộ của mình hoặc 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ẽ trong 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.
  8. Nhấp vào Lưu.

Xem thông báo trong trang tổng quan Sự kiện

Khi phát hiện một điều kiện cảnh báo, Edge sẽ tự động ghi lại điều kiện đó vào Trang tổng quan Sự kiện trong giao diện người dùng Edge. Danh sách sự kiện xuất hiện trên trang tổng quan Sự kiện bao gồm tất cả cảnh báo, cả cảnh báo đã được khắc phục và cảnh báo cấp chứng chỉ.

Cách xem cảnh báo:

  1. Nhấp vào Analyze (Phân tích) > Sự kiện trong giao diện người dùng Edge. Trang tổng quan Sự kiện mới sẽ xuất hiện:

  2. Lọc trang tổng quan Sự kiện theo:

    • Môi trường
    • Khu vực
    • Khoảng thời gian
  3. Chọn một hàng trong Trang tổng quan sự kiện để hiển thị Kho khoá có chứa chứng chỉ sắp hết hạn cho điều tra thêm về cảnh báo. Từ trang Kho khoá, bạn có thể tải một chứng chỉ mới lên và xoá chứng chỉ hết hạn.

Sử dụng API cảnh báo với cảnh báo giao thông

Hầu hết API mà bạn sử dụng để tạo và quản lý cảnh báo giao thông đều giống như các API bạn sử dụng với các loại cảnh báo khác:

Tuy nhiên, một số API có các thuộc tính bổ sung được dùng để hỗ trợ cảnh báo bất thường, bao gồm:

  • Nhận cảnh báo – Liệt kê tất cả cảnh báo, bao gồm cả cảnh báo đã khắc phục và cảnh báo bất thường.
  • Tạo cảnh báo – Tạo cảnh báo cố định hoặc cảnh báo bất thường.
  • Cập nhật cảnh báo – Cập nhật định nghĩa về cảnh báo cố định hoặc bất thường.

Tạo hoặc cập nhật cảnh báo giao thông

Sử dụng cùng API để tạo hoặc cập nhật cảnh báo giao thông như bạn hiện đang làm với các loại cảnh báo khác. Nội dung của lệnh gọi API để tạo hoặc cập nhật cảnh báo giao thông giống như được sử dụng cho các cảnh báo khác, với các thay đổi sau:

  • Thêm các thuộc tính mới sau để chỉ định rằng cảnh báo này là cảnh báo giao thông:

    "alertType": "runtime"
    "alertSubType": "trafficfixed"

    Giá trị mặc định của các thuộc tính này là:

    "alertType": "runtime"
    "alertSubType": "fixed"
  • Trong phần tử dimensions của mảng conditions:
    • Bạn phải đặt giá trị của org, env, proxyregion thuộc tính. Chỉ những thuộc tính đó mới được hỗ trợ. Bạn có thể đặt proxyregion thành ALL.
    • Bạn phải đặt giá trị của thuộc tính traffic thành total.
  • Trong mảng conditions:

    • Thuộc tính metrics phải có giá trị là trafficChange.
    • Bạn phải đặt thuộc tính comparator thành increasedBy hoặc decreasedBy.
    • Tài sản threshold chứa một giá trị dương cho biết mức tăng hoặc giảm theo tỷ lệ phần trăm trong lưu lượng truy cập trong đó giá trị 1.0 tương ứng với 100%. Giá trị cho increasedBy phải lớn hơn hoặc bằng 0 (0%). Đối với decreasedBy, giá trị phải là lớn hơn hoặc bằng 0,0 (0%) và nhỏ hơn hoặc bằng 1,0 (100%).
    • Bạn phải đặt thuộc tính durationSeconds thành một trong các giá trị sau: 3600 (1 giờ), 86400 (1 ngày), 604800 (7 ngày), 1296000 (15 ngày), 2592000 (30 ngày) .
  • Thuộc tính reportEnabled không được hỗ trợ cho cảnh báo giao thông.
Ví dụ sau đây trình bày cách thiết lập một cảnh báo được kích hoạt khi lưu lượng truy cập cho tổ chức và môi trường tăng 50% trong một giờ. Hệ thống sẽ gửi thông báo đến mã PagerDuty đã chỉ định khi cảnh báo được kích hoạt.
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0 của bạn, như mô tả trong Nhận mã truy cập OAuth 2.0. Để biết thông tin về các tuỳ chọn cURL được sử dụng trong ví dụ này, hãy xem phần Sử dụng cURL.

Hãy xem bài viết Xem sự kiện để biết thêm thông tin về cách sử dụng API này.

Nhận cảnh báo giao thông

Theo mặc định, API Nhận cảnh báo trả về thông tin về tất cả các cảnh báo đã xác định. API này hiện sử dụng các tham số truy vấn để giúp bạn lọc kết quả:

  • enabled – Nếu true chỉ định chỉ trả về cảnh báo đã bật. Giá trị mặc định là false.
  • alertType – Chỉ định loại cảnh báo cần trả về. Giá trị được phép là runtime, giá trị mặc định và cert.
  • alertSubType – Chỉ định loại cảnh báo phụ cần trả về. Giá trị mặc định chưa được đặt, nghĩa là sẽ trả về tất cả các loại cảnh báo phụ.

Ví dụ: sử dụng lệnh gọi API sau đây để chỉ trả về các thông báo cho phép đối với tổ chức có tên là myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Cuộc gọi sau đây chỉ trả về cảnh báo giao thông, cả đã bật và đã tắt:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0, như mô tả trong phần Lấy mã truy cập OAuth 2.0. Để biết thông tin về các tuỳ chọn cURL được sử dụng trong ví dụ này, hãy xem phần Sử dụng cURL.