儲存及共用查詢

預覽

這項產品或功能適用《服務專屬條款》中「一般服務條款」一節的《正式發布前產品條款》。正式發布前的產品和功能是按照「原樣」提供，支援範圍可能有限。 詳情請參閱推出階段說明。

本文說明如何儲存及共用在可觀測性分析中建立的查詢。如果您不熟悉 Observability Analytics，請參閱「查詢及分析追蹤記錄」。

如要瞭解如何繪製查詢圖表，或如何在 BigQuery 中查詢追蹤記錄資料，請參閱本文「後續步驟」一節列出的文件。

事前準備

登入 Google Cloud 帳戶。如果您是 Google Cloud新手，歡迎 建立帳戶，親自評估產品在實際工作環境中的成效。新客戶還能獲得價值 $300 美元的免費抵免額，可用於執行、測試及部署工作負載。

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

1. 如要取得載入「可觀測性分析」頁面、在追蹤資料上撰寫、執行及儲存私人查詢所需的權限，請要求系統管理員授予您下列 IAM 角色：

   • 觀測能力檢視畫面存取子 (roles/observability.viewAccessor) 在您要查詢的觀測能力檢視畫面中，這個角色支援 IAM 條件，可讓您將授權限制在特定檢視區塊。如果未在角色授予作業中附加條件，主體就能存取所有可觀測性檢視畫面。
   • 專案的「Observability Analytics 使用者」 (roles/observability.analyticsUser) 權限。這個角色具備儲存及執行私人查詢，以及執行共用查詢所需的權限。
   • 記錄檢視器 (roles/logging.viewer) 專案。

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

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

   注意：如要建立及管理共用查詢，上述 IAM 角色並不適用。如要建立及管理共用查詢，您的 IAM 角色必須包含 logging.queries.{share, updateShared, deleteShared} 權限。

儲存查詢

系統會自動儲存您執行的所有查詢 30 天，只要在「可觀測性分析」頁面選取「最近」分頁標籤，即可存取這些查詢。您可以搜尋、查看、執行及分享「最近」分頁中列出的查詢。

如要保留查詢以供日後使用、為查詢加上對您有用的註解資訊，或允許團隊成員查看及執行查詢，請儲存查詢。您可以依名稱、說明和顯示標籤搜尋及排序已儲存的查詢。您也可以編輯及刪除這些查詢。系統會保留您儲存的查詢，直到您刪除為止。

每個專案最多可儲存 10,000 個查詢。 Google Cloud

控制台

如要儲存查詢，請按照下列步驟操作：

1. 在 Google Cloud 控制台中，前往 「Log Analytics」(記錄檔分析) 頁面：

   前往「Log Analytics」(記錄檔分析)

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

2. 在「Query」(查詢) 窗格中填入查詢。

   您可以輸入新查詢、從「近期」分頁選取查詢，或從「已儲存」分頁選取查詢，藉此填入「查詢」窗格。

   查詢可包含任何有效的資料檢視、多個資料檢視和資料分析檢視。

   當「查詢」窗格中的查詢有效時，系統會啟用「儲存」。

3. 按一下「儲存」，選取「儲存查詢」，然後填寫「名稱」和「說明」欄位。您為這些欄位設定的值會顯示在「已儲存」分頁中。

4. 選用：如要讓有權存取專案「可觀測性分析」頁面的使用者查看及執行已儲存的查詢，請啟用「與專案共用」切換鈕。 Google Cloud

   根據預設，這個切換按鈕會停用，且只有你能查看。

5. 按一下 [Save query] (儲存查詢)。

6. 選用：如要查看、排序及執行您可見的已儲存查詢，請選取「已儲存」分頁標籤。

   您可以依據名稱、說明和顯示狀態標籤，排序及篩選已儲存的查詢。你也可以依查詢內容篩選。

如要編輯及刪除您建立的查詢，請使用「已儲存」分頁中的選項：

• 如要編輯查詢，請按一下「更多選項」，然後選取「編輯」。 您可以修改「名稱」和「說明」欄位的值，但無法修改查詢本身。

• 如要刪除已儲存的查詢，請按一下「更多選項」，然後選取「刪除」。

REST

您可以使用 Cloud Logging API 儲存查詢。如要儲存查詢，請使用 savedQueries.create 方法。

如要執行這個方法，請按照下列步驟操作：

1. 選取 savedQueries.create。
2. 在參考頁面上，使用 APIs Explorer 發出指令。您必須指定 opsAnalyticsQuery 欄位。

下列範例說明範例要求主體，其中包含 SavedQuery 的例項：

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

共用查詢

您可以與所有有權存取Google Cloud 專案的使用者分享已儲存的查詢。不過，主體的 IAM 角色會決定查詢是否可以執行，以及查詢傳回的資料。

控制台

排解問題或發現異常結果時，您可能想與隊友分享查詢和結果。在「可觀測性分析」頁面查看查詢結果時，您可以複製網址，開啟該網址即可顯示您執行的查詢及其結果。

如要與隊友共用查詢和結果，請按照下列步驟操作：

1. 在 Google Cloud 控制台中，前往 「Log Analytics」(記錄檔分析) 頁面：

   前往「Log Analytics」(記錄檔分析)

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

2. 在「Query」(查詢) 窗格中填入查詢，然後按一下「Run query」(執行查詢)。

   您可以輸入新查詢、從「近期」分頁選取查詢，或從「已儲存」分頁選取查詢，藉此填入「查詢」窗格。

3. 按一下「分享連結」圖示 。

4. 將連結傳送給隊友。

   當隊友開啟連結時，系統會開啟「可觀測性分析」頁面並顯示查詢，但不會執行查詢。隊友必須手動執行查詢。

   如果查詢在 BigQuery 引擎上執行，且查詢的資源不在同一個擁有權界線內，可觀測性分析頁面會顯示警告對話方塊。擁有權界線取決於多項因素，其中一項是查詢使用的資源階層。

   如要順利開啟網址，您隊友在 Google Cloud 專案中的 IAM 角色必須包含查看「可觀測性分析」頁面所需的權限。

REST

您可以使用 Logging API 的 savedQueries.Create 方法建立共用查詢，並在 visibility 欄位中指定 SHARED 值。詳情請參閱 savedQueries.create 的參考頁面。

查看及執行近期或已儲存的查詢

如要查看或重新執行查詢，請選取「Observability Analytics」(可觀測性分析) 頁面上的「最近」分頁標籤，然後找出查詢：

• 點選「執行」執行查詢。
• 如要查看查詢，請使用「 更多選項」選單中的選項。

如要查看、編輯或執行已儲存的查詢，請選取「可觀測性分析」頁面上的「已儲存」分頁，然後找出查詢：

• 點選「執行」執行查詢。
• 如要編輯、查看或刪除查詢，請使用「更多選項」選單中的選項。

後續步驟

• 圖表 SQL 查詢結果。
• SQL 查詢示例。
• 在 BigQuery 中查詢連結的資料集。