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

本文档介绍了您可以添加到自定义信息中心的微件,以便在与指标数据相同的上下文中查看日志和错误数据。日志面板微件会显示日志条目。错误报告面板微件会显示最新的错误组。这两个 widget 提供的信息都可能对进行问题排查有所帮助。日志分析图表微件用于显示 SQL 查询结果,可让您识别日志数据中的趋势。

日志浏览器和日志面板 widget

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

日志浏览器和日志面板微件支持相同的查询语言,并且都仅显示您有权查看的日志条目。您在存储所提取日志条目的资源中的 Identity and Access Management (IAM) 角色将用于确定您是否可以查看这些日志条目。

日志浏览器和日志面板 widget 都已预先配置为从日志存储分区中提取源自当前 Google Cloud 项目的日志条目或路由到当前项目的日志条目。您可以配置提取哪些日志条目。例如,您可以指定从日志视图提取日志条目以显示。

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

日志面板 widget 中两个日志条目的图片。

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

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

准备工作

如需获取使用 Google Cloud 控制台将日志面板微件添加到自定义信息中心所需的权限,并将其配置为在项目或日志视图中显示日志条目,请让管理员授予您以下 IAM 角色:

如需详细了解如何授予角色,请参阅管理访问权限

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

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

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

日志面板 widget 已预先配置为提取来自 Google Cloud 项目的日志条目以及路由到 Google Cloud 项目的日志条目。但是,您可以配置日志面板微件从日志存储分区提取哪些日志条目。例如,您可以将该微件配置为仅显示指示某类错误条件的日志条目,或仅显示日志视图中的日志条目。

信息中心最多可容纳 40 个微件。

如需使用控制台将日志面板微件添加到信息中心,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 信息中心页面:

    前往信息中心

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

  2. 选择一个信息中心,或点击创建信息中心
  3. 在工具栏中,点击  添加微件
  4. Add widget 对话框中,选择  Logs
  5. 可选:如需更新标题,请在微件标题字段中输入新标题。
  6. 可选:如需修改提取哪些日志条目,请执行以下操作之一:

    • 如需从其他项目或多个项目提取日志条目,请在 Project 条目中展开 Current project,然后完成对话框。该菜单列出了当前指标范围内的所有 Google Cloud 项目。

      如果菜单中的条目包含文本“您没有查看此项目中的日志的项目级权限”,则表示您没有查看该 Google Cloud 项目的日志条目所需的权限。

    • 如需提取日志存储分区的日志视图中包含的日志条目,请执行以下操作:

      1. 限定范围条目中,展开 项目,然后选择存储
      2. 存储视图条目中,展开 当前项目,然后完成对话框。该菜单会列出 Google Cloud 项目中日志存储分区的日志视图。如需选择其他 Google Cloud 项目中的日志存储分区的日志视图,请在菜单中点击 导入项目,选择一个项目,然后选择一个或多个日志视图。您只能导入当前指标范围中包含的项目。
  7. 可选:如需限制日志面板 widget 显示的日志,请在查询编辑器字段中输入查询,如果您禁止自动运行查询,则点击运行查询。有关查询的简要介绍,请参阅查询示例

  8. 可选:将模板变量应用于日志面板 widget。如需了解详情,请参阅向自定义信息中心添加永久过滤条件

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

  10. 要保存修改后的信息中心,请点击工具栏中的保存

    日志面板 widget 会显示一个表,其中包含已提取且与您的查询匹配的日志条目。您还可以使用微件的过滤栏临时更改微件显示的日志条目。如需了解详情,请参阅过滤日志条目部分。

查询示例

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

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

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

通过资源菜单,您可以按资源过滤。您可以选择资源类型(例如已审核的资源),也可以浏览窗口以选择特定方法。

例如,如需添加针对 Audited Resource 的查询,请执行以下操作:

  1. 展开资源菜单。
  2. 搜索并选择 Audited Resource
  3. 点击应用

    以下步骤会将以下子句添加到查询编辑器字段:

    resource.type="audited_resource"
    

同样,如需为 Cloud Functions 审核日志添加查询,请执行以下操作:

  1. 展开资源菜单。
  2. 搜索并选择 Audited Resource
  3. 在“服务”菜单中,选择 Cloud Functions
  4. 点击应用

    以下步骤会将以下子句添加到查询编辑器字段:

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

过滤日志条目

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

  • 信息中心时间选择器:日志面板微件仅检索按此字段指定的时间间隔写入的日志条目。

  • 过滤条件字段:您指定的过滤条件将在查询完成后应用。系统仅会在当前会话中保留此字段的值。

  • 日志面板微件上的严重性菜单:查询完成后,系统会应用按严重性级别的过滤条件。系统仅会在当前会话期间保留此字段的值。

  • 针对日志面板 widget 的查询:日志面板 widget 仅显示与查询匹配的日志条目。如果未指定查询,系统会显示所选时间间隔内的所有日志。如果您指定了查询,则日志面板 widget 会显示一个显示查询图标,该图标会将当前查询显示为提示。

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

  • 日志面板微件上的 Google Cloud 项目:如需修改此设置,请修改日志面板微件。

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

本部分的其余内容详细介绍了如何过滤日志条目。

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

如需在日志面板微件中显示最新日志,请使用信息中心工具栏中的时间字段。例如,选择 1 小时。如果您没有选择自定义时间范围,该 widget 始终会显示最新的日志,即使这些日志早于所选时间范围的日志也是如此。

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

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

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

示例:按严重性过滤日志条目

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

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

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

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

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

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

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

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

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

    • 例如,如果添加过滤条件 GetORCompute,将显示包含 GetCompute 的日志条目。

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

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

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

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

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

  1. 在日志面板微件中,选择在日志浏览器中查看
  2. 在对话框中,选择要在其中打开日志浏览器的 Google Cloud 项目。

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

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

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

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

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

  1. 在 Google Cloud 控制台中,转到 信息中心页面:

    前往信息中心

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

  2. 选择一个信息中心,或点击创建信息中心
  3. 在工具栏中,点击  添加微件
  4. 添加微件对话框中,转到数据部分,然后选择 Log Analytics
  5. 配置微件面板中,使用 SQL 构建查询来配置要在图表上显示的数据,然后点击运行查询
  6. 可选:在结果标签页中,使用显示面板自定义图表配置。

    显示面板中,您可以更改图表类型,还可以通过更改维度、度量和细分来自定义图表中的哪些行和列:

    • 维度:维度必须是时间戳、数字或字符串列。默认情况下,该维度设置为架构中基于时间戳的第一个列。如果查询中未显示时间戳,则会选择第一个字符串列作为维度。您还可以在图表显示面板中自定义维度。选择时间戳列作为维度后,图表会显示数据随时间变化的情况。

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

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

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

  7. 要保存修改后的信息中心,请点击工具栏中的保存

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

在信息中心显示错误

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

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

  1. 在 Google Cloud 控制台中,转到 信息中心页面:

    前往信息中心

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

  2. 选择一个信息中心,或点击创建信息中心
  3. 在工具栏中,点击  添加微件
  4. 添加微件对话框中,转到可视化部分,然后选择 Error Reporting 面板
  5. 选择显示其错误组的项目,展开 Projects,然后进行选择。
  6. 可选:更新标题。
  7. 可选:如需限制显示错误的资源,请执行以下操作:

    1. 展开 所有资源,然后选择一项资源。
    2. 选择资源后,您可以选择应用,也可以使用其他菜单来优化过滤条件:

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

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

  8. 如需将更改应用到信息中心,请在工具栏中点击 Apply。如需舍弃更改,请点击取消

    以下示例展示了一个错误报告面板:

    错误报告面板配置窗格的示例。

  9. 要保存修改后的信息中心,请点击工具栏中的保存

问题排查

后续步骤