保存或共享 SQL 查询

本文档介绍了如何保存和共享您在 Log Analytics 中创建的查询。

如需了解如何绘制查询图表或查看查询示例,请参阅本文档的后续步骤部分中列出的文档。

准备工作

  1. 登录您的 Google Cloud 账号。如果您是 Google Cloud新手,请 创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
  2. 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.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. 启用 Observability API。

    启用 API 所需的角色

    如需启用 API,您需要拥有 Service Usage Admin IAM 角色 (roles/serviceusage.serviceUsageAdmin),该角色包含 serviceusage.services.enable 权限。了解如何授予角色

    启用 API

  5. 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.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. 启用 Observability API。

    启用 API 所需的角色

    如需启用 API,您需要拥有 Service Usage Admin IAM 角色 (roles/serviceusage.serviceUsageAdmin),该角色包含 serviceusage.services.enable 权限。了解如何授予角色

    启用 API

  8. 如需获得加载 Log Analytics 页面、编写、运行和保存私密查询所需的权限,请让管理员为您授予以下 IAM 角色:

    • Observability View Accessor (roles/observability.viewAccessor) 在您要查询的可观测性视图上。此角色支持 IAM 条件,可让您将授予的权限限制为仅针对特定视图。如果您未为角色授予附加条件,则正文可以访问所有可观测性视图。可观测性视图目前为公开预览版。
    • 针对项目的 Observability Analytics User (roles/observability.analyticsUser)。此角色包含保存和运行专用查询以及运行共享查询所需的权限。
    • 项目的 Logs Viewer (roles/logging.viewer) 角色。
    • 存储您要查询的日志视图的项目的 Logs View Accessor (roles/logging.viewAccessor)。

    如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

保存查询

您运行的所有查询都会自动保存 30 天,您可以通过选择 Log Analytics 页面上的最近标签页来访问这些查询。您可以搜索、查看、运行和共享最近标签页中列出的查询。

如果您想保留查询以供将来使用,请使用对您有用的信息为其添加注解,或让团队成员查看和运行您的查询,然后保存查询。您可以按名称、说明和公开范围标签搜索和排序已保存的查询。您还可以修改和删除这些查询。您保存的查询会保留,直到您将其删除。

您可以为每个 Google Cloud 项目保存 10,000 个查询。

控制台

如需保存查询,请执行以下操作:

  1. 在 Google Cloud 控制台中,前往 Log Analytics 页面:

    转到 Log Analytics

    如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。

  2. 使用查询填充查询窗格。

    您可以通过以下方式填充查询窗格:输入新查询、从最近标签页中选择查询或是从已保存标签页中选择查询。

    您的查询可以包含任意有效视图、多个视图和分析视图

    查询窗格中的查询有效时, 保存会处于启用状态。

  3. 点击 保存,选择保存查询,然后填写名称说明字段。您为这些字段设置的值会显示在已保存标签页上。

  4. 可选:如需让所有有权访问 Google Cloud 项目的 Log Analytics 页面的用户都能查看和运行已保存的查询,请启用与项目共享切换开关。

    默认情况下,此切换开关处于停用状态,仅您可查看相应数据。

  5. 点击保存查询

  6. 可选:如需查看、排序和运行您可查看的已保存查询,请选择已保存标签页。

    您可以按名称、说明和公开范围标签对已保存的查询进行排序和过滤。您还可以按查询内容进行过滤。

您可以使用已保存标签页上的选项修改和删除自己创建的查询:

  • 如需修改查询,请点击 更多选项,然后选择修改。您可以修改名称说明字段的值;但无法修改查询本身。

  • 如需删除已保存的查询,请点击 更多选项,然后选择删除

共享查询

您可以与有权访问您的Google Cloud 项目的所有用户共享已保存的查询。不过,主账号的 IAM 角色决定了查询是否可以运行以及查询返回的数据。

控制台

在排查问题或看到异常结果时,您可能需要与团队成员共享查询及其结果。在 Log Analytics 页面上查看查询结果时,您可以复制一个网址,该网址在打开后会显示您运行的查询及其结果。

如需与团队成员共享查询和结果,请执行以下操作:

  1. 在 Google Cloud 控制台中,前往 Log Analytics 页面:

    转到 Log Analytics

    如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。

  2. 查询窗格中填充查询,然后点击运行查询

    您可以通过以下方式填充查询窗格:输入新查询、从最近标签页中选择查询或是从已保存标签页中选择查询。

  3. 点击 共享链接

  4. 将链接发送给您的团队成员。

    您的团队成员打开链接后,系统会打开 Log Analytics 页面并显示查询,但不会运行查询。您的队友必须手动运行查询。

    当查询在 BigQuery 引擎上运行,且查询的资源不在同一所有权边界内时,Log Analytics 页面会显示警告对话框。所有权边界由多种因素决定,其中一个因素是查询所用资源的层次结构。

    如需成功打开该网址,您的团队成员在 Google Cloud 项目中的 IAM 角色必须包含查看 Log Analytics 页面所需的权限。

查看和运行最近或已保存的查询

如需查看或重新运行查询,请选择 Log Analytics 页面上的最近标签页,然后找到相应查询:

  • 如需运行查询,请点击运行
  • 如需查看查询,请使用 更多选项菜单中的选项。

如需查看、修改或运行已保存的查询,请选择 Log Analytics 页面上的已保存标签页,然后找到相应查询:

  • 如需运行查询,请点击运行
  • 如需修改、查看或删除查询,请使用 更多选项菜单中的选项。

后续步骤