本頁面由 Cloud Translation API 翻譯而成。

建立及管理通知管道
透過集合功能整理內容你可以依據偏好儲存及分類內容。

本文件說明如何使用 Google Cloud 主控台設定通知管道。當快訊政策觸發時，Cloud Monitoring 會透過這些管道通知您或值班團隊。建立快訊政策時，您可以從已設定的通知管道清單中選取要通知的對象。舉例來說，您可以設定監控 Compute Engine 執行個體的快訊政策，以便發布 Pub/Sub 主題，並通知值班團隊的 Slack 頻道。

詳情請參閱「通知延遲」和「每個事件的通知」。

本文說明如何使用 Google Cloud 主控台。如果您使用 Cloud Monitoring API，請參閱「使用 API 建立及管理通知管道」一文。

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

事前準備

如要取得使用 Google Cloud 控制台查看及設定通知管道所需的權限，請要求管理員為您授予專案的Monitoring Editor (roles/monitoring.editor) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

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

如要進一步瞭解 Cloud Monitoring 角色，請參閱「使用身分與存取權管理控管存取權」。

決定要建立哪些通知管道

基於下列原因，建議您建立多種通知管道以備不時之需：

Google Cloud 在將通知傳送至該系統後，無法控制許多提交系統。
單一 Google Cloud 服務支援 Cloud Mobile App、PagerDuty、Webhook 和 Slack。如果您使用其中一個通知管道，請使用電子郵件或 Pub/Sub 做為備用管道。
我們不建議您只使用簡訊管道傳送通知。

如果您打算使用自動化工具來讀取、重新導向、轉換或以其他方式處理通知，請使用 Webhook 或 Pub/Sub 管道。我們不建議使用其他管道類型搭配自動化工具，因為通知格式可能會有所變動。

建立通知管道

建立快訊政策時，您可以選取任何已設定的通知管道，並將該管道加入政策。您可以預先設定通知管道，也可以在建立快訊政策的過程中設定通知管道。詳情請參閱「建立隨選頻道」。

如要使用 Google Cloud 控制台建立通知管道，請按照下表中的管道專屬操作說明進行：

電子郵件

如要新增電子郵件通知管道，請按照下列步驟操作：

前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
按一下「編輯通知管道」。
在「Email」部分中，按一下「Add new」。
輸入電子郵件地址和說明。
按一下 [儲存]。

如果您使用群組電子郵件地址做為警告政策的通知管道，請將群組設為接受來自 [email protected] 的郵件。

您可以在建立快訊政策時建立電子郵件管道。詳情請參閱「建立隨選頻道」一文。

行動應用程式

使用 Google Cloud 主控台行動應用程式，即可隨時隨地監控 Google Cloud 主控台資源和監控資訊。 Google Cloud 主控台行動應用程式通知會傳送至特定裝置或特定使用者：

Google Cloud 控制台行動應用程式通知管道的清單。

「裝置」表示通知只會傳送給建立通知管道的特定裝置。如果是裝置層級的通知管道，則「顯示名稱」欄位會包含裝置資訊。
使用者：表示通知會傳送至所有已安裝 Google Cloud 控制台行動應用程式的裝置。

Cloud Monitoring 會在建立管道時決定通知範圍。您無法選取或變更範圍。

如要為特定 Google Cloud 專案設定 Google Cloud 主控台行動應用程式通知管道，請按照下列步驟操作：

從行動裝置的應用程式商店安裝 Google Cloud 主控台行動應用程式。
在 Google Cloud 控制台行動應用程式中選取要查看的專案。

選取專案後，應用程式和所選 Google Cloud 專案之間就會進行資料交換。如果系統偵測到沒有通知管道，就會建立一個。幾分鐘後，這個管道會列在「通知管道」頁面的「行動裝置」部分。

如要將行動裝置新增為快訊政策的通知管道，請在「Notifications」(通知) 區段中選取「Google Cloud console (行動版)」，然後從清單中選擇行動裝置。

PagerDuty

PagerDuty 支援與 Monitoring 的雙向同步處理。因此，下列情況為真：

如果在 Monitoring 中建立事件，系統會在 PagerDuty 中開啟事件。
您無法使用 PagerDuty 關閉 Monitoring 中的事件。
如果您在 PagerDuty 中解決事件，且 Monitoring 中事件仍處於開啟狀態，則系統會在 PagerDuty 中重新開啟事件。

如要設定 PagerDuty 通知，請執行下列操作：

在 PagerDuty 帳戶中，設定新服務的整合功能，或將整合功能新增至現有服務。
1. 建立帳戶或登入現有帳戶。
2. 前往「Services」頁面。
- 如要建立服務，請按照下列步驟操作：
  1. 按一下「+ 新增服務」。
  2. 輸入服務名稱和說明，然後點選「下一步」。
  3. 設定升級政策，然後點選「Next」(下一步)。
  4. 如果 PagerDuty 帳戶支援快訊分組和暫時性快訊，請設定這些項目，然後點選「Next」。
  5. 在整合設定頁面中的「Search for an integration(s)」工具列中，輸入 Events API v1，然後按一下「Create Service」。接著，系統會將您帶回新服務的「Integrations」面板。
- 如要編輯現有服務，請按照下列步驟操作：
  1. 從服務目錄中選取服務。
  2. 在服務頁面中，選取「整合」面板。
  3. 按一下「+ 新增其他整合」，前往整合設定頁面。
  4. 在整合設定頁面的「Search for an integration(s)」工具列中，輸入 Events API v1，然後按一下「Add」。接著，您會回到已編輯服務的「Integrations」面板。
在服務的「Integrations」面板中，找出新整合項目的清單，展開其選單，然後複製整合鍵。
選用步驟：設定 PagerDuty，以便準確對應 Monitoring 中的事件嚴重性值。

在 Cloud Monitoring 中新增 PagerDuty 通知管道：

前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
按一下「編輯通知管道」。
在「PagerDuty」部分中，按一下「新增」。
輸入「顯示名稱」。這個名稱應與您在步驟 1 中設定新整合項目的 PagerDuty 服務名稱相符。
將您在步驟 1 複製的整合金鑰貼到「Service Key」欄位。
按一下 [儲存]。

建立快訊政策時，請在「Notifications」(通知) 區段選取「PagerDuty」，並選擇您的 PagerDuty 設定。

PagerDuty 的 JSON 封包格式如下：

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

如要查看 details 欄位的範例和結構定義，請展開以下各節。

JSON 範例

根據預設，警示後端會嘗試產生採用 1.2 版格式的 JSON 封包。如要進一步瞭解這類格式，請參閱下一節。

以下是這類封包的範例：


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

結構定義結構 (第 1.2 版)

本節將說明酬載結構定義的 1.2 版。視警示政策的設定、事件狀態或受監控的資源而定，部分欄位可能不會出現在所有傳回的封包中，或可能會顯示空白值。部分欄位會將內嵌結構做為值；由於這些結構的內容可能有所不同，因此會透過參照來描述。

在傳回的封包中，欄位可按任意順序出現。在後續說明中，這些元素會歸納為相關群組。

{
  "version": "1.2",
  "incident": {

    事件相關資訊。

    "incident_id"：字串，系統為此事件產生的 ID。
    "scoping_project_id"：字串，指的是代管指標範圍的專案 ID。
    "scoping_project_number"：編號，即範圍設定專案的專案編號。
    "url"：字串， Google Cloud 此事件的控制台網址。
    "started_at"：事件開啟時的數字和時間 (以 Unix Epoch 秒為單位)。
    "ended_at"：事件關閉時的數字和時間 (以 Unix 紀元時間的秒數為單位)。只有在 state 為 closed 時才會填入。
    "state"：字串，事件狀態：open 或 closed。如果為 open，則 ended_at 為空值。
    "summary"：字串，產生事件的文字摘要。
    "apigee_url"：字串，此事件的 Apigee 網址，僅適用於 Apigee 資源類型 Environment 和 Proxy*。
    "observed_value"：字串，觀察到觸發/解除警示的值，如果條件已過期，可能為空白。

    事件開啟時的受監控資源相關資訊。

    "resource": {
      "type"：字串，用於識別要發出警報的受控資源類型，例如 gce_instance；請參閱「受控資源清單」。
      "labels"：物件，與受控資源相關聯的標籤鍵/值組合。
    },
    "resource_type_display_name"：字串，受控資源類型的顯示名稱。
    "resource_id"：字串，受控資源的執行個體 ID，與 resource.labels.instance_id 的值相同。
    "resource_display_name"：字串，監控資源的顯示名稱。
    "resource_name"：字串，系統產生的受控資源名稱，包含其他欄位的值。

    關於時序資料指標類型的資訊。

    "metric": {
      "type"：字串，用於識別要發出警報的指標類型，例如 compute.googleapis.com/instance/cpu/utilization；請參閱指標清單。
      "displayName"：字串，指標類型的顯示名稱。
      "labels"：物件，與指標相關聯的標籤鍵/值組合。
    },
    "metadata": {
      "system_labels"：物件，系統中繼資料標籤的鍵/值組合。
      "user_labels"：物件，使用者中繼資料標籤的鍵/值組合。
    },

    快訊政策和開啟/解決事件的條件相關資訊。
    這些值會從相關的 AlertPolicy 物件繪製。

    "policy_name"：字串，快訊政策的顯示名稱。
    "policy_user_labels"：附加至政策的任何使用者標籤的鍵/值組合物件。
    "documentation"：物件，嵌入的 Documentation 表單結構。
    "condition"：物件，嵌入的 Condition 表單結構。
    "condition_name"：字串，條件的顯示名稱，與 condition.displayName 的值相同。
    "severity"：字串，事件嚴重程度。如果在建立警告政策時未定義這個欄位，Cloud Monitoring 會將警告政策嚴重性設為 no severity。
    "threshold_value"：字串，此條件的閾值，如果條件不是閾值條件，則可能為空白。
  },
}

廢止政策

酬載資料結構會遵循《Google Cloud Platform 服務條款》第 1.4(d) 節所述的 Google Cloud 淘汰政策。請注意，結構定義不會控制產生的欄位值格式，且這些格式可能會在未經通知的情況下變更。舉例來說，incident.summary、incident.documentation.content 和 incident.url 應包含與其欄位相關的資料，但結構定義沒有限制，無法保證這些欄位能正確剖析。您可以整個使用值，並預期該值會遵循淘汰政策，但不要依賴剖析產生的欄位。

設定 PagerDuty 對應嚴重性等級

根據預設，PagerDuty 通知會將所有事件嚴重性層級顯示為「重要」。您可以在 PagerDuty 中設定事件協調規則，讓 PagerDuty 快訊嚴重程度與監控事件嚴重程度相符：

在 PagerDuty 帳戶中，前往「Services」頁面。
選取要接收 Google Cloud通知的 PagerDuty 服務。
按一下「設定」。
前往「事件管理」部分，然後點選「查看調度規則」。
按一下「新規則」。
針對每個要轉換的監控嚴重性值，建立條件規則，將嚴重性值對應至等同的 PagerDuty 值：
1. 在「步驟 1：何時套用這項規則？」下方的選單中，選取「如果事件符合特定條件」。
2. 選取程式碼編輯器。
3. 在「If」部分輸入 event.custom_details.incident.severity matches part 「VALUE」，其中 VALUE 是監控嚴重性值的名稱，然後點選「Next」。
4. 在「步驟 2：應採取哪些動作」下方，選取「警示資料」。
5. 將警示嚴重性設為與您在步驟 C 中輸入的監控值相符的值，然後儲存變更。
選用：如要新增其他規則，請按一下「Else rule」。

簡訊

如要設定簡訊通知，請按照下列步驟操作：

前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
按一下「編輯通知管道」。
在「簡訊」部分中，按一下「新增」。
填妥對話方塊，然後按一下「儲存」。

設定快訊政策時，請選取「簡訊」通知類型，然後從清單中選擇已驗證的電話號碼。

Slack

透過 Monitoring Slack 整合功能，快訊政策可在建立新事件時，將訊息發布至 Slack 頻道。如要設定 Slack 通知，請按照下列步驟操作：

在 Slack 中：前往 Slack 網站建立 Slack 工作區和管道。記下頻道網址。
前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
按一下「編輯通知管道」。
在「Slack」部分，按一下「新增」即可開啟 Slack 登入頁面：
1. 選取 Slack 工作區。
2. 點選「允許」，啟用 Cloud Monitoring 存取 Slack 工作區的權限。這項操作會將您帶回通知管道監控設定頁面。
3. 在「Slack 頻道名稱」欄位中，輸入要用於通知的 Slack 頻道名稱。
4. 在「Cloud Alerting Display Name」欄位中，輸入簡短的說明性陳述。監控會在「通知管道」頁面上顯示這個欄位的值。
5. (選用) 如要測試 Cloud Monitoring 和 Slack 工作區之間的連線，請按一下「Send test notification」。如果連線成功，您會在指定的 Slack 通知管道中看到訊息 This is a test alert notification...。請查看通知管道來確認接收情況。
如果您要用於通知的 Slack 頻道是私人頻道，則必須手動邀請 Monitoring 應用程式加入頻道：
1. 開啟 Slack。
2. 前往您指定的監控通知管道。
3. 在頻道中輸入並傳送下列訊息，邀請 Monitoring 應用程式加入頻道：
```
/invite @Google Cloud Monitoring
```
  請務必在 Monitoring 中建立通知管道時，將 Monitoring 應用程式邀請至您指定的私人管道。邀請 Monitoring 應用程式加入公開頻道是可選步驟。
建立快訊政策時，在「Notifications」(通知) 部分選取「Slack」，並選擇您的 Slack 設定。

Webhook

設定 Webhook 通知管道前，請考量下列事項：

Webhook 僅支援公開端點。公開端點可透過公開網際網路存取，例如 HTTP (port:80) 或 HTTPS (port:443)。通知服務必須能夠建立與端點的連線，並在 HTTPS 的情況下驗證伺服器的安全憑證。如果您需要將通知傳送至非公開的端點，請建立 Pub/Sub 通知管道，並設定 Pub/Sub 主題的訂閱項目。詳情請參閱「為私人端點設定 Webhook 通知時發生錯誤」。
如果 Cloud Run 函式已設定為通知管道的 webhook 端點，請確認叫用函式的使用者具有必要的驗證權限。詳情請參閱「為叫用程序進行驗證」和「啟用函式存取權」。
Webhook 通知管道與 Microsoft Teams 不相容。如要將通知資料從 Monitoring 傳送至 Microsoft Teams，請建立整合層來接收 Monitoring Webhook，然後將其重新導向至 Microsoft Teams。

設定 Webhook 通知管道

如要設定 Webhook 通知，請按照下列步驟操作：

Webhook 處理常式：識別要接收 Monitoring Webhook 資料的公開端點網址。
前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
按一下「編輯通知管道」。
在「Webhook」部分中，按一下「新增」。
完成對話方塊。
按一下「Test Connection」，將測試酬載傳送至 Webhook 端點。您可以前往接收端點，確認是否已送達。
按一下 [儲存]。

建立快訊政策時，請在「Notifications」(通知) 區段選取「Webhook」，並選擇您的 Webhook 設定。Error Reporting 傳送的通知會遵循 1.0 結構定義，而 Monitoring 傳送的通知則會遵循 1.2 結構定義：

JSON 範例

根據預設，警示後端會嘗試產生採用 1.2 版格式的 JSON 封包。如要進一步瞭解這類格式，請參閱下一節。

以下是這類封包的範例：


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

結構定義結構 (第 1.2 版)

在傳回的封包中，欄位可按任意順序出現。在後續說明中，這些元素會歸納為相關群組。

基本驗證

除了 Cloud Monitoring 傳送的 webhook 要求外，基本驗證機制還會使用 HTTP 規格來處理使用者名稱和密碼。Cloud Monitoring 要求您的伺服器傳回 401 回應，並附上適當的 WWW-Authenticate 標頭。如要進一步瞭解基本驗證功能，請參閱下列資源：

權杖驗證

權杖驗證功能需要端點網址中的查詢字串參數，以及伺服器希望在自身和監控服務之間保密的金鑰。以下是含有符記的網址範例：

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

如果監控功能將事件發布至端點網址，您的伺服器就能驗證附加的權杖。這種驗證方法最有效的做法是搭配 SSL/TLS 使用，以便加密 HTTP 要求，防止窺探者取得權杖。

如需 Python 中的伺服器範例，請參閱這個伺服器範例。

廢止政策

酬載資料結構會遵循《Google Cloud Platform 服務條款》第 1.4(d) 節所述的 Google Cloud 淘汰政策。請注意，結構定義不會控制產生的欄位值格式，且這些格式可能會在未經通知的情況下變更。舉例來說，incident.summary、incident.documentation.content 和 incident.url 應包含與其欄位相關的資料，但結構定義沒有限制，無法保證這些欄位能正確剖析。您可以整批使用該值，並預期該值會遵循淘汰政策，但不要依賴剖析產生的欄位。

Pub/Sub

本節說明如何設定 Pub/Sub 通知管道。為確保備援機制，建議您建立多個通知管道。建議將 Pub/Sub 與 Google Cloud console 行動應用程式、PagerDuty、Webhook 或 Slack 配對，因為 Pub/Sub 使用不同的傳送機制。

如要設定 Pub/Sub 通知管道，請按照下列步驟操作：

如要瞭解資料結構定義，請參閱結構定義範例。

如要接收快訊通知，您還必須建立下列其中一種訂閱：pull、push 或 BigQuery。

如果訂閱項目位於與主題不同的專案中，請在訂閱者專案中建立服務帳戶，並授予該帳戶 roles/pubsub.subscriber 的角色。

事前準備

當您將第一個 Pub/Sub 通知管道新增至 Google Cloud 專案時，Cloud Monitoring 會為該專案建立服務帳戶。並將身分與存取權管理角色「Monitoring Notification Service Agent」授予服務帳戶。這個服務帳戶可讓監控功能將通知傳送至這個專案中以 Pub/Sub 為基礎的通知管道。

這個服務帳戶具備下列格式：

service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

通知服務帳戶名稱包含專屬的 Google Cloud 專案編號。您可以在 Google Cloud 控制台的專案資訊主頁上找到專案名稱、ID 和編號，也可以使用下列指令擷取：

gcloud projects describe PROJECT_ID --format="value(project_number)"

您可以使用 Google Cloud 控制台或 Google Cloud CLI 查看及編輯服務帳戶。

啟用必要的 API 並建立主題

在您打算建立通知管道和 Pub/Sub 主題的 Google Cloud 專案中，執行下列操作：

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

建立 Pub/Sub 主題。如要瞭解如何建立主題，請參閱「建立主題」一文。舉例來說，如要使用 Google Cloud CLI 建立名為 notificationTopic 的主題，請執行下列指令：
```
gcloud pubsub topics create notificationTopic
```

接著，請設定 Pub/Sub 通知管道。

設定主題的通知

如要建立 Pub/Sub 通知管道，您可以使用 Monitoring API、Google Cloud CLI 或 Google Cloud 控制台。建立通知管道後，請授權通知服務帳戶發布您用於通知管道的每個主題。

如要瞭解如何使用 Monitoring API 或 Google Cloud CLI 建立通知管道，請參閱「建立管道」。

如要使用 Google Cloud 控制台建立通知管道，請按照下列步驟操作：

前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
選取 Google Cloud 包含您建立的 Pub/Sub 主題的專案。
按一下「編輯通知管道」。
在「Pub/Sub」專區中，按一下「新增」。

「Created Pub/Sub Channel」對話方塊會顯示 Monitoring 建立的服務帳戶名稱。
授權服務帳戶。服務帳戶可以發布所有主題或特定主題：
- 如要發布所有主題，請選取「管理角色」，然後新增「Pub/Sub 發布者」角色。
  
  完成設定通知管道的步驟後，請略過下一節 (標題為「授權服務帳戶」)，並繼續閱讀「在警告政策中設定通知管道」一節。
- 如要發布特定主題，請繼續進行下一個步驟，並在完成通知管道的設定後，授權服務帳戶發布特定主題。如需服務帳戶授權操作說明，請參閱「授權服務帳戶」。
輸入頻道的顯示名稱和 Pub/Sub 主題名稱。
(選用) 如要確認管道設定正確無誤，請按一下「傳送測試通知」。
選取「新增管道」。

接著，請為服務帳戶授權。

為服務帳戶提供授權

授權後，通知服務帳戶就能發布您用作通知管道的每個 Pub/Sub 主題。本節將說明如何執行下列操作：

為特定主題授權服務帳戶。
為所有主題授權服務帳戶。

為特定主題授權服務帳戶

您可以使用 Google Cloud 控制台和 Google Cloud CLI，授權服務帳戶發布特定主題。本節將說明這兩種方法。

如要使用 Google Cloud 控制台為特定主題授權服務帳戶，請按照下列步驟操作：

在 Google Cloud 控制台中，前往「Topics」(主題) 頁面：
前往「主題」

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Pub/Sub」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
選取主題。
在「權限」分頁中，選取「新增主體」。
在「新增主體」欄位中輸入通知服務帳戶的名稱。這個服務帳戶具備下列命名慣例：
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
選取「Pub/Sub 發布者」角色，然後選取「儲存」。

如要使用 Google Cloud CLI 授權服務帳戶存取特定主題，請將主題的 pubsub.publisher IAM 角色授予服務帳戶。舉例來說，下列指令會為 notificationTopic 主題設定 IAM 角色：

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

成功執行 add-iam-policy-binding 指令的回應如下所示：

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1

詳情請參閱 pubsub topics add-iam-policy-binding 參考資料頁面。

為所有主題授權服務帳戶

如要為服務帳戶授權存取所有主題，請按照下列步驟操作：

前往 Google Cloud 控制台的「IAM」頁面：
前往「身分與存取權管理」頁面

如果您是使用搜尋列尋找這個頁面，請選取子標題為「IAM 與管理」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
選取「Include Google-provided role grants」，如以下圖片所示：
搜尋格式如下的服務帳戶：
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
如果服務帳戶未列入清單，請重新載入頁面。
為通知服務帳戶選取「編輯」，然後選取「新增其他角色」，然後新增「Pub/Sub 發布者」角色。

接著，請在快訊政策中設定通知管道。

在快訊政策中設定通知管道

如要在警告政策中使用 Pub/Sub 通知管道，請選取「Pub/Sub」做為管道類型，然後選取主題。

結構定義範例

如要查看 JSON 封包和結構定義的範例，請展開以下各節。

JSON 範例

根據預設，警示後端會嘗試產生採用 1.2 版格式的 JSON 封包。如要進一步瞭解這類格式，請參閱下一節。

以下是這類封包的範例：


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

結構定義結構 (第 1.2 版)

在傳回的封包中，欄位可按任意順序出現。在後續說明中，這些元素會歸納為相關群組。

廢止政策

Google Chat

Google Cloud Monitoring 應用程式可讓 Google Chat 聊天室接收通知。

事前準備

如果您是機構成員，則必須具備Google Cloud Monitoring 應用程式的存取權，才能安裝Google Cloud Monitoring 應用程式。如果您沒有存取權，請要求 Google Workspace 管理員執行下列操作：

安裝 Google Cloud Monitoring 應用程式

您必須按照以下步驟安裝Google Cloud Monitoring 應用程式。Google Workspace Marketplace 列表中不支援安裝。

如要安裝應用程式並將空間設為通知管道，請執行下列步驟：

在 Google Chat 中開啟或建立要接收通知的聊天室。
安裝 Google Cloud Monitoring 應用程式：
1. 選取空間名稱，然後選取「應用程式和整合」。
2. 如果 Google Cloud 「監控」應用程式未顯示在應用程式清單中，請返回工作區，輸入 @Google Cloud Monitoring，然後按下 Enter 鍵。
3. 按一下「新增至聊天室」。
將聊天室 ID 複製到剪貼簿。

如果您安裝了 Google Cloud Monitoring 應用程式，則安裝確認訊息中會包含聊天室 ID。否則，您可以查看聊天室網址末端的 space/ 後方，找到一連串數字和英文字母，這就是聊天室 ID。
開啟新的瀏覽器分頁，然後設定通知管道：
1. 前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
  前往「Alerting」(快訊)
  
  如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
3. 按一下「編輯通知管道」。
4. 前往「Google Chat」專區，然後按一下「新增」。
5. 在「Chat Space ID」欄位中輸入 Chat 聊天室 ID，然後按一下「Save」。

建立隨選管道

將通知管道新增至快訊政策時，您必須從清單中選取管道。如要在建立快訊政策時更新選項清單，請按照下列程序操作：

在通知對話方塊中，按一下「管理通知管道」。系統會將您導向在新的瀏覽器分頁中開啟的「通知管道」視窗。
如要新增通知管道，請找出管道類型，然後按一下「Add new」(新增)，並按照上表中的管道專屬操作說明進行設定。
返回原始分頁，然後在通知對話方塊中按一下「重新整理」。
從更新的清單中選取通知管道。

透過不支援的管道接收通知

如果系統不支援您偏好的通知管道，建議您建立 pipeline，以便將通知傳送至 Pub/Sub。如需使用 Flask 的 Python 範例，請參閱「使用 Cloud Monitoring 和 Cloud Run 建立自訂通知」。如需其他範例，請參閱 cloud-alerting-notification-forwarding Git 存放區。

測試通知管道

Cloud Monitoring 不支援通知管道的測試選項。不過，您可以建立快訊政策並設定要符合的條件，確認通知管道是否已正確設定。

如要手動測試通知管道，您可以建立警示政策，監控某個虛擬機器 (VM) 執行個體的 CPU 使用率：

選用：如果 Google Cloud 專案中尚未有 VM，或是您想使用其他 VM 進行測試，請建立 VM：
1. 前往 Google Cloud 控制台的「VM instances」(VM 執行個體) 頁面：
  前往「VM instances」(VM 執行個體) 頁面
  
  如果您是使用搜尋列尋找這個頁面，請選取子標題為「Compute Engine」的結果。
2. 在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
3. 選取「建立執行個體」，然後設定 VM。如要進一步瞭解如何建立 VM，請參閱「從公開映像檔建立 VM 執行個體」一文。
前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
選取「建立政策」。
使用「選取指標」選單，選取 VM 執行個體的「CPU 使用率」指標。
按一下「新增篩選器」，然後為 VM 新增篩選器。
更新「設定觸發條件」欄位，如下所示：
1. 在「Threshold position」(門檻位置) 欄位中選取「Below threshold」(低於門檻)。
2. 請選取大於執行個體 CPU 使用率的值。舉例來說，如果圖表顯示 CPU 使用率約為 5%，請將閾值設為 10%。
  
  這些設定會在 VM 執行個體的 CPU 使用率低於指定門檻時，設定要滿足的條件。由於您選取的閾值大於 VM 執行個體的 CPU 使用率，因此符合警示政策的條件。
將通知管道加入政策。
展開「Incident autoclose duration」(事件自動關閉期限)，然後選取「30 min」。
輸入政策名稱，然後按一下「建立政策」。
符合條件後，請確認您已透過各通知管道收到通知。
刪除警告政策。自動關閉期限過後，事件就會自動關閉。
如果您為這項測試建立了 VM 執行個體，請刪除該 VM。

如果您沒有收到預期的通知，可以搜尋記錄檔探索工具中的記錄項目，瞭解缺少通知的相關資訊。詳情請參閱「未收到通知」。

編輯及刪除通知管道

如要使用 Google Cloud 控制台編輯或刪除通知管道，請按照下列步驟操作：

前往 Google Cloud 控制台的「Alerting」(警告) 頁面：
前往「Alerting」(快訊)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。
按一下「編輯通知管道」。

「通知管道」資訊主頁包含各類型通知管道的專屬區段。每個部分都會列出該類型的所有設定：
- 如要修改項目，請按一下「編輯」。完成變更後，按一下「儲存」。
- 如要刪除項目，請按一下「刪除」。在確認對話方塊中按一下「刪除」。

查看通知管道記錄

您可以使用記錄檔探索工具查看通知管道錯誤：

前往 Google Cloud 控制台的「Logs Explorer」頁面：
前往「Logs Explorer」(記錄檔探索工具)

如果您是使用搜尋列尋找這個頁面，請選取子標題為「Logging」的結果。
在 Google Cloud 控制台的工具列中，選取您的 Google Cloud 專案。如要設定 App Hub，請選取 App Hub 主機專案或啟用應用程式的資料夾管理專案。
輸入並執行查詢。如要查看通知管道錯誤的專屬查詢，請參閱「Cloud Monitoring 查詢」。

後續步驟

如要瞭解事件，請參閱下列文件：

建立及管理通知管道 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

事前準備

決定要建立哪些通知管道

建立通知管道

電子郵件

行動應用程式

PagerDuty

JSON 範例

結構定義結構 (第 1.2 版)

廢止政策

設定 PagerDuty 對應嚴重性等級

簡訊

Slack

Webhook

設定 Webhook 通知管道

JSON 範例

結構定義結構 (第 1.2 版)

基本驗證

權杖驗證

廢止政策

Pub/Sub

事前準備

啟用必要的 API 並建立主題

設定主題的通知

為服務帳戶提供授權

為特定主題授權服務帳戶

為所有主題授權服務帳戶

在快訊政策中設定通知管道

結構定義範例

JSON 範例

結構定義結構 (第 1.2 版)

廢止政策

Google Chat

事前準備

安裝 Google Cloud Monitoring 應用程式

建立隨選管道

透過不支援的管道接收通知

測試通知管道

編輯及刪除通知管道

查看通知管道記錄

後續步驟

建立及管理通知管道
透過集合功能整理內容你可以依據偏好儲存及分類內容。