快訊範例

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

Apigee 可讓您根據多個條件建立複雜的快訊。以下各節列舉快訊範例：

5 分鐘內未收到 200 回應代碼的警示

下一個範例會在 5 分鐘內沒有 200 回應碼 (成功要求) 時建立快訊。

如要建立快訊，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中開啟「建立快訊政策」資訊主頁。

  2. 按一下「選取指標」。
  3. 接著取消選取「Active」按鈕。

    注意：如果貴機構沒有近期的 API 流量資料，除非取消選取這個選項，否則系統不會顯示下一個步驟的指標。

  4. 依下列步驟選取指標：
    1. 複製下列內容並貼到「選取指標」欄位中： 
      apigee.googleapis.com/proxy/response_count
    2. 選取「Apigee Proxy」。
    3. 在右側開啟的面板中，選取「Proxy」。
    4. 在右側的下一個窗格中，選取「Apigee proxy response count」。
    5. 點按「套用」。
  5. 新增回應代碼的篩選器，如下所示：
    1. 按一下「+ 新增篩選器」。
    2. 點選「Filter」欄位，然後從下拉式選單中選取「response_code」response_code。
    3. 在「比較子」中選取「=」。
    4. 在「Value」欄位中，輸入 200。
    5. 點按「套用」。

設定快訊觸發條件

如要設定觸發快訊的事件，請先按一下左側窗格中的「設定觸發條件」。然後執行下列步驟：

  1. 在「Condition type」下方，選取「Metric absence」。
  2. 在「Alert trigger」(快訊觸發條件) 欄位中，選取「Any time series violates」(任何時間序列違反條件時)。
  3. 在「指標缺席時間」欄位中，選取「5 分鐘」。
  4. 您可以選擇在「Condition name」欄位中輸入條件名稱。

在這些設定下，如果 Proxy 在 5 分鐘內未收到 200 回應代碼，就會觸發快訊。

按一下「Next」，開啟「Configure notifications and finalize alert」窗格。

設定快訊通知

在「Configure notifications and finalize alert」窗格中，您可以設定在觸發快訊時傳送的通知。方法如下：

  1. 按一下「Notification Channels」欄位。如果您已為通知建立管道 (例如電子郵件地址或簡訊號碼)，可以選取「Notification Channels」(通知管道) 底下的管道。

    否則，您必須選取「管理通知管道」來新增管道。系統隨即會開啟「通知管道」窗格，您可以在其中新增一或多個管道。詳情請參閱「管理通知管道」。完成後，請返回「設定通知並完成快訊」窗格。

    注意：建立新管道後，您可能需要按一下「管理通知管道」旁的重新整理按鈕，才能顯示新管道。

    選取一或多個通知管道後，按一下「確定」。

  2. 您可以在「Documentation」欄位中新增要與通知一起傳送的訊息。舉例來說，訊息可能會說明警示的原因，並包含說明如何回應警示的說明文件連結。
  3. 點選「下一步」查看快訊詳細資料。如果您滿意這些設定，請按一下「建立政策」建立快訊政策。

流量尖峰快訊

以下各節說明如何建立快訊，在 1 分鐘內的 API 要求數量超過 3600 時觸發。

如要建立快訊，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中開啟「建立快訊政策」資訊主頁。

  2. 按一下「選取指標」。
  3. 接著取消選取「Active」按鈕。

    注意：如果貴機構沒有近期的 API 流量資料，除非取消選取這個選項，否則系統不會顯示下一個步驟的指標。

  4. 依下列步驟選取指標：
    1. 複製下列內容並貼到「選取指標」欄位中： 
      apigee.googleapis.com/proxy/request_count
    2. 選取「Apigee Proxy」。
    3. 在右側開啟的面板中，選取「Proxy」。
    4. 在右側的下一個窗格中，選取「Apigee 代理要求次數」。
    5. 點按「套用」。
  5. 在「轉換資料」窗格中：
    • 在「每個時間序列內」下方：
      • 在「Rolling window」欄位中，選取「1 min」。
      • 在「Rolling window function」(滾動週期函式) 中選取「rate」(比率)。
    • 在「跨時序列」下方的「時序資料匯總」下方，選取「總和」。

設定快訊觸發條件

如要設定觸發快訊的事件，請先按一下左側窗格中的「Configure trigger」(設定觸發條件)。然後執行下列步驟：

  1. 在「Condition type」下方，選取「Threshold」。
  2. 在「Alert trigger」(快訊觸發條件) 欄位中，選取「Any time series violates」(任何時間序列違反條件時)。
  3. 在「Threshold position」(門檻位置) 欄位中，選取「Above threshold」(高於門檻)。
  4. 在「Threshold value」(門檻值) 欄位中輸入 60。

將「門檻值」設為 60 (而非 3600) 的原因是「門檻值」的單位為每秒。因此，如果這個門檻維持 1 分鐘，則在該時間範圍內至少會有 3600 個要求。

設定這些值後，如果 1 分鐘內的請求總數超過 3600 次，系統就會觸發快訊。

按一下「Next」，開啟「Configure notifications and finalize alert」窗格，然後按照「 設定快訊通知」中的步驟操作。

延遲警報

以下範例說明如何建立警示，當回應中平均延遲時間的第 95 個百分位數超過 10 分鐘間隔時，系統就會觸發這則警示。

使用 Apigee 或 Apigee Hybrid 1.12 建立警示

如要使用 Apigee 建立快訊，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中開啟「Create alerting policy」資訊主頁。

  2. 按一下「選取指標」。
  3. 接著取消選取「Active」按鈕。

    注意：如果貴機構沒有近期的 API 流量資料，除非取消選取這個選項，否則系統不會顯示下一個步驟的指標。

  4. 依下列步驟選取指標：
    1. 複製下列內容並貼到「選取指標」欄位中： 
      apigee.googleapis.com/proxy/latencies
    2. 選取「Apigee Proxy」。
    3. 在右側開啟的面板中，選取「Proxy」。
    4. 在右側的下一個窗格中，選取「Apigee 代理伺服器延遲時間」。
    5. 點按「套用」。
  5. 在「轉換資料」窗格中的「每個時間序列內」下方：
    • 在「Rolling window」(滾動週期) 欄位中，選取「10 分鐘」。
    • 在「滾動視窗函式」欄位中輸入「95 百分位數」。

請參閱「建立快訊觸發條件」一文，瞭解如何設定觸發快訊的事件。

使用 Apigee Hybrid 1.10 或 1.11 建立警示

如要使用 Apigee Hybrid 1.10 或 1.11 建立快訊，請按照下列步驟操作：

  1. 在 Google Cloud 控制台中開啟「建立快訊政策」資訊主頁。

  2. 按一下「選取指標」。
  3. 接著取消選取「Active」按鈕。

    注意：如果貴機構沒有近期的 API 流量資料，除非取消選取這個選項，否則系統不會顯示下一個步驟的指標。

  4. 依下列步驟選取指標：
    1. 複製下列內容並貼到「選取指標」欄位中： 
      apigee.googleapis.com/proxyv2/latencies_percentile
    2. 選取「Apigee proxy (v2)」。
    3. 在右側開啟的面板中，選取「Proxyv2」Proxyv2。
    4. 在右側的下一窗格中，選取「Apigee 代理伺服器回應延遲百分位數」。
    5. 點按「套用」。

  5. 新增篩選器，如下所示：

    1. 按一下 [新增篩選器]。
    2. 按一下「Filter」欄位，然後從下拉式選單中選取「percentile」。
    3. 在「比較子」中選取「=」。
    4. 在「Value」欄位中，輸入 95。
    5. 點按「套用」。
  6. 在「轉換資料」窗格中的「每個時間序列內」下方：
    • 在「Rolling window」(滾動週期) 欄位中，選取「10 分鐘」。
    • 在「Rolling window function」(滾動週期函式) 欄位中輸入「mean」。

請參閱「建立快訊觸發條件」一文，瞭解如何設定觸發快訊的事件。

設定快訊觸發條件

如要設定觸發快訊的事件，請先按一下左側窗格中的「Configure trigger」(設定觸發條件)。然後執行下列步驟：

  1. 在「Condition type」下方，選取「Threshold」。
  2. 在「Alert trigger」(快訊觸發條件) 欄位中，選取「Any time series violates」(任何時間序列違反條件時)。
  3. 在「Threshold position」(門檻位置) 欄位中，選取「Above threshold」(高於門檻)。
  4. 在「Threshold value」(門檻值) 欄位中輸入 600。

在這些設定下，如果延遲時間的第 95 個百分位數超過 600 毫秒的門檻，系統就會觸發快訊。

按一下「Next」，開啟「Configure notifications and finalize alert」窗格，然後按照「 設定快訊通知」中的步驟操作。

收到通知後，只要點選通知電子郵件中的「View In Apigee」按鈕，Investigate 資訊主頁就會顯示延遲時間圖表，其中包含門檻值，如下所示： 選取指標。