本文說明如何查看 App Hub 應用程式、服務和工作負載的立即可用 (OOTB) 資訊主頁。這些資訊主頁可協助您瞭解應用程式資源的成效,以及診斷問題。
這些隨附即用的資訊主頁顯示的遙測資料包括記錄和指標資料,以及未結事件的相關資訊。應用程式資訊主頁會提供位置、重要性和擁有者等資訊。服務和工作負載資訊主頁會顯示 App Hub 和基礎架構類型的相關資訊。
如要查看追蹤記錄資料,請使用 Trace Explorer。詳情請參閱本文件的「探索追蹤記錄資料」一節。
應用程式專屬標籤
本節列出可能附加至記錄、指標和追蹤資料的 App Hub 專屬標籤和屬性。Google Cloud Observability 可透過這些標籤建構 OOTB 資訊主頁的階層,並篩選顯示的遙測資料,只顯示服務或工作負載的資料。您也可以使用這些標籤篩選記錄、指標和追蹤資料。
當註冊的應用程式在支援應用程式監控的基礎架構上執行時,系統會將特定應用程式的標籤或屬性附加至記錄、指標和追蹤記錄資料。部分 Google Cloud Managed Service for Prometheus 設定的 Prometheus 指標資料也會包含應用程式標籤。
記錄標籤
記錄項目包含 apphub
欄位,其中列出應用程式以及服務或工作負載的標籤。以下說明這項資料的格式:
apphub: {
application: {
id: "my-app"
location: "my-app-location"
}
workload: {
criticalityType: "MEDIUM"
environmentType: "STAGING"
id: "my-workload-id"
}
}
指標標籤
本節說明何時會將應用程式專屬標籤附加至 Google Cloud 資源產生的指標資料,以及使用 Google Cloud Managed Service for Prometheus 擷取的 Prometheus 指標。在下文中,請將 a.b.{x,y}
解讀為 a.b.x
和 a.b.y
。
下列 App Hub 應用程式標籤會附加至應用程式所用 Google Cloud 資源的指標資料:
metadata.system_labels.apphub_application_{container,id,location}
metadata.system_labels.apphub_{workload,service}_{criticality_type,environment_type,id}
如果符合下列任一條件,應用程式中心應用程式標籤就會附加至 Google Cloud Managed Service for Prometheus 指標:
工作負載在 Google Kubernetes Engine 叢集上執行,版本為 1.30 以上,且工作負載的控制器類型為下列其中一種:
apps.k8s.io/{Deployment,StatefulSet,DaemonSet}
batch.k8s.io/CronJob
在 Cloud Run 上使用 OpenTelemetry 時。
在 Google Kubernetes Engine 上使用 OpenTelemetry,並遵循 OTLP Kubernetes 擷取指南。
Managed Service for Prometheus 會使用 App Hub API 判斷是否有 App Hub 應用程式。找到應用程式後,下列應用程式專屬標籤會新增至追蹤資料:
metric.labels.apphub_application_{container,id,location}
metric.labels.apphub_workload_{criticality_type,environment_type,id}
追蹤資源屬性
下列應用程式專屬資源屬性可附加至追蹤資料:
gcp.apphub.application.{container,id,location}
gcp.apphub.{workload,service}.{criticality_type,environment_type,id}
符合下列條件時,應用程式專屬的資源屬性會附加至追蹤資料:
- 您的 App Hub 應用程式使用支援的 Google Cloud 資源。
- 您可以使用 OpenTelemetry 檢測應用程式,並透過 Google Cloud OTLP 端點將應用程式收集的追蹤記錄資料傳送至專案。
- 傳送至專案的資料包括OpenTelemetry 資源屬性,可識別應用程式使用的支援資源。 Google Cloud 屬性必須包含下列項目:
cloud.account.id
cloud.{availability_zone,region}
其中之一資源專屬屬性。舉例來說,如果是 Kubernetes 工作負載,跨度必須具備
k8s.cluster.name
、k8s.namespace
和 Kubernetes 部署集類型。您可以使用處理器,讓 OpenTelemetry Collector 將資源專屬屬性附加至跨度。詳情請參閱
resourcedetectionprocessor
和k8sattributesprocessor
。
當您檢測應用程式時,Google Cloud Observability 會使用上述資源屬性和 App Hub API,識別您的 App Hub 應用程式。系統識別應用程式後,就會在追蹤資料中加入應用程式專屬標籤。
如要進一步瞭解這些屬性,請參閱Google Cloud 應用程式中心語意慣例。
快訊政策標籤
系統不會自動將服務和工作負載標籤附加至快訊政策。不過,您可以將下列所有標籤附加至警報政策,並使用下列鍵,將警報政策與特定工作負載或服務建立關聯:
apphub_application_location
apphub_application_id
apphub_service_id
或apphub_workload_id
如果快訊政策包含上述鍵,OOTB 資訊主頁就會顯示該政策的事件。
詳情請參閱「將快訊政策與服務或工作負載建立關聯」。
Google Cloud 主控台導覽
開啟 Google Cloud Observability 頁面時, Google Cloud 控制台會自動將資源挑選器從啟用應用程式的資料夾重設為資料夾的管理專案。
Cloud Logging 支援將資料夾做為資源。舉例來說,您可以在資料夾資源中建立記錄接收器和記錄儲存空間。同樣地,資料夾包含 _Default
和 _Required
記錄值區,您可能想查看這些值區的內容。如要存取資料夾資源,請使用資源挑選器,然後手動選取已啟用應用程式的資料夾。
事前準備
使用應用程式監控功能前,請務必先設定應用程式中心主機專案,或是已啟用應用程式的資料夾管理專案。這個專案是用來查看應用程式遙測資料的專案:
-
如要取得檢視記錄和指標資料、建立警告政策及自訂資訊主頁所需的權限,請要求管理員授予您下列 IAM 角色:
-
記錄檢視器 (
roles/logging.viewer
) 在 App Hub 主機專案或已啟用應用程式的資料夾管理專案,以及預設記錄範圍中列出的任何其他專案。這個角色可存取_Default
記錄值區中的大部分記錄項目。詳情請參閱「記錄角色」。 -
記錄檢視畫面存取者 (
roles/logging.viewAccessor
) 在App Hub 主專案的預設記錄範圍,或已啟用應用程式的資料夾管理專案中,列出的記錄檢視畫面。如要進一步瞭解如何授予記錄檢視畫面存取權,請參閱「控管記錄檢視畫面存取權」。 -
監控編輯者 (
roles/monitoring.editor
) 在 App Hub 主專案或啟用應用程式的資料夾管理專案中。如果主體不需要建立或修改快訊政策或資訊主頁,請考慮授予「Monitoring 檢視者」角色 (roles/monitoring.viewer
)。 -
Cloud Trace 使用者 (
roles/cloudtrace.user
) 在 App Hub 主專案或已啟用應用程式的資料夾管理專案,以及預設追蹤範圍內的專案。 -
App Hub 檢視者 (
roles/apphub.viewer
) 在 App Hub 主專案或啟用應用程式的資料夾管理專案中。詳情請參閱「應用程式中心角色和權限」。
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
-
記錄檢視器 (
確認您已設定App Hub 主機專案或已啟用應用程式的資料夾管理專案的可觀測範圍。詳情請參閱「設定 Application Monitoring」。
可觀測範圍會控管哪些資料可供 App Hub 主機專案或已啟用應用程式的資料夾管理專案使用。這些範圍的預設設定可能無法讓您查看所有記錄或指標資料。
更新監控應用程式資料的快訊政策,加入應用程式專屬標籤。詳情請參閱「將快訊政策與服務或工作負載建立關聯」。
查看所有申請的摘要
頂層 OOTB 資訊主頁會簡要總結已註冊應用程式的狀態。這個頁面會列出每個應用程式的未結事件數,以及位置、嚴重性和環境等資訊。
如要開啟頂層 OOTB 資訊主頁,查看在 App Hub 註冊應用程式的摘要資訊,請按照下列步驟操作:
-
前往 Google Cloud 控制台的「Application monitoring」頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
在 Google Cloud 控制台的工具列中,選取 App Hub 主專案,或是已啟用應用程式的資料夾管理專案。
選用步驟:如要在 App Hub 中開啟應用程式,請按一下「更多」more_vert,然後選取「在 AppHub 中管理」。
如要開啟應用程式的 OOTB 資訊主頁,請選取該應用程式。 下一節將說明如何探索或解讀遙測資料。
探索應用程式遙測資料和事件
選取「應用程式監控」頁面列出的應用程式後,系統會開啟該應用程式的頂層 OOTB 資訊主頁。這個資訊主頁會列出多項黃金信號的值,並彙整未結事件的數量,協助您瞭解應用程式的健康狀態。舉例來說,如果這個頁面顯示大範圍的失敗情形,可能表示失敗來源是基礎架構,而非應用程式。
如要開啟應用程式的 OOTB 資訊主頁,請按照下列步驟操作:
-
前往 Google Cloud 控制台的「Application monitoring」頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 在 Google Cloud 控制台的工具列中,選取 App Hub 主專案,或是已啟用應用程式的資料夾管理專案。
在「應用程式監控」頁面中,選取應用程式名稱。
應用程式的 OOTB 資訊主頁會隨即開啟,並選取「總覽」分頁。這個分頁會列出各項服務和工作負載,以及未結事件的數量和黃金訊號的值:
- 流量:所選時間範圍內,服務或工作負載的傳入要求比率。
- 伺服器錯誤率:在所選時間範圍內,產生或對應至 5xx HTTP 回應代碼的傳入要求平均百分比。
- P95 延遲時間:所選時間範圍內,要求延遲時間的第 95 個百分位數,以毫秒為單位。
- 飽和度:衡量服務或工作負載的飽和程度。舉例來說,如果是代管執行個體群組 (MIG)、Cloud Run 和 Google Kubernetes Engine 部署作業,這個欄位會顯示 CPU 使用率。
在「總覽」分頁中,你可以執行下列所有操作:
- 重設時間範圍。開啟資訊主頁時,時間範圍會設為最近一小時。
- 查看應用程式相關資訊,例如營運商、開發人員和企業主。
- 在 App Hub 中開啟應用程式、服務或工作負載。
- 開啟服務或工作負載的資訊主頁。
如要查看應用程式遙測資料和未解決事件的相關資訊,請選取「資訊主頁」分頁標籤。
「資訊主頁」分頁會顯示記錄、指標和事件資訊。這個分頁會設定在圖表上疊加事件註解。註解有助於在排解問題時,將不同來源的資料建立關聯。如要查看已啟用哪些註解,請在工具列中按一下「註解」
。
這個分頁也包含篩選器,可用於限制分頁顯示的資料。如要進一步瞭解如何探索這個分頁中顯示的資料,請參閱本文件的下列章節:
篩選資訊主頁
「資訊主頁」分頁會顯示應用程式中服務和工作負載的資料。不過,您可以篩選這個資訊主頁,只顯示特定服務或一組服務的資料。
舉例來說,「資訊主頁」分頁的工具列包含 apphub_service_id: *
等篩選條件。如要查看特定服務的資料,請按一下「選單」arrow_drop_down,然後從清單中選取這些服務。
探索記錄檔資料
如果您正在查看應用程式資訊主頁的「Dashboard」(資訊主頁) 分頁,記錄資料會顯示在「Application Logs」(應用程式記錄) 區段。否則,您的資料會顯示在「記錄」部分。
資訊主頁的「應用程式記錄」和「記錄」部分會顯示符合篩選條件的記錄項目,並由 App Hub 主專案的預設記錄範圍或啟用應用程式的資料夾管理專案儲存。應用程式的篩選器類似於下列項目:
-- Application logs
(apphub_application_location=global)
(apphub_application_id=my-app)
如果是服務和工作負載,篩選器會包含其他子句。 如要查看套用至記錄資料的篩選器,請按一下「Show query」(顯示查詢)。
如要撰寫查詢,可以開啟飛出式視窗或「記錄檔探索工具」頁面。這兩種方式都能讓您撰寫及執行查詢,並變更範圍。不過,飛出式視窗會保留目前的脈絡,並允許您將探索結果儲存至自訂資訊主頁:
如要開啟飛出式視窗,請按一下「探索資料」query_stats。
完成探索後,請按一下「取消」關閉彈出式視窗,並捨棄變更。如要將變更儲存至自訂資訊主頁,請按一下「儲存至資訊主頁」並完成對話方塊。開啟飛出式視窗時,您無法將變更儲存至正在檢視的資訊主頁。
飛出式視窗不會列出「顯示查詢」按鈕顯示的篩選器。 這些篩選器是在資訊主頁層級套用,因此無法移除。
如要在新的瀏覽器分頁中開啟「記錄檔探索工具」頁面,請按一下「在記錄檔探索工具中查看」。
查詢已預先設定,可顯示符合特定應用程式標籤,且位於資訊主頁指定時間範圍內的記錄項目。關閉瀏覽器分頁時,系統會捨棄變更。
如要進一步瞭解如何查看記錄,請參閱下列文件:
探索指標資料
資訊主頁上的圖表和表格會顯示關鍵信號,以及與應用程式、服務或工作負載所用資源相關的其他指標資料。顯示的資料可以儲存在指標範圍列出的任何專案中,包括應用程式中心主專案,或是已啟用應用程式的資料夾管理專案。
對於顯示指標資料的任何圖表或表格,您都可以查看指標類型和匯總選項等詳細資料。如要查看這項資訊,請前往圖表或表格的工具列,然後按一下「資訊」圖示 info。
如要查看圖表或表格的詳細資料,可以開啟飛出式視窗或 Metrics Explorer 頁面。這兩種做法都能讓您嘗試不同的圖表設定,並將結果儲存至自訂資訊主頁。不過,飛出視窗會保留目前的背景資訊:
如要開啟飛出式視窗,請按一下「探索資料」query_stats。
完成探索後,請按一下「取消」關閉彈出式視窗,並捨棄變更。如要將變更儲存至自訂資訊主頁,請按一下「儲存至資訊主頁」並完成對話方塊。開啟飛出式視窗時,您無法將變更儲存至正在檢視的資訊主頁。
如要在 Metrics Explorer 中查看圖表或表格,請前往工具列,按一下「更多」more_vert,然後選取「在 Metrics Explorer 中查看」。
現在您有臨時圖表,可以修改和探索。例如,您可以變更匯總選項或顯示樣式。如要將圖表儲存到自訂資訊主頁,請按一下「儲存至資訊主頁」,然後完成
探索事件
資訊主頁的「事件」部分會列出與服務或工作負載相關聯的警報政策,以及最近發生的事件。這些警告政策必須儲存在 App Hub 主機專案,或是已啟用應用程式的資料夾的管理專案中。
如果「事件」部分沒有顯示任何項目,表示您沒有與服務或工作負載相關聯的任何警報政策。如要建立這項關聯,請在政策中新增標籤。詳情請參閱「將快訊政策與服務或工作負載建立關聯」。
如要進一步瞭解事件和快訊政策,請按照下列步驟操作:
如要查看導致事件的快訊政策詳細資料,請按一下政策名稱。開啟的資訊主頁會顯示快訊政策的詳細資訊,包括顯示監控資料和標籤的圖表。
如要查看與應用程式相關聯的所有快訊政策,請前往工具列,然後按一下「Explorer data」(探索資料) query_stats。系統會開啟列出所有政策的飛出式視窗。如要返回資訊主頁,請按一下「取消」。
探索追蹤記錄資料
OOTB 資訊主頁不會顯示追蹤資料。不過,您可以使用「Trace 探索工具」頁面,查看應用程式、服務或工作負載的追蹤記錄資料。開啟這個頁面時,系統會從儲存空間擷取預設追蹤記錄範圍所列專案中儲存的追蹤記錄資料。顯示的資料取決於您在這些專案中的 IAM 角色、時間範圍設定和套用的篩選條件。如要瞭解追蹤資料何時會包含應用程式屬性,請參閱「追蹤資源屬性」。
如要查看應用程式的追蹤記錄資料,請按照下列步驟操作:
-
前往 Google Cloud 控制台的「Trace Explorer」頁面:
您也可以透過搜尋列找到這個頁面。
- 在 Google Cloud 控制台的工具列中,選取App Hub 主專案,或是已啟用應用程式的資料夾的管理專案。
套用篩選器來限制追蹤資料:
- 如要依應用程式篩選,請使用「App Hub 應用程式」範圍篩選器。
- 如要依服務篩選,請使用「App Hub 服務」篩選器。
- 如要依工作負載篩選,請使用「App Hub 工作負載」範圍篩選器。
- 如要新增自訂篩選器,請在工具列中依序選取「新增篩選器」和「新增屬性篩選器」,然後完成對話方塊。
Key 欄位的語法必須與 span 屬性鍵的語法相符。舉例來說,如要依主機 ID 篩選,請輸入
host.id
。
如要瞭解如何使用追蹤記錄介面,請參閱「尋找及探索追蹤記錄」。
探索服務或工作負載遙測資料和事件
每個服務和工作負載都提供 OOTB 資訊主頁。這些資訊主頁會顯示記錄、指標和事件資訊,協助您瞭解特定服務或工作負載的健康狀態。您可以探索這些隨附即用的資訊主頁資料,方式與探索應用程式「資訊主頁」分頁中顯示的資料類似。
如要開啟服務或工作負載的 OOTB 資訊主頁,請按照下列步驟操作:
-
前往 Google Cloud 控制台的「Application monitoring」頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 在 Google Cloud 控制台的工具列中,選取App Hub 主專案,或是已啟用應用程式的資料夾的管理專案。
在「應用程式監控」頁面中,選取應用程式名稱,然後選取服務或工作負載。
資訊主頁會顯示所選服務或工作負載的記錄、指標和事件資訊。對於工作負載,資訊主頁會設定在圖表上疊加事件註解。排解問題時,註解可協助您比對不同來源的資料。如要查看已啟用哪些註解,請在工具列中按一下「註解」
。
摘要資訊卡會顯示一般資訊和基礎架構類型。如果無法識別基礎架構類型,這個欄位會顯示一般文字,例如「App Hub 服務」。詳情請參閱「應用程式監控支援的基礎架構」。
如要瞭解如何探索服務或工作負載資訊主頁中的資料,請參閱本文的下列章節:
建立自訂資訊主頁
Google Cloud Observability 支援建立自訂資訊主頁,讓您完全掌控資訊主頁的內容。自訂資訊主頁會列在 Google Cloud 控制台的「資訊主頁」頁面中,您可以複製、編輯及刪除這些資訊主頁。您也可以將設定好的資訊主頁小工具儲存到這些資料夾。舉例來說,如果您正在查看應用程式資訊主頁上的圖表,可以前往工具列並選取「儲存至資訊主頁」,將該圖表儲存至自訂資訊主頁。
如果您打算為應用程式、服務或工作負載建立自訂資訊主頁,下列資訊或許有幫助:
您可以為自訂資訊主頁新增資訊主頁層級的篩選器。與在個別小工具中新增篩選器相比,使用這些篩選器可能更有效率,也更具彈性。篩選器會根據標籤顯示結果。如需標籤清單,請參閱本文件的「應用程式專屬標籤」一節。
請考慮現有範本是否包含您需要的大部分內容。如要瞭解詳情 (包括儲存範本的 GitHub 存放區連結),請參閱「安裝資訊主頁範本」。
將快訊政策與 App Hub 應用程式建立關聯
如要將快訊政策與服務或工作負載建立關聯,請在快訊政策中加入應用程式專屬標籤。新增這些標籤後,系統會在警報政策中列出這些標籤,並將其納入所有事件。如要進一步瞭解標籤,請參閱「使用標籤註解事件」。
如要使用 Google Cloud 控制台將快訊政策與工作負載或服務建立關聯,請按照下列指示操作:
-
前往 Google Cloud 控制台的 notifications「Alerting」(警告) 頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 在Google Cloud 控制台的工具列中,選取您的 App Hub 主專案,或是已啟用應用程式的資料夾管理專案。
- 找到快訊政策,按一下「查看更多」more_vert,選取「編輯」,然後前往「通知和名稱」部分。
- 在「應用程式標籤」部分,選取應用程式,然後選取工作負載或服務。
- 按一下 [Save Policy] (儲存政策)。
完成這些步驟後,系統會將具有下列鍵的標籤附加至警報政策。這些標籤可識別您的應用程式和服務/工作負載:
apphub_application_location
apphub_application_id
apphub_service_id
或apphub_workload_id
您也可以使用 Google Cloud CLI、Terraform 或 Cloud Monitoring API,在快訊政策中加入使用者標籤。不過,您必須使用上一個範例中顯示的標籤鍵。 如要瞭解詳情,請參考下列資源:
疑難排解
如要瞭解如何解讀所查看的資料,或瞭解資訊主頁未顯示資料的原因,請參閱「排解應用程式監控問題」。