在自定义信息中心内显示日志和错误

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

本文档介绍了您可以添加到自定义信息中心的 widget，以便您可以在与指标数据相同的上下文中查看日志和错误数据。日志面板 widget 会显示日志条目。错误报告面板 widget 会显示最近的错误组。这两个 widget 都提供了在排查问题时可能有用的信息。Log Analytics 图表 widget 会显示 SQL 查询的结果，可让您确定日志数据中的趋势。

此功能仅适用于 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。

Logs Explorer 和日志面板 widget

Logs Explorer 是调查日志的标准方法。将日志面板 widget 添加到信息中心不会改变您使用 Logs Explorer 的方式。由于日志面板 widget 可以添加到自定义信息中心，因此它们提供了一种方法以便在与指标相同的上下文中查看日志条目。

Logs Explorer 和日志面板 widget 支持相同的查询语言，并且它们都仅显示您有权查看的日志条目。您对存储日志条目的资源所拥有的 Identity and Access Management (IAM) 角色决定了您是否可以查看存储的日志条目。

Logs Explorer 和日志面板 widget 都预配置为在默认日志范围内列出的资源中搜索日志条目。如果无法访问该范围，则会搜索源自您所选项目的日志条目。当选择一个项目时，搜索结果将包含由另一个项目中的接收器路由到该项目，然后存储在日志存储桶中的日志条目。您可以配置在哪些资源中搜索日志条目。例如，您可以按日志视图搜索日志条目。

日志面板 widget 每行显示一个日志条目，其中包含与日志条目的严重级别、时间戳和摘要对应的列。如需查看日志条目的 JSON 格式表示形式，请点击查看日志详情按钮。每个条目摘要的结构因日志类型而异。例如，下图展示了两个日志条目：

在上图中，第一个日志条目显示服务请求的相关信息。摘要显示服务相关信息、电子邮件地址以及条目的 JSON 结构字符串格式版本。第二个条目显示请求结果，并且仅显示一个句子来总结所发生的操作。

如需了解有关 Cloud Logging 的一般信息，请参阅以下资源：

• 基本概念
• 日志记录查询语言
• 日志浏览器

准备工作

在您希望在自定义信息中心查看日志的 Google Cloud 项目中，请完成以下操作：

• 如需获得所需权限以便使用 Google Cloud 控制台向自定义信息中心添加日志面板 widget 并将其配置为显示项目或日志视图中的日志条目，请让管理员向您授予以下 IAM 角色：

  • 您的项目的 Monitoring Editor (roles/monitoring.editor)。
  • 您要查看其日志条目的每个项目的 Logging Viewer (roles/logging.viewer)。此角色不会向您授予对所有日志条目的访问权限。如需详细了解这些角色，请参阅使用 IAM 进行访问权限控制。
  • 为您要访问的日志视图存储日志存储桶的每个项目的 Logs View Accessor (roles/logging.viewAccessor)。Logs View Accessor 角色可授予对项目存储的所有日志视图的访问权限。如需了解如何获取对特定日志视图的访问权限，请参阅控制对日志视图的访问权限。

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

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

在信息中心上显示日志条目

本部分介绍如何使用 Google Cloud 控制台添加和配置日志面板 widget。如需了解如何使用 Cloud Monitoring API，请参阅包含 LogsPanel 微件的信息中心。

信息中心最多可容纳 100 个 widget。

如需使用控制台将日志面板 widget 添加到信息中心，请执行以下操作：

1. 在 Google Cloud 控制台中，前往  信息中心页面：

   前往信息中心

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
3. 选择一个信息中心或点击创建信息中心。
4. 在工具栏中，点击 add 添加 widget。
5. 在添加 widget 对话框中，选择  日志。
6. 可选：如需更新名称，请在 widget 名称字段中输入新名称。

7. 配置在哪些资源中搜索日志条目：

   • 如需按项目搜索，请将范围选择条目设置为项目，然后展开项目条目并完成对话框。

     项目菜单会列出当前指标范围内的所有 Google Cloud 项目。如果菜单中的某个条目包含文本“您没有项目级权限，不可查看此项目中的日志”，则表示您没有权限查看该 Google Cloud 项目中可用的日志条目。

     显示的日志条目包括源自您的Google Cloud 项目以及由其他项目中的接收器路由到您的Google Cloud 项目的日志条目。

   • 如需按日志存储桶的日志视图搜索日志条目，请将范围选择条目设置为存储，然后展开存储视图条目并完成对话框。

     存储视图菜单会列出所选 Google Cloud 项目中的日志存储桶的日志视图。

     如需选择其他 Google Cloud 项目中的日志存储桶的日志视图，请在菜单中点击 add_circle 导入项目，选择一个项目，然后选择一个或多个日志视图。您只能导入当前指标范围内包含的项目。

   • 如需搜索日志范围（可包含项目和日志视图）中包含的资源，请将范围选择条目设置为日志范围，然后展开日志范围条目并选择一个日志范围。

8. 可选：如需限制日志面板 widget 显示的日志，请在查询编辑器字段中输入查询，如果您已停用自动运行查询的功能，请点击运行查询。如需简要了解查询，请参阅查询示例。

9. 可选：将变量应用于日志面板 widget。

   您可以更新 widget 的查询，使其依赖于变量，以便在您更改变量的值时，widget 显示的数据也随之更改。您还可以使用变量来控制 widget 的可见性。有关详情，请参阅以下文档：

   • 设置 widget 的可见性
   • 更新 widget 的查询

10. 如需将更改应用于信息中心，请在工具栏中点击应用。如需舍弃更改，请点击取消。

11. 如需保存修改后的信息中心，请在工具栏中点击保存。

    日志面板 widget 会显示日志条目表格。您还可以使用该 widget 的过滤条件栏暂时更改该 widget 显示的日志条目。如需了解详情，请参阅标题为过滤日志条目的部分。

查询示例

要填充查询编辑器字段，您可以在字段中输入文本，也可以从菜单中选择。查询编辑器字段使用与日志浏览器相同的查询语言。如需了解问题排查信息，请参阅语法问题。

严重级别和日志名称菜单允许您选择多个选项。以下是与多个严重级别匹配的查询语句示例：

severity=(WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY)

您可以使用资源菜单按资源进行过滤。您可以选择资源类型（例如已审核的资源），也可以浏览窗口以选择特定方法。

例如，如需针对已审核的资源添加查询，请执行以下操作：

1. 展开资源菜单。
2. 搜索并选择已审核的资源。

3. 点击应用。

   这些步骤会将以下子句添加到查询编辑器字段中：

   resource.type="audited_resource"
   

同样，如需针对 Cloud Run functions 审核日志添加查询，请执行以下操作：

1. 展开资源菜单。
2. 搜索并选择已审核的资源。
3. 在服务菜单中，选择 Cloud Functions。

4. 点击应用。

   这些步骤会将以下子句添加到查询编辑器字段中：

   resource.type="audited_resource" resource.labels.service="cloudfunctions.googleapis.com"
   

过滤日志条目

您可以通过修改以下字段或菜单的值来修改日志面板 widget 显示的日志条目：

• 信息中心时间选择器：日志面板 widget 仅检索在此字段中指定的时间间隔内写入的日志条目。

• 日志面板 widget 上的过滤条件字段：在查询完成后，系统会应用您指定的过滤条件。此字段的值仅在当前会话中保留。

• 日志面板 widget 上的严重级别菜单：在查询完成后，系统会按严重级别进行过滤。此字段的值仅在当前会话中保留。

• 日志面板 widget 上的查询：日志面板 widget 仅显示与查询匹配的日志条目。如果您未指定查询，系统会显示所选时间间隔内的所有日志。如果您指定了查询，日志面板 widget 会显示显示查询图标，该图标会以提示形式显示当前查询。

  如需修改查询，请修改日志面板 widget。

• 日志面板 widget 上的Google Cloud 项目：如需修改此设置，请修改日志面板 widget。

• 信息中心过滤条件：如果存在信息中心过滤条件，过滤条件设置会应用于日志面板 widget 的查询。例如，如果您添加信息中心过滤条件 cluster_name: mycluster，则查询会更新为包含 resource.labels."cluster_name"="mycluster"。如需详细了解信息中心过滤条件，请参阅添加临时过滤条件和添加永久过滤条件。

本部分的其余内容提供了有关如何过滤日志条目的更多信息。

示例：按日期过滤日志条目

如需在日志面板 widget 中显示最近的日志，请使用信息中心工具栏中的时间字段。例如，选择 1 小时。如果您未选择自定义时间范围，widget 会始终显示最新的日志，即使它们早于所选时段也是如此。

调查突发事件时，您可能希望将日志条目限制为特定时间段内的条目。要将日志条目配置为显示固定时间段内的日志，请执行以下一项或两项操作：

• 使用时间范围选择器选择时间范围。
• 在配置窗格的查询编辑器字段中输入 timestamp 子句，然后选择应用过滤条件。

指定时间间隔后，日志面板 widget 不会自动刷新。

示例：按严重级别过滤日志条目

在监控对失败情况的调试时，您可能只想查看错误消息，并在显示结果中隐藏所有其他日志条目。如需将日志面板 widget 配置为仅显示满足特定严重级别的日志条目，请执行以下一项或两项操作：

• 如需应用临时过滤条件，请在日志面板 widget 中为严重级别菜单选择一个值。此菜单指定最低严重级别。例如，“警告”值会使系统检索严重级别为“错误”的日志条目，但不会检索严重级别为“通知”的日志条目。默认情况下，此字段的值设置为 Default，即包括所有日志条目。

  当您离开信息中心时，严重级别菜单的设置将被舍弃。

• 如需应用永久过滤条件，请在配置窗格的查询编辑器字段中输入 severity 子句，然后选择应用过滤条件。

示例：按字符串或短语过滤日志条目

通过按特定字符串或短语过滤日志条目，您可以从视图中排除不感兴趣的日志条目。例如，如需查看包含特定电子邮件地址的日志条目，您可以按该地址进行过滤。

• 如需应用临时过滤条件以仅查看包含特定字词或短语的日志条目，请使用 filter_list 过滤条件字段。include-test 不区分大小写。

  如果您添加多个过滤条件，则仅显示匹配所有过滤条件的日志，因为相邻过滤条件之间插入了隐式 AND。但是，您可以明确插入 OR 运算符：

  • 例如，如果添加过滤条件 Get 和 Compute，将显示同时包含这两个字词的日志条目。

  • 例如，如果添加过滤条件 Get、OR 和 Compute，将显示包含 Get 或 Compute 的日志条目。

  filter_list 过滤条件字段的值不是永久的。

• 如需应用永久过滤条件，请修改存储在查询编辑器字段中的查询，然后选择应用过滤条件。如需了解查询语法，请参阅 Logging 查询语言。

  例如，如需仅显示 MESSAGE 字段包含字符串“lamp”的日志条目，请将子句 jsonPayload.MESSAGE:"lamp" 添加到查询编辑器 字段。

在日志浏览器中查看日志条目

日志面板 widget 会显示日志条目的关键字段，而不显示完整的日志条目。如需检查日志条目的所有字段，请执行以下操作：

1. 在日志面板 widget 中，选择在 Logs Explorer 中查看。

2. 在对话框中，选择要在其中打开 Logs Explorer 的 Google Cloud 项目。

   Logs Explorer 会在新的浏览器标签页中打开，并自动应用您在日志面板 widget 中选择的过滤条件。

3. 选择要查看的日志条目。

显示通过 Log Analytics 查询生成的图表

本部分介绍如何配置通过 Log Analytics 查询生成的图表，并将其保存到自定义信息中心。借助 Log Analytics，您可以使用 SQL 查询搜索和汇总日志，以便生成有用的分析洞见。

除了使用 Log Analytics 页面配置图表并将其保存到信息中心之外，您还可以通过执行以下操作，直接将 Log Analytics 图表保存到 Monitoring 中：

1. 在 Google Cloud 控制台中，前往  信息中心页面：

   前往信息中心

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
3. 选择一个信息中心或点击创建信息中心。
4. 在工具栏中，点击 add 添加 widget。
5. 在添加 widget 对话框中，前往数据部分，然后选择 Log Analytics。

6. 在配置 widget 对话框中，配置要显示的数据，然后点击运行查询。

   如需选择要显示的数据，您可以构建 SQL 查询，也可以选择已保存的查询或最近的查询。您可以查询的日志视图和分析视图会在视图和架构部分中列出。点击某个数据源时，系统会在架构标题下显示该数据源的字段列表。

7. 可选：在结果标签页中，使用显示面板自定义图表配置。

   在显示面板中，您可以更改图表类型，并通过更改维度、测量和细分来自定义要绘制成图表的行和列：

   • 维度：维度必须是时间戳、数值或字符串列。默认情况下，维度会设置为架构中的第一个基于时间戳的列。如果查询中不存在时间戳，则系统会选择第一个字符串列作为维度。您还可以在图表显示面板中自定义维度。选择时间戳列作为维度后，图表会显示数据随时间的变化情况。选择字符串列作为条形图的维度后，您可以按升序或降序对数据进行排序，这会按词序对维度进行排序。您也可以保留“默认”排序顺序，该顺序会根据相应测量的值按降序对维度进行排序。

   • 测量：您可以在图表显示面板中选择多个测量。选择测量时，您还必须选择要对其分组值执行的聚合函数，例如 count、sum、average 和 percentile-99。例如，count-distinct 会返回给定列中的唯一值数量。

   • 细分：如需根据其他列将单个数据系列拆分为多个数据系列，请添加细分。

   如需详细了解如何自定义图表配置，请参阅自定义图表配置。

8. 如需保存修改后的信息中心，请在工具栏中点击保存。

将 Log Analytics 图表保存到信息中心后，也可以对其进行修改。 如需了解详情，请参阅修改 widget 的配置。

在信息中心内显示错误

本部分介绍了如何使用 Google Cloud 控制台添加和配置错误报告面板。如需了解如何使用 Cloud Monitoring API 将错误报告面板添加到信息中心，请参阅包含 ErrorReportingPanel widget 的信息中心。

如需使用控制台将错误报告面板添加到信息中心，请执行以下操作：

1. 在 Google Cloud 控制台中，前往  信息中心页面：

   前往信息中心

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。对于 App Hub 配置，请选择 App Hub 宿主项目或已启用应用的文件夹的管理项目。
3. 选择一个信息中心或点击创建信息中心。
4. 在工具栏中，点击 add 添加 widget。
5. 在添加 widget 对话框中，前往可视化部分，然后选择 Error Reporting 面板。
6. 选择要显示其错误组的项目，展开 arrow_drop_down 项目，然后进行选择。
7. 可选：更新标题。

8. 可选：如需限制显示其相关错误的资源，请执行以下操作：

   1. 展开 arrow_drop_down 所有资源，然后选择一个资源。

   2. 选择资源后，您可以选择应用，也可以使用其他菜单来细化过滤条件：

      • 如需显示 App Engine 资源的错误，请选择 GAE 服务，然后点击应用。

      • 如需显示特定 App Engine 服务的错误，请选择 GAE 服务，选择相应服务，然后点击应用。

9. 如需将更改应用于信息中心，请在工具栏中点击应用。如需舍弃更改，请点击取消。

   以下示例展示了错误报告面板：

   

10. 如需保存修改后的信息中心，请在工具栏中点击保存。

问题排查

• 日志面板表明其显示部分数据
• 日志面板报告无效查询
• 日志面板显示“找不到条目”消息

后续步骤

• 如需了解 Cloud Monitoring 如何使您可以查看存储在多个 Google Cloud 项目中的指标和日志，请参阅指标范围概览。

• 如需了解如何使用 API 配置信息中心以显示日志或错误，请参阅以下内容：

  • 包含 LogsPanel widget 的信息中心。
  • 包含 ErrorReportingPanel widget 的信息中心。

• 如需详细了解错误组，请参阅 Error Reporting 概览。