文档

创建数据表质量规则

更新时间:

Dataphin支持创建校验数据表的质量规则,提升数据表质量监控的便捷性。本文为您介绍如何配置数据表的质量规则。

前提条件

已经添加监控对象才可配置质量规则,如何添加监控对象,请参见添加监控对象

权限说明

  • 超级管理员、质量管理员支持批量配置质量规则、新建及删除异常归档表、配置打分权重。

  • 质量负责人支持在自己所负责的监控对象下配置质量规则、新建及删除异常归档表、配置打分权重。

  • 质量负责人、普通用户需要额外具备有Dataphin数据表的读取权限,如需申请,请参见申请、续期和交还表权限

质量规则配置说明

质量规则支持自定义配置引用数据标准监控(引用数据标准监控需开通数据标准模块)两种方式。

自定义配置是基于系统内置/自定义质量规则模板快速创建,也支持自定义SQL,满足灵活的监控诉求。

引用数据标准监控是引用当前资产对象映射到的数据标准已配置的质量规则,更好地满足标准约束。

校验规则说明

数据表参与质量规则校验时,如果触发了质量弱监控规则,系统会给您发送告警消息,便于您及时发现并处理异常;如果触发了质量强监控规则,系统会自动中断该表所在的任务,避免脏数据流入下游,同时系统会给您发送告警消息,便于您及时发现并处理异常。

质量规则试跑和运行区别

试跑和运行的区别在于执行的方式和显示的结果,试跑指对某个质量规则进行一次模拟执行,以检测规则的正确性和运行情况,试跑的结果不会在质量报告中显示;运行指在特定时间内对质量规则进行检查,运行的结果会输出到质量报告中,便于用户查看和分析。

质量规则配置

  1. 在Dataphin首页,单击顶部菜单栏的资产

  2. 按照下图操作指引,进入质量规则详情页面,配置质量规则。

    image.png

  • 自定义配置

    1. 数据表悬停新建质量规则选择自定义配置或单击新建质量规则,进入新建质量规则对话框。

      image.png

    2. 新建质量规则对话框,配置参数。

      参数

      描述

      规则名称

      自定义质量规则的名称。

      规则强度

      支持弱规则强规则

      • 如果您选择了弱规则,则质量规则校验的结果为异常时报警但不阻塞下游任务节点。

      • 如果您选择了强规则,则质量规则校验的结果为异常时报警,同时在有下游任务的情况下(代码检查调度、任务触发调度)会阻塞下游任务,防止污染数据扩散;如果没有下游任务(如周期质量调度),则仅告警。

      描述

      自定义质量规则描述。不超过128字符。

      配置方式

      • 模板创建:使用通用的系统模板和自定义的业务模板,快速创建质量规则。

        • 系统模板:模板内置参数可配置,适合通用的规则创建。

        • 自定义模板:模板预置参数,无需配置,一般用于含业务逻辑的规则创建。

      • 自定义SQL:可通过SQL灵活自定义质量监控规则,适用于灵活复杂场景。

      规则模板

      下拉可选择规则模板,完整性唯一性及时性有效性一致性稳定性自定义SQL

      • 完整性:包括字段空值校验字段空字符串校验

      • 唯一性:包含字段唯一性校验字段分组个数校验字段重复值个数校验

      • 及时性:包含时间函数比较单表时间字段比较两表时间字段比较

      • 有效性:包含字段格式校验字段长度校验字段值域校验码表参照对比数据标准码表参照对比(需开通数据标准模块)。

      • 一致性:包含单表字段值一致性比较单表字段统计值一致性比较单字段业务逻辑一致性比较两表字段值一致性比较两表字段统计值一致性比较两表字段业务逻辑一致性比较跨源两表字段统计值一致性比较

      • 稳定性:包含表稳定性校验表波动性校验字段稳定性校验字段波动性校验

      • 自定义SQL:包含自定义统计指标校验自定义数据详情校验

      详情请参见模板类型说明

      规则类型

      规则类型和模板有关,是模板最基础的属性,可作为说明和筛选功能。

      规则配置

      规则配置因选择不同的规则模板而变化。详情请参见数据表参数配置

      特殊配置如下:

      • 校验表数据过滤:默认关闭,开启后可配置校验表的过滤条件或分区过滤或普通数据过滤,过滤条件将会直接追加至校验SQL中;如校验表有分区过滤需求,建议在调度配置中配置分区表达式,配置后会以校验分区为最小查看粒度查看质量报告。

      • 当规则模板选择一致性/两表字段统计值一致性比较一致性/跨源两表字段统计值一致性比较时,可选择是否开启对比表数据过滤,开启后可配置对比表的过滤条件或分区过滤或普通数据过滤,过滤条件将会直接追加至校验SQL中。

      规则校验

      • 数据质量规则校验后,结果会和异常校验的配置进行对比,符合条件则校验结果为不通过;同时触发告警等后续流程。

      • 异常校验可用指标由模板和配置内容决定,支持多种条件的and/or条件,实际配置中建议小于3条。

      详情请参见校验配置说明

      异常归档

      默认开启后可以将异常数据归档到文件或归档表中,质量校验后可以下载、分析归档的异常数据。

      • 归档模式支持仅归档异常字段归档完整记录

        • 仅归档异常字段:只去重归档当前监控字段,适用于通过单个字段就可以完整确定异常数据的情况。

        • 归档完整记录:归档异常数据所在的整条记录,适用于必须通过完整记录才能定位异常数据的情况。

          说明

          因归档完整记录会极大增加归档数据量,建议正常情况下都使用仅归档异常字段。

      • 异常数据存储支持默认文件服务器异常数据归档表。若未创见异常归档表,可点击管理异常归档表创建,详情请参见添加异常归档表

        • 默认文件服务器:存储在默认的文件服务器位置,后续只能进行数据的下载。一个规则单次最多归档100条,建议只归档异常字段或小数据量时使用。

        • 异常数据归档表:可以将异常数据存储到表中,后续可以直接读表进行数据分析或数据下载。自定义存储的大小和生命周期可以由您进行统一管理,有更高的灵活性,一个规则单次最多归档10000条。

          说明
          • 在归档表中针对本次校验的异常数据进行下载不超过1000条。

          • 异常归档表需要满足特定的格式要求,否则可能会报错。

      计分方式

      支持质量校验状态和数据合格比例两种计分方式。

      • 质量校验状态:按照当前规则最近一次执行成功的校验记录的校验状态进行打分,校验通过得100分,校验不通过得0分。

      • 合格数据比例:将当前规则最近一次执行成功的校验记录中的正常数据的比例(即正常率)作为分数,如数据格式有效性是80%,那么质量分就是80分。

      不同的规则模板支持的计分方式不同,仅支持质量校验状态计分方式说明如下:

      • 唯一性规则大类的字段分组个数校验、字段重复值个数校验。

      • 一致性规则大类的单表字段统计值一致性比较、跨源两表字段统计值一致性比较。

      • 稳定性规则规则大类。

      • 自定义SQL规则大类的自定义统计指标校验。

      质量分权重

      质量规则的质量分权重,用于统计监控对象的质量分。支持选择1-10之间的整数。

      预览SQL

      说明
      • 关键信息没有填写完整,预览SQL不可用。

      • 左边为上次保存配置SQL预览,若未配置,则为空;右边为当前配置SQL预览。

      image

    3. 单击确定

  • 引用数据标准监控

    1. 数据表悬停新建质量规则选择引用数据标准监控

      image.png

    2. 引用数据标准监控对话框选择需要引用的数据标准规则。

      说明
      • 引用后不支持修改规则详情配置,可自行配置调度、修改规则的强弱等信息。

      • 您可以根据有效性唯一性完整性稳定性四种规则模板筛选标准规则,也可以输入对象名称进行搜索。

      • 在引用数据标准规则对话框,支持修改规则名称、开启或关闭生效状态,您也可以点击关联标准下的标准编码查看标准详情。

      • 您可点击操作列下的image图标查看质量规则。

      image

    3. 单击添加选择规则,完成引用数据标准规则。

规则配置列表

质量规则创建完成后,您可以在规则配置列表进行查看、编辑、试跑、运行、删除等操作。

image.png

区域

描述

筛选及搜索区

支持按照对象或者规则名称进行快捷搜索。

支持按照规则类型规则模板规则强度试跑状态生效状态规则来源进行筛选。

列表区

为您展示规则配置列表的对象名称规则名称试跑状态生效状态规则类型规则模板规则强度调度类型相关知识库文档信息。

  • 若引用的是数据标准规则,可点击规则名称的image图标查看标准详情。

  • 生效状态:建议在生效规则前先进行试跑,针对试跑成功的规则开启生效状态,以避免错误的规则阻塞线上任务。

    • 开启生效状态后,所选规则会按照配置的调度自动执行。

    • 停用生效状态后,所选规则不会自动执行,但可以手动执行。

  • 相关知识库文档:点击查看详情,查看规则关联的知识库信息。包括表名称、校验对象、规则、相关知识库文档信息,同时,您可以对知识库执行搜索、查看、编辑、删除操作。操作详情请参见查看知识库

    image.png

操作区

您可进行查看克隆编辑试跑运行调度配置关联知识库文档质量分配置删除操作。

  • 查看:可查看规则配置详情。

  • 克隆:可快速克隆规则。

  • 编辑:编辑规则后,需重新试跑。引用数据标规则只支持修改规则名称和规则强弱。

  • 试跑:支持选择已有调度自定义校验范围试跑规则,试跑后,可单击image图标查看试跑日志

  • 运行:支持选择已有调度自定义校验范围运行规则,运行后,可在校验记录中查看校验结果。

  • 调度配置:支持在对话框中筛选调度类型或使用调度名称快捷搜索调度。也支持编辑调度。

  • 关联知识库文档:规则关联知识后,可在质量规则和治理工作台中查看关联知识。支持选择未被关联的知识库。如需创建,请参见新建及管理知识库

    image.png

  • 质量分配置:支持修改质量规格的计分方式和质量分权重。

    重要

    质量规则的质量分权重,用于统计监控对象的质量分,修改后会影响质量评分结果,请谨慎操作。

  • 删除:删除此质量规则对象将删除对象下的所有质量规则,删除后不可撤销,请谨慎操作。

批量操作区

您可批量进行试跑运行配置调度开启关闭关联知识库文档质量分配置删除操作。

  • 试跑:支持选择已有调度自定义校验范围批量试跑规则,试跑后,可单击image图标查看试跑日志

  • 运行:支持选择已有调度自定义校验范围批量运行规则,运行后,可在校验记录中查看校验结果。

    说明

    批量运行时,建议选择相同分区的表。分区信息会直接下放执行,如果分区不一致可能会报错。

  • 配置调度:支持在对话框中筛选调度类型或用调度名称快捷搜索调度。也支持编辑调度,为质量规则批量配置调度。

  • 开启:支持批量开启质量规则的对象的生效状态,开启生效状态后,所选规则会按照配置的调度自动执行。

  • 关闭:支持批量关闭质量规则的对象的生效状态,停用生效状态后,所选规则不会自动执行,但可以手动执行。

  • 关联知识库文档:规则关联知识后,可在质量规则和治理工作台中查看关联知识。支持为监控对象批量配置知识库。如需创建,请参见新建及管理知识库

    image.png

  • 质量分配置:支持批量修改质量规格的计分方式和质量分权重。

    重要

    质量规则的质量分权重,用于统计监控对象的质量分,修改后,会影响质量评分结果,请谨慎操作。

  • 删除:支持批量删除质量规则的对象,删除后不可撤销,请谨慎操作。

新建调度

说明
  • 规则配置调度时,可以基于当前已有的调度快速进行配置(每个表上限20个调度规则)。

  • 同一个规则最多能配置10个调度。

  • 调度配置完全一致时,支持自动去重。

  • 若当前表为Hologres分区表,建议使用固定任务触发调度。

  • 校验范围会作为质量校验时的过滤条件下发到质量校验的语句中,控制每次质量校验的范围。校验范围也会作为后续质量报告等下游的基本单元,质量报告的查看会以校验范围为最小查看粒度。

  1. 质量规则详情页面,单击新建调度

    image.png

  2. 新建调度对话框,配置参数。

    image.png

    参数

    描述

    调度名称

    自定义调度名称。

    调度类型

    支持定时调度数据更新触发调度固定任务触发调度

    • 定时调度:按照设置的时间,周期性的对数据进行质量检测,适合数据文档产出的场景。

      • 调度周期:包含小时分钟五种周期类型。

    • 数据更新触发调度:在一个代码任务执行时,会解析本次任务是否更新当前表和所属分区,并执行校验(非分区表只判断表是否更新);如果涉及到配置了该调度方式的表发生变更,则会开始执行质量规则。

      说明

      适用于表的修改任务不固定或者是重点监控表,每次变更都需要监控的情况。

    • 固定任务触发调度:仅在指定的任务完成后,执行配置的质量规则。支持指定SQL、离线管道、Python、Shell、DataX、Spark_jar和Hive_MR的任务类型。

      说明
      • 适用于表的修改任务固定的情况。

      • 固定任务触发只能选择生产环境任务,若规则强度配置了强规则,调度任务校验失败,可能会影响线上任务,请根据业务需求谨慎操作。

      • 触发任务:支持选择所有任务均完成触发任一任务完成即触发任一任务执行前触发

    调度条件

    默认关闭,开启后,在质量规则正式调度前,会先判断是否满足调度条件。满足条件才会正式调度,不满足条件则忽略本次调度。

    • 业务日期/执行日期:若调度类型选择定时调度(定时调度不支持执行日期)、数据更新触发调度固定任务触发调度,支持配置日期,可选择普通日历自定义日历,如何自定义日历,请参见新建公共日历

      • 若选择普通日历,则条件可选月份星期日期。例如下图:

        image

      • 若选择自定义日历,则条件可选日期类型标签。例如下图:

        image

    • 实例类型:若调度类型选择数据更新触发调度固定任务触发调度,支持配置实例类型,可选择周期实例补数据实例手动实例。例如下图:

      image

    说明
    • 至少配置一条规则。如需添加规则,请单击+添加规则按钮。

    • 最多配置10个调度条件。

    • 调度条件之间的关系可配置为且、或。

    校验范围

    当调度类型选择数据更新触发调度时,需要配置任务更新的分区自定义校验范围

    • 任务更新的分区:若检查任务中更新了分区,则直接按照任务更新的分区下发任务。

      说明
      • 动态分区场景可能解析不到分区,将不会进行质量校验。

      • 任务更新了分区,则不支持触发波动性质量校验(如校验分区大小、分区行数、字段统计值)。

      • 非分区表更新时校验全表。

    • 自定义校验范围:对于无法解析的场景,可以使用自定义分区,按照业务日期或者执行日期来指定校验的分区范围。分区表达式详情请参见内置分区表达式类型

    校验范围表达式

    为可输入的下拉选择框,支持直接输入需要校验的范围,如ds='${yyyyMMdd}';也可以选择内置的校验范围表达式然后进行修改,以帮助您快速配置,分区表达式详情请参见内置分区表达式类型

    说明
    • 若有多个条件进行校验,可用andor进行连接,如province="浙江" and ds<=${yyyyMMdd}。

    • 若质量规则中配置了过滤条件,则校验范围表达式和过滤条件之间为and关系,校验数据时,两个条件会一起进行过滤。

    • 校验范围表达式支持对全表进行扫描。

      注意:全表扫描将会消耗较大的资源,并且部分不支持全表扫描,建议配置分区表达式以避免全表扫描。

    校验范围预算

    默认业务日期当天。

  3. 单击确定

调度配置列表

调度创建完成后,您可在调度配置列表进行查看、编辑、克隆、删除等操作

image.png

区域

描述

筛选及搜索区

支持按照调度名称进行快捷搜索。

支持按照定时调度数据更新触发调度固定任务触发调度进行筛选。

列表区

为您展示规则配置列表的调度名称调度类型最后更新人最后更新时间信息。

操作区

  • 您可单击操作列下image的图标编辑质量规则的调度配置。

  • 您可单击操作列下image的图标克隆质量规则的调度配置。

  • 您可单击操作列下image的图标删除质量规则的调度配置,您也可以单击下方image的图标批量删除质量规则的调度配置。

告警配置

  1. 单击告警设置后,再单击右上角的编辑,在告警配置页面,选择告警接收人告警方式,可选择不超过5个告警接收人及不超过3个告警值班表。

    如果质量规则校验的结果为异常,则告警信息会发送至告警接收人。

    image.png

  2. 单击确定

添加异常归档表

异常归档表实现质量规则校验异常的记录归档。

  1. 单击异常归档,再单击添加异常归档表按钮。

    image.png

  2. 添加异常归档表对话框,配置参数。

    image.png

    添加方式支持选择已有表新建表两种方式。增加了特殊的质量校验字段,异常数据归档不会写入原来的数据表。

    • 选择已有表:支持选择同项目或同数据源表,归档表包含必须的质量监控表的所有字段及校验字段(如Dataphin质量规则ID、质量规则名称、质量校验时间、异常归档模式、校验日期等字段)。

    • 新建表:可自定义表名,需在归档表所属项目或所属板块内,不超过128个字符,默认填入当前表名_exception_data。添加成功后会在同库或同数据源新建表。

      • 监控表为物理表时,将在监控表所在项目创建归档表。

      • 监控表为维度逻辑表、事实逻辑表时,默认会在监控表所在项目创建归档表,也可以手动指定为监控表板块下的项目,如projectA.table_name。

      • 监控表是汇总逻辑表时,归档表名建议指定同板块下的项目名称,否则会自动归档到监控表所在板块下的一个项目。

      • 归档表包含必须的质量监控表的所有字段及校验字段(如Dataphin质量规则ID、质量规则名称、质量校验时间、异常归档模式、校验日期等字段)。

  3. 单击确定,完成异常归档表的添加。

查看异常归档表列表

添加成功后,默认第一个为归档表。点击异常归档表的名称,可以查看字段数据类型、字段描述信息。您可以对归档表执行设为默认删除操作。

  • 设为默认:若把该表设为默认,则异常数据只能归档到默认的归档表。

  • 删除:仅删除和异常归档表的引用关系,不会删除异常归档表本身,删除后如果需要可以重新添加。

    image.png

查看质量报告

单击质量报告,查看当前质量规则的规则校验概览规则校验明细

  • 您可根据异常结果、分区时间、规则或对象的名称关键字快捷筛选校验明细。

  • 单击image图标,查看质量规则的规则校验详情。

  • 单击image图标,查看质量规则的执行日志。

image.png

设置质量规则权限管理

  1. 单击权限管理,指定成员查看校验记录详情、质量规则详情、质量报告。

    可查看详情:可选择所有成员仅超级管理员、质量管理员和质量负责人

    image.png

  2. 单击确定

后续步骤

上述质量规则配置完成后,即可在Dataphin数据表规则列表页面查看。详情请参见查看监控对象列表

  • 本页导读 (0)
文档反馈