本頁面說明如何使用 Key Visualizer,檢查與 Cloud Firestore 使用模式相關的效能問題。
事前準備
如要使用 Cloud Firestore 的 Key Visualizer,必須啟用 Firestore Key Visualizer API。
啟用 API 所需的角色
如要啟用 API,您必須具備 serviceusage.services.enable 權限。如果您建立了專案,可能已透過擁有者角色 (roles/owner) 取得這項權限。否則,您可以透過 Service Usage 管理員角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。
必要的角色
請確認您的帳戶已獲派下列其中一個 IAM 角色:
- Cloud Datastore 擁有者
- Cloud Datastore Key Visualizer 檢視者
- 編輯者
- 擁有者
這些角色包含下列 IAM 權限,是存取 Key Visualizer 的必要權限:
datastore.keyVisualizerScans.getdatastore.keyVisualizerScans.listdatastore.databases.getMetadataresourcemanager.projects.get
您也可以定義具有必要權限的自訂角色。
查看特定時間範圍的掃描作業
每項 Key Visualizer 掃描作業涵蓋兩小時。如果資料庫在特定期間內,每分鐘的文件作業流量超過 3,000 次,系統就會提供該期間的掃描作業。
如要啟動 Key Visualizer,請按照下列步驟操作:
前往 Google Cloud 控制台的「Databases」(資料庫) 頁面。
從資料庫清單中選取所需資料庫。
在導覽選單中,按一下「Key Visualizer」。
從可用的 Key Visualizer 掃描結果中,選取時間範圍和指標:
按一下右上方的「鉛筆」圖示。選取「Date」(日期) 和「Time Span」(時間範圍)。
是否可執行掃描取決於掃描資格。您無法選取不符合掃描資格或仍在處理中的時間範圍。當天最近兩次掃描需要一些時間處理,才能使用。
選取「所有文件資料」或「所有索引資料」做為來源。
點選「更新」。
選取要分析的指標:
按一下左上方的指標下拉式選單,然後選取要查看的指標。根據預設,Key Visualizer 會開啟文件鍵的「Ops/s」(作業/秒) 指標,以及索引鍵的「Index Write Ops/s」(索引寫入作業/秒) 指標。
如要比較指標或尋找資料關聯,您可以同時顯示多個 Key Visualizer 指標。請參閱「找出不同指標之間的關聯」。
查看活動總覽
如要查看所選兩小時時間範圍內的活動總覽,請查看預設指標的熱視圖。
下列範例顯示一個熱視圖,其中不同索引鍵範圍的使用模式出現明顯差異:
- 深色所示的範圍有極少或是完全沒有活動。
- 淺色範圍有明顯較多的活動。
- 中間的亮白色範圍有非常多的活動。
文件金鑰掃描
「Ops/s」指標會評估每個鍵範圍每秒的要求數。這項指標是寫入、查詢和查詢要求的總和。開啟熱視圖時,Key Visualizer 預設會顯示這項指標。
瞭解資料庫的整體活動後,您可以查看其他指標,並著重於可能導致問題的重要範圍,繼續調查。瞭解詳情。
索引鍵掃描
指定儲存格的「Index Write Ops/s」(索引寫入作業數/秒) 指標,會測量對應 10 秒時間間隔和鍵範圍內的每秒平均索引寫入次數。
後續步驟
- 瞭解如何辨識文件鍵熱圖中的常見模式。
- 瞭解如何辨識索引鍵熱視圖中的常見模式。
- 瞭解如何深入探索熱視圖。