管理綜合監控

本文說明如何管理合成監控器。您可以查看綜合監控作業清單，並針對每項綜合監控作業查看及修改設定、查看執行記錄，以及查看每次執行的詳細資料。您可以使用 Google Cloud 控制台或 Cloud Monitoring API 管理綜合監控。

如要瞭解如何探索綜合監控的執行結果、指標和記錄，請參閱「探索綜合監控結果」。

這項功能僅支援 Google Cloud 專案。 如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。

事前準備

在儲存合成監控項目的 Google Cloud 專案中完成下列步驟：

  • 如要取得必要權限，以便使用 Google Cloud 控制台查看及修改合成監控器，請要求管理員授予您專案的下列 IAM 角色：

    如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

    您或許還可透過自訂角色或其他預先定義的角色取得必要權限。

  • 本頁面的 API 操作說明適用於 API Explorer。不過，您也可以發出 curl 指令。API Explorer 提供 curl 語法。

  • Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

      In the Google Cloud console, activate Cloud Shell.

      Activate Cloud Shell

      At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

      REST

      如要在本機開發環境中使用本頁的 REST API 範例，請使用您提供給 gcloud CLI 的憑證。

        After installing the Google Cloud CLI, initialize it by running the following command: 

        gcloud init

        If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      詳情請參閱 Google Cloud 驗證說明文件中的「Authenticate for using REST」。

列出綜合監控

控制台

如要列出 Google Cloud 專案中的合成監控器，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的 「Synthetic monitoring」(綜合監控) 頁面：

    前往「綜合監控」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如為「App Hub」設定，請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。

  3. 選用：如要限制列出的綜合監控器，請新增篩選器。

    每個篩選條件都包含名稱和值。您可以將值設為完全符合或部分符合合成監控器名稱。比對作業不會區分大小寫。舉例來說，如要列出名稱包含 default 的所有合成監控器，請執行下列操作：

    • 按一下「篩選表格」，然後選取「顯示名稱」。
    • 輸入 default，然後按下 Return 鍵。

    如有多個篩選器，系統會自動以邏輯 AND 聯集篩選器合併，除非您插入 OR 篩選器。上一個範例使用 OR 篩選器，因此如果正常運作時間檢查的名稱符合 default 或 Testing check，就會列出該檢查。

「綜合監控」頁面會顯示每個綜合監控項目的下列資訊：

  • 最近一次執行的狀態。
  • 綜合監控詳細資料的連結。
  • 成功率和平均執行時間。
  • 快訊政策數量。
  • 如要編輯、複製或刪除合成監控器，以及建立快訊政策，請使用「更多選項」選單。

gcloud

如要列出運作時間檢查和綜合監控，請執行 gcloud monitoring uptime list-configs 指令：

gcloud monitoring uptime list-configs --project=PROJECT_ID

執行上一個指令前，請先取代下列項目：

  • PROJECT_ID：專案的 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。

傳回的資料包括：

  • 名稱和顯示名稱。
  • 檢查 ID。
  • 受監控資源。
  • 檢查之間的時間間隔。

您可以設定 Google Cloud CLI 指令，篩選及排序結果。

REST

如要列出 Google Cloud 專案中的綜合監控器 (包括運作時間檢查)，請呼叫 projects.uptimeCheckConfigs.list 方法：

  1. 按一下 [projects.uptimeCheckConfigs.list]。

  2. 使用 API Explorer。

    將方法的 parent 設為專案名稱，並確保使用下列格式：

    projects/PROJECT_ID

    在上述運算式中，PROJECT_ID 是您的專案 ID。 Google Cloud 如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。

如果是綜合監控，結果會包含標示為 syntheticMonitor 的欄位。

查看綜合監控詳細資料

控制台

如要查看專案中綜合監控項目的詳細資料，請按照下列步驟操作： Google Cloud

  1. 前往 Google Cloud 控制台的 「Synthetic monitoring」(綜合監控) 頁面：

    前往「綜合監控」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如為「App Hub」設定，請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。

  3. 如要開啟「綜合監控詳細資料」頁面，請找出要查看的綜合監控，然後按一下其名稱。

    如要透過 Cloud Run 函式提供的「函式詳細資料」頁面查看 Cloud Run 函式，請選取「程式碼」分頁標籤，然後點選函式名稱。「Functions details」(函式詳細資料) 頁面隨即會在新的視窗中開啟。這個頁面上的分頁標籤可讓您查看指標和記錄，以及設定資訊。

gcloud

如要列出正常運作時間檢查或綜合監控的詳細資料，請執行 gcloud monitoring uptime describe 指令：

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

執行上一個指令前，請先取代下列項目：

  • PROJECT_ID：專案的 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。
  • CHECK_ID：正常運作時間檢查或合成監控的 ID。 執行 gcloud monitoring uptime list-configs 指令並檢查 name 欄位，即可找出 ID。詳情請參閱「尋找合成監控項目的專屬 ID」。

運作時間檢查傳回的資料包括：

  • 名稱和顯示名稱。
  • 檢查 ID。
  • 受監控資源。
  • 檢查之間的時間間隔。

REST

如要列出 Google Cloud 專案中特定綜合監控項目的詳細資料，請呼叫 projects.uptimeCheckConfigs.get 方法：

  1. 按一下 [projects.uptimeCheckConfigs.get]。

  2. 使用 API Explorer。

    將方法的 parent 設為合成監控項的 ID，並確保使用下列格式：

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    在上述運算式中：

    • PROJECT_ID 是您的 Google Cloud 專案 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。
    • CHECK_ID 是綜合監控項目的 ID。

    舉例來說，父項欄位的值可能是：

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    如要找出 CHECK_ID 的值，可以發出 projects.uptimeCheckConfigs.list 方法。如要減少傳回的結果數量，請加入篩選條件。 例如，新增 displayName="MySyntheticMonitor" 篩選器。

編輯綜合監控項目或 Cloud Run 函式

控制台

如要使用「綜合監控項目詳細資料」頁面編輯綜合監控項目或其 Cloud Run 函式，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的 「Synthetic monitoring」(綜合監控) 頁面：

    前往「綜合監控」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如為「App Hub」設定，請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。
  3. 找出要編輯的合成監控器，按一下「更多選項」，然後選取「編輯」。

  4. 選用步驟：如要編輯 Cloud Run 函式，請按一下「編輯函式」， 進行變更，然後按一下「套用函式」。

    如要修改來源 URI 或定義要測試哪些連結的選項，請編輯 Cloud Run 函式，然後更新 index.js 檔案中的 options 物件。如要瞭解這個物件的欄位和語法，請參閱 broken-links-ok/index.js。

  5. 如要保留修改內容，請按一下「儲存」。否則請按一下「取消」。

gcloud

如要修改運作時間檢查或綜合監控，請執行 gcloud monitoring uptime update 指令：

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

執行上一個指令前，請先取代下列項目：

  • PROJECT_ID：專案的 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。

  • CHECK_ID：運作時間檢查或合成監控項的 ID。您可以執行 gcloud monitoring uptime list-configs 指令並檢查「name」欄位，找出 ID。詳情請參閱找出運作時間檢查的專屬 ID。

  • 定義要修改的欄位。如果是綜合監控，您只能更新下列欄位：

    • 期間
    • 顯示名稱
    • 逾時
    • 使用者標籤

舉例來說，如要將合成監控項目的週期設為 10 分鐘，請執行下列指令：

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

合成監控器不會包含快訊政策和函式，因此無法透過本節所述程序編輯：

如要編輯綜合監控作業，請呼叫 projects.uptimeCheckConfigs.patch 方法：

  1. 按一下 [projects.uptimeCheckConfigs.patch]。

  2. 使用 API Explorer。

    1. 將方法的 parent 設為合成監控項的 ID，ID 格式如下：

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      在上述運算式中：

      • PROJECT_ID 是您的專案 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。
      • CHECK_ID 是綜合監控項目的 ID。

      如要找出 CHECK_ID 的值，可以發出 projects.uptimeCheckConfigs.list 方法。如要減少傳回的結果數量，請加入篩選條件。 例如，新增 displayName="MySyntheticMonitor" 篩選器。

    2. 將方法的查詢參數 updateMask 設為要修改的物件欄位。舉例來說，如要更新 displayName 的值，查詢參數如下：

      updateMask=displayName

複製綜合監控

控制台

如要在專案中複製合成監控器，請按照下列步驟操作： Google Cloud

  1. 前往 Google Cloud 控制台的 「Synthetic monitoring」(綜合監控) 頁面：

    前往「綜合監控」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如為「App Hub」設定，請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。

  3. 找出要編輯的合成監控器，按一下「更多選項」，然後選取「複製」。

    「複製綜合檢查」對話方塊會開啟，並預先填入欄位，包括 Cloud Run 函式的副本。

  4. 按一下「建立函式」，視需要更新函式，然後按一下「套用函式」。

  5. 如要保留修改內容，請按一下「建立」。否則請按一下「取消」。

    點選「建立」後，系統會建立並部署 Cloud Run 函式，然後建立綜合監控項目。

gcloud

Google Cloud CLI 方法無法複製綜合監控項目。

REST

沒有可複製綜合監控項目的 API 方法。不過，您可以按照下列步驟製作副本：

  1. 呼叫 projects.uptimeCheckConfigs.get 方法並儲存回應。詳情請參閱「查看合成監控項目的詳細資料」。
  2. 編輯回覆。
  3. 呼叫 projects.uptimeCheckConfigs.create 方法，並將編輯過的回應傳遞至該方法。

刪除綜合監控項目

控制台

如要刪除合成監控器和任何相關聯的快訊政策，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的 「Synthetic monitoring」(綜合監控) 頁面：

    前往「綜合監控」

    如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

  2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如為「App Hub」設定，請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。

  3. 找出要刪除的合成監控器，然後按一下名稱。

  4. 選用：如要刪除 Cloud Run 函式，請選取「程式碼」分頁標籤，然後按一下函式名稱。「Functions details」(函式詳細資料) 頁面隨即會在新的視窗中開啟。

  5. 在「綜合監控詳細資料」頁面中，按一下 「刪除」，然後完成對話方塊。

    您已刪除綜合監控項目。

  6. 如要刪除 Cloud Run 函式，請前往「函式詳細資料」頁面，按一下 「刪除」，然後完成對話方塊。

gcloud

如要刪除運作時間檢查或合成監控，請執行 gcloud monitoring uptime delete 指令：

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

執行上一個指令前，請先取代下列項目：

  • PROJECT_ID：專案的 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。
  • CHECK_ID：正常運作時間檢查或合成監控的 ID。 執行 gcloud monitoring uptime list-configs 指令並檢查 name 欄位，即可找出 ID。詳情請參閱「尋找合成監控項目的專屬 ID」。

REST

如要刪除綜合監控項目和相關聯的快訊政策，請呼叫 projects.uptimeCheckConfigs.delete 方法：

  1. 按一下 [projects.uptimeCheckConfigs.delete]。

  2. 使用 API Explorer。

    將方法的 parent 設為合成監控項的 ID，並確保使用下列格式：

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    在上述運算式中：

    • PROJECT_ID 是您的專案 ID。如要進行 App Hub 設定，請選取 App Hub 主專案或啟用應用程式的資料夾管理專案。
    • CHECK_ID 是綜合監控項目的 ID。

    如要找出 CHECK_ID 的值，可以發出 projects.uptimeCheckConfigs.list 方法。如要減少傳回的結果數量，請加入篩選條件。 例如，新增 displayName="MySyntheticMonitor" 篩選器。

找出合成監控器的專屬 ID

建立綜合監控項目時，Monitoring 會指派 ID。這個 ID 會嵌入合成監控項目的資源名稱中，格式如下：

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

建立或列出綜合監控作業的 Google Cloud CLI 和 Cloud Monitoring API 方法，都會在回應中加入 CHECK_ID。

後續步驟