Dataphin支持对数据源的连通性和表结构异动进行监测。质量规则定时检测数据源的连通性或数据结构异动,并支持设置异常告警信息,帮助您实时了解数据源连通性和表结构的状况。本文为您介绍如何配置数据源的质量规则。
前提条件
已经添加监控对象才可配置质量规则,如何添加监控对象,请参见添加监控对象。
权限说明
超级管理员、质量管理员和资源负责人支持为质量规则配置调度、告警等。
质量负责人、普通用户需要额外具备数据源的同步读取权限,如需申请数据源权限,详情请参见申请数据源权限。
质量规则试跑和运行区别
试跑和运行的区别在于执行的方式和显示的结果,试跑指对某个质量规则进行一次模拟执行,以检测规则的正确性和运行情况,试跑的结果不会在质量报告中显示;运行指在特定时间内对质量规则进行检查,运行的结果会输出到质量报告中,便于用户查看和分析。
质量规则配置
在Dataphin首页,在顶部菜单栏选择治理 > 数据质量。
单击左侧导航栏的质量规则,在数据源页面,单击目标对象的名称,进入质量规则详情页面,配置质量规则。
在质量规则详情页面,单击新建质量规则。
在新建质量规则对话框中,配置参数。
参数
描述
基本信息
规则名称
自定义质量规则的名称,不超过256个字符。
规则强度
支持弱规则和强规则。
弱规则:如果您选择了弱规则,则质量规则校验的结果为异常时报警但不阻塞下游任务节点。
强规则:如果您选择了强规则,则质量规则校验的结果为异常时报警,同时在有下游任务的情况下(代码检查调度、任务触发调度)会阻塞下游任务,防止污染数据扩散;如果没有下游任务(如周期质量调度),则仅告警。
描述
自定义质量规则描述。不超过128个字符。
规则模板
仅支持稳定性,包含数据源连通性监测和表结构异动监测。
连通性监测:配置到Dataphin上的数据源因网络变更、用户名、密码等原因导致连接失败,进而导致任务报错,对连通性监测的变化进行加监控告警。
表结构异动:上游表的结构变化,如更名、删除、增减字段,进而导致下游报错,对表结构的变化进行监控告警。
规则类型
规则类型和模板有关,是模板最基础的属性,可作为说明和筛选功能。
规则配置
选择校验表
当规则模板选择表结构异动监测时,需要选择校验的数据表。
业务属性配置
属性信息
业务属性填写规范取决于质量规则属性的配置。例如:归口管理部门所对应的字段取值类型为枚举值(多选),可选枚举值范围为大数据部、业务部、技术部。因此,创建质量规则时,该属性值为下拉多选框,可选项为枚举值(多选),可选枚举值范围为大数据部、业务部、技术部。
规则负责人所对应的字段取值类型为自定义输入,属性字段长度为256。因此,在创建质量规则时,该属性值可以输入不超过256个字符。
若属性字段的填写方式为范围区间,则配置方式如下:
范围区间:常用于取值范围是连续数值或日期的情况。可选择>、>=、<、<=四种符号。更多属性配置,请参见新建及管理质量规则属性。
调度属性配置
调度方式
支持选择已配置的调度;若暂未决定调度方式,您可创建质量规则后再配置。如需新建,请参见新建调度。
单击确定,完成规则配置。
规则配置列表
您可以在规则配置列表页面查看已经配置的数据源规则信息,并进行查看、编辑、试跑、运行、删除等操作。
区域 | 描述 |
①筛选及搜索区 | 支持按照对象或者规则名称进行快捷搜索。 支持按照规则类型、规则模板、规则强度、试跑状态、生效状态进行筛选。 说明 若质量规则属性配置了可搜索、可筛选的业务属性且为启用状态,则可根据该属性进行搜索或筛选。 |
②列表区 | 为您展示规则配置列表的对象类型/名称、规则名称/ID、试跑状态、生效状态、规则类型、规则模板、规则强度、调度类型、相关知识库文档信息,单击刷新前的图标,可选择您需要展示的规则列表字段。
|
③操作区 | 您可进行查看、克隆、编辑、试跑、运行、调度配置、关联知识库文档、删除操作。
|
④批量操作区 | 您可批量进行试跑、运行、配置调度、开启、关闭、修改业务属性、关联知识库文档、删除操作。
|
新建调度
规则配置调度时,可以基于该表格当前已有的调度快速进行配置(每个表上限为20个调度规则)。
同一个规则最多能配置10个调度。
调度配置完全一致时,支持自动去重。
在质量规则详情页面,单击调度配置页签,再单击新建调度按钮,进入新建调度对话框。
在新建调度对话框中,配置参数。
参数
描述
调度名称
自定义调度名称,不超过64个字符。
调度类型
支持定时调度和固定任务触发调度。
定时调度:根据设置的调度时间,支持定时、周期性地对数据进行质量检测,适合数据产出时间相对固定的场景。
调度周期:质量规则运行会占用一定的计算资源,建议避免同一时间并发执行多条质量规则,以免影响生产任务的正常运行。调度周期包含日、周、月、小时、分钟五种周期类型。
固定任务触发调度:在指定的任务运行成功后或运行前,执行配置的质量规则。支持选择引擎SQL、离线管道、Python、Shell、Virtual、Datax、Spark_jar、Hive_MR、数据库SQL节点的任务类型触发任务。适用于表修改任务固定的情况。
说明固定任务触发只能选择生产环境任务,若规则强度配置了强规则,调度任务校验失败,可能会影响线上任务,请根据业务需求谨慎操作。
触发时机:选择进行质量检测的触发时机。支持选择所有任务都运行成功后触发、每个任务每次运行成功后均触发和每个任务每次运行前触发。
触发任务:支持选择当前用户有运维权限的生产任务节点,可以根据节点输出名称搜索。
说明当触发时机选择所有任务都运行成功后触发时,触发任务建议选择同调度周期的任务,避免因调度周期不同而导致规则延迟运行,质量检测结果延迟产出。
调度条件
默认关闭,开启后,在质量规则正式调度前,会先判断是否满足调度条件。满足条件才会正式调度,不满足条件则忽略本次调度。
业务日期/执行日期:若调度类型选择定时调度(定时调度不支持执行日期)、代码检查触发调度、固定任务触发调度,支持配置日期,可选择普通日历或自定义日历,如何自定义日历,请参见新建公共日历。
若选择普通日历,则条件可选月份、星期、日期。例如下图:
若选择自定义日历,则条件可选日期类型、标签。例如下图:
实例类型:若调度类型选择代码检查触发调度、固定任务触发调度,支持配置实例类型,可选择周期实例、补数据实例、手动实例。例如下图:
说明至少配置一条规则。如需添加规则,请单击+添加规则按钮。
最多配置10个调度条件。
调度条件之间的关系可配置为且、或。
单击确定,完成调度配置。
调度配置列表
调度创建完成后,您可以在调度配置列表执行查看、编辑、克隆、删除等操作。
区域 | 描述 |
①筛选及搜索区 | 支持按照调度名称进行快捷搜索。 支持按照定时调度、固定任务触发调度进行筛选。 |
②列表区 | 为您展示规则配置列表的调度名称、调度类型、最后更新人、最后更新时间信息。 |
③操作区 | 您可以对调度执行编辑、克隆、删除操作。
|
设置告警
您可以给不同的规则配置不同的告警方式以实现区分告警,如:为强规则异常配置电话告警,弱规则异常配置短信告警;如果一个规则同时命中了多条告警配置,支持设置告警的生效策略。
单个监控对象下支持创建不超过20个告警配置。
在质量规则详情页面,单击告警配置页签,再单击新建告警配置按钮,进入新建告警配置对话框。
在新建告警配置对话框,配置参数。
参数
描述
覆盖范围
支持选择所有规则、所有强规则、所有弱规则和自定义。
说明单个监控对象下,所有规则、所有强规则和所有弱规则3种范围支持各配置一条告警,后续新增的规则根据规则强度自动匹配对应的告警;如需变更其中的某一条告警配置,可修改已有配置。
自定义范围可选择当前监控对象下已配置的所有规则,不超过200条。
告警配置名称
单个监控对象下告警配置名称唯一,不超过256字符。
告警接收人
配置告警接收人及告警方式。需要选择至少一种告警接收人及告警方式。
告警接收人:支持选择自定义、值班表和质量负责人三种告警接收人。
支持配置不超过5个自定义告警接收人;支持配置不超过3个值班表。
告警方式:支持选择电话、邮件、短信、钉钉、飞书、企业微信、自定义渠道不同的接收方式。此接收方式可通过配置渠道设置进行管控。
单击确定,完成告警配置。
告警配置列表
告警配置完成后,您可在告警配置列表中进行排序、编辑、删除操作。
序号 | 描述 |
①排序区 | 支持配置一条质量规则符合多条告警配置时的告警生效策略:
|
②列表区 | 为您展示告警配置的名称、生效范围、每种告警类型的具体接收人以及对应的告警接收方式。 生效范围:自定义告警支持查看配置的对象名和规则名,若该规则被删除,则无法查看对象名,建议您更新告警配置。 |
③操作区 | 您可以对配置的告警执行编辑和删除操作。
|
查看质量报告
单击质量报告,查看当前质量规则的规则校验概览和规则校验明细。
您可根据异常结果、分区时间、规则或对象的名称关键字快捷筛选校验明细。
在规则校验明细列表中的操作列单击图标,查看质量规则的规则校验详情。
在规则校验明细列表中的操作列单击图标,查看质量规则的执行日志。
设置质量规则权限管理
单击权限管理,配置可查看详情,即指定成员查看校验记录详情、质量规则详情、质量报告。
可查看详情:可选择所有成员或仅超级管理员、质量管理员和质量负责人。
单击确定,完成权限管理设置。
后续步骤
上述质量规则配置完成后,即可在数据源规则列表页面查看。详情请参见查看监控对象列表。