管理綜合監控

為確保綜合測試與服務的演進方向一致，您可以列出、檢查、編輯、複製及刪除綜合監控器，並更新或刪除其基礎函式。您可以使用 Google Cloud 控制台、Google Cloud CLI 或 Cloud Monitoring API 執行這些管理工作。

如要查看綜合監控的執行結果、指標、記錄和追蹤記錄，請參閱「探索綜合監控結果」。

事前準備

在儲存合成監控項目的 Google Cloud 專案中完成下列步驟。 如要進行 App Hub 設定，請選取 App Hub 主專案或管理專案。

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

  • Monitoring 編輯者 (roles/monitoring.editor)
  • Cloud Functions 開發人員 (roles/cloudfunctions.developer)

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

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

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

• 選取要使用的介面：

  控制台

  使用 Google Cloud 控制台存取 Google Cloud 服務和 API 時，不需要設定驗證。

  gcloud

  在 Google Cloud 控制台中啟用 Cloud Shell。

  啟用 Cloud Shell

  Google Cloud 控制台底部會開啟 Cloud Shell 工作階段，並顯示指令列提示。Cloud Shell 是已安裝 Google Cloud CLI 的殼層環境，並已設定適用於您目前專案的值。工作階段可能要幾秒鐘的時間才能初始化。

  REST

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

  安裝 Google Cloud CLI。

  如果您使用外部識別資訊提供者 (IdP)，請先 使用聯合身分登入 gcloud CLI。

  詳情請參閱 Google Cloud 驗證說明文件中的「使用 REST 進行驗證」。

列出綜合監控

控制台

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

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

   前往「綜合監控」

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

2. 在 Google Cloud 控制台的工具列中，選取 Google Cloud 專案。如要進行 App Hub 設定，請選取 App Hub 主專案或管理專案。

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

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

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

   如果您有多個篩選器，系統會自動以邏輯 AND 聯結篩選器，除非您插入 OR 篩選器。

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

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

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. 使用 APIs Explorer。

   將 parent 設為專案名稱。請務必使用下列格式：

   projects/PROJECT_ID
   

   在上述運算式中，PROJECT_ID 是您的 Google Cloud 專案 ID。 如要進行 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 functions 提供的「Function details」(函式詳細資料)頁面查看 Cloud Run 函式，請選取「Code」(程式碼) 分頁標籤，然後點選函式名稱。「Function 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. 使用 APIs Explorer。

   將 name 設為合成監控項的 ID。 請務必使用下列格式：

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   在前一個運算式中：

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

   舉例來說，「name」欄位的值可能是：

   projects/my-project/uptimeCheckConfigs/10863117100295372627
   

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

編輯綜合監控或 Cloud Run 函式

控制台

注意： 如果只想修改 Cloud Run 函式，可以使用「函式詳細資料」頁面或「綜合監控詳細資料」頁面。在這兩種情況下，您都必須選取編輯選項、進行變更，然後部署修改後的 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

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

• 如要修改警告政策，請使用 Google Cloud 控制台或呼叫 alertPolicies.patch 方法。詳情請參閱「透過 API 管理快訊政策」。

• 如要修改 Cloud Run 函式，請更新函式來源，然後重新部署函式。詳情請參閱「部署 Cloud Run 函式」。

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

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

2. 使用 APIs Explorer。

   1. 將「name」設為合成監控項目的 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 方法，並將編輯過的回應傳遞至該方法。

刪除綜合監控項目

控制台

注意： 使用Google Cloud 控制台刪除運作時間檢查或合成監控時，系統也會一併刪除相關聯的警告政策。不過，刪除綜合監控項目不會刪除 Cloud Run 函式。

如要刪除合成監控器和所有相關聯的警告政策，請按照下列步驟操作：

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

   前往「綜合監控」

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

2. 在 Google Cloud 控制台的工具列中，選取 Google Cloud 專案。如要進行 App Hub 設定，請選取 App Hub 主專案或管理專案。

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

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

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

   您已刪除綜合監控項目。

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

gcloud

注意： 如果快訊政策與正常運作時間檢查或合成監控器相關聯，您就無法使用 Google Cloud CLI 或 Cloud Monitoring API 刪除該正常運作時間檢查或合成監控器。您必須先刪除警告政策，刪除綜合監控項目不會刪除 Cloud Run 函式。

如要刪除正常運作時間檢查或合成監控項，請執行 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

注意： 如果快訊政策與正常運作時間檢查或合成監控器相關聯，您就無法使用 Google Cloud CLI 或 Cloud Monitoring API 刪除該正常運作時間檢查或合成監控器。您必須先刪除警告政策，刪除綜合監控項目不會刪除 Cloud Run 函式。

如要刪除綜合監控，請呼叫 projects.uptimeCheckConfigs.delete 方法：

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

2. 使用 APIs Explorer。

   將 name 設為合成監控項的 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。

後續步驟

• 建立綜合監控項目
• 探索綜合監控結果