在資訊主頁上顯示事件

本文說明如何設定資訊主頁,以顯示事件註解。 事件是指會影響系統運作的活動,例如部署或當機。顯示事件註解有助於在排解問題時,將不同來源的資料建立關聯。

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

關於事件註解

您可以在 Google Cloud 控制台的「資訊主頁」頁面中,查看大多數資訊主頁上的事件。同樣地,您也可以設定某些服務專用的「可觀測性」分頁,例如 Compute Engine 和 Google Kubernetes Engine 的分頁,以顯示事件。如要設定資訊主頁或「可觀測性」分頁顯示的事件類型,請使用 Google Cloud 控制台。您也可以使用 Cloud Monitoring API,建立歸類為自訂資訊主頁的資訊主頁。

除非您使用 Cloud Monitoring API 或採取行動儲存所選事件類型,否則所選項目只會套用至目前工作階段。使用 Google Cloud 控制台時,釘選所選項目即可儲存。

如需事件類型清單、疑難排解參考資料和其他資訊,請參閱「事件類型」頁面。

即使您未選取任何事件類型,資訊主頁或「可觀測性」分頁中仍可能會顯示下列已啟用的事件類型:

系統自動新增的活動類型為建議活動類型。 您可以將這些事件類型保留在建議狀態、儲存至資訊主頁 JSON,或關閉建議。如要判斷系統儲存的事件類型,請展開「註解」選單,然後查看「已釘選」部分。

如何找出事件

資訊主頁會查詢不同資料來源,找出要顯示在資訊主頁上的事件:

  • 快訊事件是由 Monitoring 識別。快訊事件會提供事件開啟時間的相關資訊。

  • Monitoring 會將查詢傳送至 Service Health API,藉此找出 Personalized Service Health 事件。這類事件表示 Google Cloud 服務發生中斷。

  • 系統會分析通過您 Google Cloud 專案中 Cloud Logging 接收器的記錄項目,找出所有其他事件類型。這些記錄項目包括專案產生的項目,以及轉送至專案的項目。如要在發生上述任一事件時收到通知,可以建立記錄檔快訊政策。在快訊政策中,使用「事件類型」頁面提供的查詢。

活動顯示方式

系統會在資訊主頁的圖表上標註所有事件的發生時間。分析記錄項目後識別出的事件會顯示單一時間參照。相較之下,服務健康狀態事件會顯示開始時間,然後圖表的背景會在事件期間變更。這些活動也會顯示愛心圖示。

下圖顯示的圖表是分析記錄項目後識別出的多個事件,以及一個服務健康狀態事件:

圖表:顯示警告和資訊事件註解。

如上一個螢幕截圖所示,事件的工具提示包含下列資訊:

  • 活動名稱。
  • 活動的日期和開始時間。
  • 如果是 Service Health 事件,則會顯示受影響產品和地點數量的資訊方塊。如要列出受影響的產品或地點,請將指標放在相應的晶片上。
  • 「查看」按鈕:選取後會開啟頁面,顯示活動的詳細資訊。舉例來說,系統可能會開啟記錄檔總管,方便您查看記錄項目,或是開啟服務健康狀態事件的詳細資料頁面。

資訊主頁篩選器會限制資訊主頁顯示的資料,通常會同時篩選時間序列資料和事件。

事前準備

針對要查看資訊主頁事件的 Google Cloud 專案,完成下列步驟:

  • 如要取得必要權限,以便在資訊主頁上查看及顯示事件,並建立警報政策,請要求管理員在專案中授予下列 IAM 角色:

    • 查看及建立資訊主頁和快訊政策: Monitoring 編輯者 (roles/monitoring.editor)。
    • 查看及顯示從 Google Cloud 專案中建立的非資料存取記錄項目識別出的事件: 記錄檢視器 (roles/logging.viewer)。
    • 查看及顯示在 Google Cloud 專案中建立的任何記錄項目所識別的事件: 私人記錄檢視器 (roles/logging.privateLogViewer)。
    • 查看 Service Health 事件: Personalized Service Health 檢視者 (roles/servicehealth.viewer)

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

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

  • 如要在資訊主頁顯示 Service Health 事件,請啟用 Service Health API:

    Enable the API

顯示事件

本節說明如何設定資訊主頁或「可觀測性」分頁,以顯示事件。

設定資訊主頁以顯示事件

本節說明如何設定 Google Cloud 控制台「資訊主頁」頁面中列出的資訊主頁,以顯示事件。

如需事件類型清單、疑難排解參考資料,以及可搭配記錄檔探索工具或以記錄為準的快訊政策使用的查詢,請參閱「事件類型」頁面。

控制台

如要在資訊主頁上顯示活動,請按照下列步驟操作:

  1. 在 Google Cloud 控制台中,前往「Dashboards」(資訊主頁)  頁面:

    前往「Dashboards」(資訊主頁)

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

  2. 在 Google Cloud 控制台的工具列中,選取您的 Google Cloud 專案。如為「App Hub」設定,請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。
  3. 選取要查看的資訊主頁。
  4. 在資訊主頁的工具列中,按一下「註解」,然後選取要在資訊主頁中顯示的事件類型。
  5. 執行下列其中一個步驟:

    • 如要儲存所選項目,以便在重新載入資訊主頁時顯示事件,請按一下「固定所選項目」。如果資訊主頁已停用自動儲存功能,請前往資訊主頁的工具列,然後按一下「儲存」

      固定選取項目時,您會修改資訊主頁的 JSON 定義。因此,當您重新開啟資訊主頁時,系統會載入所選項目,並顯示相應事件類型的註解。

    • 如要只在目前工作階段顯示事件類型,請按一下「套用」

    更新要顯示的事件類型清單後,Cloud Monitoring 會發出查詢 (需要幾分鐘),然後將註解新增至資訊主頁的圖表。

  6. 如要查看活動摘要或存取其他資訊的連結,請使用指標啟動工具提示。

API

如要設定自訂資訊主頁來顯示事件,請在 Dashboard 物件中加入 annotations 欄位。annotations 欄位包含 DashboardAnnotations 物件的例項,其中包含兩個欄位:

  • defaultResourceName」欄位會列出資訊主頁層級的預設值,供Google Cloud 專案搜尋事件。如果未指定這個欄位,系統會搜尋所選專案。

  • EventAnnotation 物件的陣列。每個物件都包含下列項目:

    • displayName 欄位,可讓您定義活動專屬切換按鈕上的標籤。如果未指定這個欄位,或這個欄位的值為空白字串,系統會顯示事件的預設名稱。
    • enabled 欄位,可控制事件切換鈕的值。當切換鈕處於 on 位置時,true 會顯示在資訊主頁上。當 false 處於 off 位置時。
    • eventType 欄位,其中包含 EventType 列舉的值。
    • filter 欄位,可讓您指定要附加至事件專屬查詢的查詢。如果這個欄位的值是空字串,系統就會使用事件專屬查詢。
    • resourceNames 欄位,可讓您定義要搜尋事件的Google Cloud 專案清單。如果這個欄位是空陣列,系統會搜尋您選取的專案。

以下範例顯示叢集更新事件的 annotations 物件。本範例中的 filter 欄位會將事件限制在特定叢集:

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

如要進一步瞭解如何使用 Cloud Monitoring API 建立資訊主頁,請參閱「使用 API 建立及管理資訊主頁」和「範例:在資訊主頁上啟用事件」。

設定「可觀測性」分頁,顯示事件

本節說明如何設定「可觀測性」分頁,以顯示事件。部分服務 (例如 Compute Engine 和 Google Kubernetes Engine) 提供「可觀測性」分頁,顯示指標和記錄資料。

控制台

如要設定「可觀測性」分頁顯示事件,請按照下列步驟操作:

  1. 前往服務或產品的「可觀測性」分頁。

    舉例來說,您可以前往「Kubernetes Clusters」(Kubernetes 叢集) 頁面,然後選取「Observability」(可觀測性) 分頁標籤。同樣地,您也可以前往「Kubernetes Workloads」頁面或虛擬機器 (VM) 執行個體的詳細資料頁面,然後選取「Observability」分頁標籤。

  2. 確認「資訊主頁」選單已設為「預先定義」。 自訂資訊主頁無法顯示活動。

  3. 在工具列上,按一下「註解」,然後完成對話方塊。

    更新要顯示的事件清單後,系統會發出查詢來擷取事件資料,然後更新資訊主頁。

    如果沒有顯示「註解」選單,就無法設定分頁顯示活動。

API

不適用。

檢視活動詳細資訊

查看顯示事件註解的圖表時,您可以使用工具提示中提供的連結存取其他資訊。

如要查看特定事件的詳細資料,請按一下「查看」

「檢視」按鈕開啟的 Google Cloud 控制台頁面取決於事件類型。舉例來說,如果是運作時間檢查事件,這個按鈕會開啟運作時間檢查的資訊主頁。如果是其他事件類型,系統可能會開啟記錄檔探索工具。

建立快訊政策

系統會分析通過專案中 Cloud Logging 接收器的記錄項目,找出事件。您 Google Cloud 可以設定記錄指標快訊,在發生這些事件時收到通知。以記錄為準的快訊政策會在收到記錄項目時查詢。如果查詢傳回非空白結果,系統就會建立事件並傳送通知。

控制台

如要建立記錄檔快訊,請按照下列步驟操作:

  1. 如果尚未設定通知管道,請按照下列步驟操作:

    1. 前往 Google Cloud 控制台的 「Alerting」(警告) 頁面

      前往「Alerting」(快訊)

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

    2. 在 Google Cloud 控制台的工具列中,選取您的 Google Cloud 專案。如為「App Hub」設定,請選取 App Hub 主機專案或已啟用應用程式的資料夾管理專案。
    3. 按一下「編輯通知管道」
    4. 前往要設定的通知管道類型,按一下「新增」,然後完成對話方塊。
  2. 前往 Google Cloud 控制台的「Logs Explorer」頁面:

    前往「Logs Explorer」(記錄檔探索工具)

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

  3. 在 Google Cloud 控制台的工具列中,選取您的 Google Cloud 專案。

  4. 在工具列中選取「建立快訊」

  5. 輸入快訊政策的名稱,然後按一下「下一步」

  6. 在「定義要發出快訊的記錄檔項目」部分中,輸入查詢或更新從「查詢」窗格複製的查詢 (選取「建立快訊」時)。

    「事件類型」頁面會列出適合用於以記錄為準的警報政策的查詢。

  7. 填寫對話方塊,然後按一下「儲存」

API

如要使用 Cloud Monitoring API 建立記錄檔快訊政策,請按照下列步驟操作:

  1. 找出要納入快訊政策條件的查詢。「事件類型」頁面會列出適合用於以記錄為準的警報政策的查詢,方便您為每種事件類型建立警報政策。

  2. 建立 JSON 檔案,其中包含快訊政策的表示法。如要進一步瞭解這個步驟和範例,請參閱「設計快訊政策」。

  3. 叫用 alertPolicies.create API 方法。 舉例來說,您可以發出 gcloud alpha monitoring policies create 指令。

隱藏事件

控制台

如要隱藏所有事件,請在資訊主頁工具列中,按一下「註解」,選取「清除」,然後選取「套用」

如要隱藏某種活動,請按一下「註解」,取消選取該活動類型,然後選取「套用」

API

如要在自訂資訊主頁上隱藏某種事件類型,請找出該事件類型的 EventAnnotation 物件,然後將 enabled 欄位設為 false

如要進一步瞭解如何使用 Cloud Monitoring API,請參閱「透過 API 建立及管理資訊主頁」。

後續步驟