配置失败工作流调用的提醒

本文档介绍如何使用日志浏览器为失败的 Dataform 工作流调用配置基于日志的提醒。

您可以使用 Cloud Monitoring 观察 Dataform 工作流调用的 Cloud Logging 日志趋势，并在出现您描述的条件时通知您。

每个 Dataform 工作流调用都使用 Cloud Logging 进行记录。系统会自动为 Dataform 工作流调用启用 Logging，这可能会产生 Cloud Logging 结算费用。如需了解详情，请参阅 Dataform 价格。

如需在 Dataform 工作流调用失败时收到提醒，您可以创建基于日志的提醒。

您可以通过 Google Cloud 控制台的日志浏览器页面或使用 Monitoring API 创建基于日志的提醒。本指南介绍如何使用日志浏览器为 Dataform 工作流调用失败创建基于日志的提醒。

准备工作

如需创建和管理基于日志的提醒，请确保您的 Identity and Access Management 角色包含基于日志的提醒的权限中所述的权限。

为失败的 Dataform 工作流调用配置基于日志的提醒

如需为失败的 Dataform 工作流调用配置基于日志的提醒，请按以下步骤操作：

  1. 在 Google Cloud 控制台中，选择 Logging，然后选择 Logs Explorer：

    转到 Logs Explorer

  2. 在查询窗格中，选择显示查询并输入以下查询：

        resource.type="dataform.googleapis.com/Repository"
    jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
    jsonPayload.terminalState="FAILED"

    此查询会提醒您所有失败的 Dataform 工作流调用。

    1. 可选：如需按版本配置过滤失败的工作流调用，请将以下内容附加到查询：

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. 可选：如需按工作流配置过滤失败的工作流调用，请将以下内容附加到查询：

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    当与 daily 版本配置和 production 工作流配置相关的 Dataform 工作流调用失败时，以下查询会发出提醒：

     resource.type="dataform.googleapis.com/Repository"
 jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
 jsonPayload.terminalState="FAILED"
 jsonPayload.releaseConfigId="daily"
 jsonPayload.workflowConfigId="production"

  3. 可选：使用查询结果窗格中的运行查询来验证查询。

  4. 在查询结果窗格的标题中，点击创建提醒。当您的窗口很窄时，创建提醒选项可能改为显示在操作菜单上。

  5. 在提醒详情窗格中，为提醒指定名称和说明：

    1. 在提醒名称字段中输入提醒的名称。例如：“Dataform:工作流失败”。

    2. 输入此提醒的说明。您也可以添加有助于通知接收人诊断问题的信息。 以下字符串总结了发出提醒的原因：

      Log-based alert in project ${project} detected a failed Dataform workflow.

      如需详细了解如何设置此字段格式并定制其内容，请参阅在文档模板中使用 Markdown 和变量。

  6. 要前进到下一步，请点击下一步。

  7. 在选择要包含在提醒中的日志窗格中，点击预览日志以检查查询和结果。

    我们建议在日志浏览器查询窗格中构建查询。您在 Query 窗格中构建的查询也会显示在此窗格中。

    如有必要，您可以在此窗格中修改查询。如果您修改了查询，请点击预览日志来检查结果。

  8. 点击下一步。

  9. 选择通知之间的最短时间间隔。如果此值被多次触发，您可以使用此值来控制从此提醒中收到的通知数量。对于此示例，请从选项中选择 5 分钟。

  10. 可选：选择突发事件自动关闭时长。默认情况下，突发事件自动关闭时长设置为 7 天。

  11. 点击下一步。

  12. 为提醒选择一个或多个通知渠道。在本示例中，请选择电子邮件通知渠道。

    如果您已配置电子邮件通知渠道，则可以从列表中选择它。如未配置，请点击管理通知渠道并添加电子邮件渠道。如需了解如何创建通知渠道，请参阅管理通知渠道。

  13. 点击保存。

基于日志的提醒现在可供测试了。如需了解如何测试提醒，请参阅测试基于日志的提醒示例。

后续步骤