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

本文档介绍了您可以添加到自定义信息中心的微件 以便在与数据库服务器相同的环境中查看日志和错误数据 指标数据。“日志”面板 widget 会显示日志条目。错误报告面板微件 显示最近的错误组。以上两者皆可 微件可提供在问题排查时可能有用的信息。 Log Analytics 图表 widget 用于显示 SQL 查询的结果,可帮助您发现日志数据中的趋势。

日志浏览器和日志面板微件

日志浏览器是调查日志的标准方式。 向信息中心添加日志面板微件不会改变您使用日志浏览器的方式。由于日志面板微件可以添加到自定义信息中心,因此您可以通过这些微件在与指标相同的上下文中查看日志条目。

日志浏览器和日志面板 widget 支持相同的查询语言,并且它们都仅显示您有权查看的日志条目。您在存储日志条目的资源上的 Identity and Access Management (IAM) 角色决定了您能否查看存储的日志条目。

日志浏览器和日志面板微件都预先配置为 搜索默认日志范围中列出的资源 。如果无法访问该范围,则会搜索源自您所选项目的日志条目。选择项目后,搜索结果将包括 由接收器路由到项目的日志条目 然后存储在日志存储桶中。 您可以配置系统在搜索日志条目时要搜索哪些资源。例如: 您可以按日志视图搜索日志条目。

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

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

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

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

准备工作

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

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

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

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

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

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

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

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

    前往信息中心

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

  2. 选择一个信息中心或点击创建信息中心
  3. 在工具栏中,点击  添加微件
  4. Add widget 对话框中,选择  Logs
  5. 可选:如需更新标题,请在微件标题字段中输入新标题。
  6. 配置要在哪些资源中搜索日志条目:

    • 要按项目搜索,请将 Scope by 条目设置为 Project, 然后展开 Projects 条目并完成对话框。

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

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

    • 日志视图搜索日志条目 针对日志存储分区,将范围限定依据条目设置为存储,然后 展开存储视图条目,然后完成对话框。

      存储视图菜单列出了以下集群中日志存储分区的日志视图 您选择的 Google Cloud 项目

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

    • 要搜索 日志范围、 其中包括项目和日志视图 将范围依据条目设置为日志范围,然后 展开日志范围条目,然后选择一个日志范围。

      日志作用域目前处于公开预览版阶段。

  7. 可选:如需限制日志面板微件显示的日志,请在查询编辑器字段中输入查询;如果您已停用自动运行查询,请点击运行查询。如需简要了解查询,请参阅查询示例

  8. 可选:将模板变量应用于“日志”面板 widget。有关 请参阅 对 widget 应用永久过滤条件

  9. 要将更改应用到信息中心,请在工具栏中执行以下操作: 点击应用。如需舍弃更改,请点击取消

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

    “日志”面板微件会显示日志条目表格。 您还可以使用微件的过滤栏暂时更改微件显示的日志条目。有关详情, 过滤日志条目

查询示例

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

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

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

通过资源菜单,您可以按资源过滤。您可以选择 某个资源类型(例如 Audited Resource) 窗口来选择特定方法。

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

  1. 展开资源菜单。
  2. 搜索并选择已审核的资源
  3. 点击应用

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

    resource.type="audited_resource"
    

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

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

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

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

过滤日志条目

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

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

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

  • 日志面板微件上的严重性菜单:按严重性等级进行过滤 将在查询完成后应用系统会保留此字段的值 仅限当前会话使用

  • 针对日志面板微件的查询:日志面板微件会显示 系统仅显示与查询匹配的日志条目 如果您不指定查询 所选的时间间隔如果您指定了查询 日志面板微件会显示一个显示查询 图标,将当前查询以提示的形式显示。

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

  • 日志面板微件上的 Google Cloud 项目:如需修改此设置,请执行以下操作: 修改日志面板 widget。

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

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

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

如需在日志面板微件中显示最新日志,请使用时间字段 。 例如,选择 1 小时。如果您未选择自定义时间范围,该微件会始终显示最新的日志,即使它们早于所选时间范围也是如此。

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

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

指定时间间隔后,系统不会自动显示日志面板微件 刷新。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

除了使用“Log Analytics”页面配置和保存图表外 信息中心,您可以保存 Log Analytics 图表 直接在 Monitoring 中执行以下操作:

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

    前往信息中心

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

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

    显示面板中,您可以更改图表类型和自定义图表类型, 通过更改维度、测量值和 细分:

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

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

    • 细分维度: 要根据另一列将单个数据系列拆分为多个数据系列,请添加细分。

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

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

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

在信息中心显示错误

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

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

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

    前往信息中心

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

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

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

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

      • 要显示特定 App Engine 服务的错误,请选择 GAE 服务,选择相应服务,然后点击应用

  8. 要将更改应用到信息中心,请在工具栏中执行以下操作: 点击应用。如需舍弃更改,请点击取消

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

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

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

问题排查

后续步骤