設定路況快訊

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

使用交通快訊提高 當環境、Proxy 或區域的流量依指定百分比變更時，您會收到通知 評估標準

你可以將時間範圍設為：

  • 1 小時
  • 1 天
  • 7 天
  • 15 天 (僅限 API)
  • 30 天 (僅限 API)

快訊的運作方式是比較目前時間範圍的流量與上一個時間範圍的流量。 舉例來說，您可以指定一小時的時間範圍。快訊會比較最近一小時的流量 對比前一小時的流量，以計算流量變化百分比：

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

正值代表流量增加，負值則代表流量減少。

接著，您可以設定門檻，依 API 流量的增減百分比，設定觸發流量快訊的門檻 預測出瀏覽時間

設定這個百分比前，請確定其與您的正常值一致 也能因應流量模式 舉例來說，如果您的 API 流量通常在一天內出現波動，每小時流量遽增最多達 100% 在特定尖峰時段，這些高峰是正常現象，不應觸發快訊。不過， 接著設定快訊 當每小時流量增加 50% 時觸發快訊 系統將傳送不必要的快訊，提醒您一般流量。

如要進一步瞭解快訊，請參閱「設定快訊和通知」一文。

新增路況快訊和通知

如要新增路況快訊和通知，請按照下列步驟操作：
  1. 按一下「分析」>「快訊規則。
  2. 按一下「+快訊」。
  3. 輸入下列關於快訊的一般資訊：
    欄位 說明
    快訊名稱 快訊的名稱。請使用對您來說有意義的名稱，用來描述觸發條件， 名稱長度不得超過 128 個字元。
    說明 快訊的說明。
    快訊類型 選取「總流量」。詳情請見 詳情請參閱快訊類型簡介。
    環境 從下拉式清單中選取環境。
    狀態 切換可啟用或停用快訊。
  4. 為觸發快訊的條件定義門檻和維度。
    條件欄位 說明
    正常值

    指定在流量增幅 或 與先前的時間間隔相比，「降幅」的特定百分比。

    將增加幅度的百分比設為大於或等於 0% 的值。 將減少依據百分比設為大於或等於 0% 的值。 且小於或等於 100%

    你可以選擇下列時間間隔：

    • 1 小時
    • 1 天
    • 1 週
    尺寸

    按一下「+ 新增維度」，然後指定要傳回結果的維度詳細資料，包括 管理 API Proxy 和區域

    將特定維度設為：

    • Proxy：設為特定 Proxy 或設為 [所有] Proxy。 Proxy 不支援 "Any" 的值。改為 您可以為感興趣的每個 Proxy 新增個別快訊
    • 區域：設為特定區域或「全部」區域。 「Region」不支援值「Any」。改為 您可以為感興趣的區域分別新增快訊
  5. 按一下「+ 通知」，新增快訊通知。
    通知詳細資訊 說明
    頻道 選取要使用的通知管道，並指定目的地：Email、Slack、PagerDuty 或 Webhook。
    目的地 根據所選管道類型指定目的地：
    • 電子郵件 - 電子郵件地址，例如 joe@company.com
    • Slack - Slack 頻道網址，例如 https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - PagerDuty 程式碼，例如 abcd1234efgh56789
    • Webhook - Webhook 網址，例如 https://apigee.com/test-webhook

      注意：每則通知只能指定一個目的地。 如要針對相同管道類型指定多個目的地，請新增其他通知。
  6. 如要新增其他通知，請重複上一個步驟。
  7. 如果您新增了通知，請設定下列欄位：
    欄位 說明
    教戰手冊 (選填) 任意形式的文字欄位，描述建議動作的簡短說明 解決警示您也可以指定內部維基或 並提供最佳做法的社群網頁這個欄位中的資訊 通知的部分這個欄位的內容不得超過 1500 個半形字元。
    節流 傳送通知的頻率。從下拉式清單中選取值。
  8. 按一下「儲存」。

在「事件」資訊主頁查看快訊

Edge 偵測到快訊觸發條件時，會自動記錄該條件 Edge UI 中的「Events」資訊主頁。事件資訊主頁中顯示的事件清單 當中包含所有固定和憑證警示。

如何查看快訊：

  1. 按一下「分析」>「事件。畫面上會顯示新的「活動」資訊主頁：

  2. 「活動」資訊主頁的篩選依據：

    • 環境
    • 區域
    • 時間範圍
  3. 在「事件資訊主頁」中選取資料列，顯示含有即將到期憑證的 KeyStore 以便進一步調查快訊您可以透過 KeyStore 頁面上傳新憑證及刪除 即將到期的憑證

使用 Alert API 搭配流量快訊

您用來建立及管理流量快訊的 API 多半與您使用的 API 相同 其他快訊類型：

不過，部分 API 的額外屬性可用於支援異常快訊，包括：

  • 接收快訊：列出所有快訊，包括已修正和異常狀況快訊。
  • 建立快訊：建立已修正或異常情況的快訊。
  • 更新快訊：更新已修正或異常的快訊定義。

建立或更新路況快訊

使用相同的 API 建立 或更新 和目前其他快訊類型一樣， 建立或更新流量快訊的 API 呼叫主體與 包含下列變更：

  • 新增下列新屬性，指定快訊為流量快訊：

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

    這些屬性的預設值如下：

    "alertType": "runtime"
"alertSubType": "fixed"
  • 在 conditions 陣列的 dimensions 元素中：
    • 您必須設定 org、env、proxy、 和 region 屬性系統僅支援這些屬性。 您可以將 proxy 和 region 設為 ALL。
    • 您必須將 traffic 屬性的值設為 total。

  • 在 conditions 陣列中：

    • metrics 屬性的值必須是 trafficChange。
    • comparator 屬性必須設為 increasedBy 或 decreasedBy。
    • threshold 屬性包含正值，指定流量的增減百分比 其中的 1.0 值對應 100%。將 increasedBy 的值設為 必須大於或等於 0.0 (0%)。對於 decreasedBy，值必須是 大於或等於 0.0 (0%)，且小於或等於 1.0 (100%)。
    • durationSeconds 屬性必須設為下列其中一個值： 3600 (1 小時)、86400 (1 天)、604800 (7 天)、 1296000 (15 天)、2592000 (30 天)。
  • reportEnabled 屬性不支援路況快訊。
，瞭解如何調查及移除這項存取權。 下例說明如何設定在下列流量發生時觸發的快訊： 一個機構和環境在一小時內會增加 50% 快訊觸發時，系統會傳送通知至指定的 PagerDuty 程式碼。 
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
}'

按照下列說明將 $ACCESS_TOKEN 設為 OAuth 2.0 存取權杖 取得 OAuth 2.0 存取權杖。 如要瞭解這個範例中使用的 cURL 選項，請參閱「使用 cURL」一節。

如要進一步瞭解如何使用這個 API，請參閱「查看事件」。

取得路況快訊

根據預設，Get Alerts API 會傳回所有已定義快訊的相關資訊。 這個 API 現在會使用查詢參數來篩選結果：

  • enabled - 如果 true 指定只傳回已啟用的快訊，預設值為 false。
  • alertType：指定要傳回的快訊類型。允許的值為 runtime、預設值和 cert。
  • alertSubType - 指定要傳回的快訊子類型。 如未設定預設值，則會傳回所有快訊子類型。

舉例來說，使用下列 API 呼叫，即可只傳回名為 myorg 的機構啟用快訊：

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

以下呼叫只會傳回已啟用和已停用的路況快訊：

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

按照取得 OAuth 2.0 存取權杖一節的說明，將 $ACCESS_TOKEN 設為 OAuth 2.0 存取權杖。如要瞭解這個範例中使用的 cURL 選項，請參閱「使用 cURL」一節。