跳到主要内容
版本:v2

规则模版

本文将介绍如何管理项目中的审核规则模板。 SQLE平台提供对应数据库类型的默认审核规则模板,是在长期实践中依据数据库特性总结出的一些规范的集合。审核规则模板在平台上的使用场景包括:创建工单时的审核、扫描任务的审核、SQL查询的审核。 同时也支持项目管理员基于实际业务需求定制审核规则模板,匹配具体的数据源审核需求。

提示

规则模版分为全局模版和项目模版,全局模版为超级管理员配置,所有项目都可见和使用;项目模版由超级管理员或者项目拥有者配置,仅在项目内使用

提示

每个规则模版内可独立配置规则的级别和参数

使用场景

在实际生产中,不同业务/不同数据源对上线的SQL存在不同审核要求,在SQLE平台中,项目管理员可通过审核规则模板为不同的数据源配置不同的审核规则。

前置条件

项目管理员进入指定的项目

创建规则模板

入口

项目管理员点击左侧导航栏【规则模板】菜单,点击项目规则模板列表中的【创建规则模板】按钮。

步骤一:输入基本信息

  • 模板名称:命名当前规则模板,须以字母开头,只能包含字母、数字、中划线和下划线。如:test
  • 模板描述:补充描述模板的其他信息。如:用于测试规则模板触发的告警等级
  • 数据库类型:选择该规则模板应用的数据库类型,当前支持的数据库类型包括MySQL、TiDB、DB2、SQL Server、OceanBase For MySQL、Oracle、PostgreSQL、达梦。

步骤二:选择要启用/禁用的规则

  • 编辑规则告警等级:当前可设置项为普通、提示、警告、告警
  • 编辑规则参数默认值

步骤三:提交规则模板

执行结果

成功创建自定义审核规则模板后,项目管理员可查看已创建的自定义规则模板及其对应的数据库类型。

审核规则模板

后续步骤

  • 设置数据源的审核规则模板:用户可为不同数据源设置相同或者不同的审核规则模板,具体操作请参见数据源管理
  • 创建工单:工单中SQL的审核将依据该数据源配置的审核规则模板,请参见工单说明
  • 创建智能扫描任务:智能扫描任务中SQL的审核将依据该数据源配置的审核规则模板,请参见扫描任务说明

更多操作

  • 导入规则模板:可以导入其他项目中形成的规则模板文件
  • 编辑规则模板:编辑规则模板的基本信息及应用的规则
  • 删除规则模板:删除自行创建的规则模板
    • 限制:当已有数据源绑定了该规则模板,该规则模板不可被删除
  • 克隆规则模板:克隆当前的模板,克隆的规则模版只会继承源模版所有启用的规则、以及变更过的规则等级和阈值。克隆出的新规则模版的模版名称等基本信息需要手动填写。
  • 导出规则模板:导出当前选中的规则模板,以json格式下载规则模板内容。