宜信开源|数据库审核软件Themis的规则解析与部署攻略


Themis是宜信公司DBA团队开发的一款数据库审核产品,可帮助DBA、开发人员快速发现数据库质量问题,提升工作效率。其名称源自希腊神话中的正义与法律女神。项目取此名称,寓意此平台对数据库质量公平判断,明察秋毫。

此平台可实现对Oracle、MySQL数据库进行多维度(对象结构、SQL文本、执行计划及执行特征)的审核,用以评估对象结构设计质量及SQL运行效率。可帮助DBA及开发人员,快速发现定位问题;并提供部分辅助诊断能力,提升优化工作效率。全部操作均可通过WEB界面进行,简单便捷。此外,为了更好满足个性化需求,平台还提供了扩展能力,用户可根据需要自行扩展。

Themis,是希腊正义与法律女神,以头脑清晰见称。项目采用此名称,寓意着平台可对数据库质量公平判断,明察秋毫之意。

整个平台的基本实现原理很简单,就是将我们的审核对象(目前支持四种),通过规则集进行筛选。符合规则的审核对象,都是疑似有问题的。平台会将这些问题及关联信息提供出来,供人工甄别使用。由此可见,平台的功能强大与否,主要取决于规则集的丰富程度。平台也提供了部分扩展能力,方便扩展规则集。

图中的方框部分,为平台的主要模块。底色不同的模块,表示当前的进度状态不同。虚线代表数据流,实线代表控制流。其核心为这几个模块:

本项目中会使用到mysql,mongo和redis,python支持2.6、2.7,暂不支持python3。

mysql用来存储pt-query-digest抓取的mysql的慢查询,mongo存储我们的规则、oracle的采集结果、执行job,解析结果集等,redis作为任务调度celery的队列。

在mysql的数据采集部分我们使用的是pt-query-digest工具

为了减少后面对supervisord.conf配置文件的修改,我们建议使用统一的用户进行安装

后面的操作除了virtualenv安装需要切换到root用户,其他的都默认在themis-test用户下安装

由于在审核过程中需要连接oracle数据库,因此需要先安装cx_Oracle的依赖,参考:http://www.jianshu.com/p/pKz5K7

首先安装virtualenv,参考链接:https://pypi.python.org/simple/virtualenv/,建议安装13.0.3或更新版本

如果联网不方便,或者在公司内网,可以从https://pan.baidu.com/s/1o7AIWlG下载压缩包,提取码:3sy3

压缩包里包括所有需要用到的依赖包

关于virtualenv的使用请参考:https://virtualenv.pypa.io/en/stable/

首先初始化虚拟环境

解释一下上面的命令:virtualenv的第二个参数python-project是我们建立的虚拟环境的名称,这个名称我们虽然可以随便定义,但是后面supervisor的配置中使用了此名称,建议使用默认的,大家如果对python比较熟悉,可以随意定义。后面我们指定了python的版本,–python可以不加,默认会使用系统自带的python版本构建虚拟环境,当有多个版本的python时,可以使用此命令指定版本。

下面使用source初始化虚拟环境,以后安装的包依赖等都会被装到/home/themis-test/python-project/home/themis-test/python2.7/lib/python2.7/site-packages这里。

如果可以联网,进入源代码目录使用如下命令

单独安装Pyh,下载地址:https://github.com/hanxiaomax/pyh

如果在局域网环境不方便联网请利用的上面网盘里提供的压缩包

file:///home/themis-test/software是压缩包解压的位置

下面以配置文件settings.py为例子说明需要的一些依赖

ORACLE_ACCOUNT和MYSQL_ACCOUNT是我们需要审核的目标机器的帐号和密码,主要是在数据采集部分和对象类审核以及mysql的执行计划类审核部分会用到,因此该帐号因该具有较高的权限,为了安全在生产环境应该设置专有的帐号并设置专有的权限,或者加上一些ip的限制等。

PT_QUERY_USER、PT_QUERY_PORT、PT_QUERY_SERVER、PT_QUERY_PASSWD、PT_QUERY_DB是我们pt-query-digest工具解析目标机器的慢sql后需要存储到的mysql数据库的一些配置。

REDIS_BROKER、REDIS_BACKEND、CELERY_CONF是任务调度工具celery的配置选项。

MONGO_SERVER、MONGO_PORT、MONGO_USER、MONGO_PASSWORD、MONGO_DB是需要存储结果集的mongo的配置选项。

SERVER_PORT是web管理端监听的端口,不要使用9000和5555端口,这两个被分配给了文件下载服务器和flower管理工具。

CAPTURE_OBJ_HOUR、CAPTURE_OBJ_MINUTE、CAPTURE_OTHER_HOUR、CAPTURE_OTHER_MINUTE是针对oracle的数据采集模块需要设置的采集时间,根据自己的实际情况设置不同的时间即可,避开业务高峰期。

请按照相关说明配置该文件

进入源代码目录,使用如下命令进行规则初始化

数据采集分为oracle部分和mysql部分,oracle部分使用的是自己开发的一些脚本,mysql使用的是pt-query-digest工具。

数据采集的频率默认是一天一次,可以根据自己的需要进行修改。

oracle部分依赖于celery的任务调度,会用supervisor托管,pt-query-digest可以加到crontab里。


手动采集oracle obj信息

配置data/capture_obj.json文件

只需要配置db_server和dbport选项,oracle的端口要求是1521,capture_date指定采集数据的日期,现在只支持按天采集


执行命令

手动采集oracle other信息,包括plan、stat、text信息。

配置data/capture_other.json文件。

配置方式同上面的obj


执行命令

手动采集数据一般用于初次采集,后面一般都会通过自动采集完成。

配置settings.py文件里的ORACLE_ACCOUNT,该账号需要具有查询所有表的权限,即select any table。


配置调度时间

如果不对oracle数据库审核,可以不用配置


本平台采用第二种方案

从 https://www.percona.com/get/pt-query-digest 下载并安装pt-query-digest,如果缺少依赖使用yum安装。

使用scirpt/pt_query_digest.sql初始化表结构,不要使用默认的表结构。

在目标机器上配置好script/pt-query-digest.sh脚本:

$event->{hostname}=’127.0.0.1:3306′ 为被搜集慢日志的机器的ip地址和端口号。

主要是配置存储解析结果的mysql机器的帐号,密码,机器ip,端口号,以及慢日志的位置等。

运行pt-query-digest.sh脚本开始搜集mysql慢查询数据,后面可以将其加入定时任务,按固定时间段搜集。

规则解析分为四块:对象类规则解析、文本类规则解析、执行计划类规则解析、统计信息类规则解析。每个模块都可以使用手动或自动的方式进行。

配置data/analysis_o_obj.json文件

配置db_server、db_port、username、create_user、task_ip选项,其他的保持默认即可,username是需要审核的目标对象的名字。

使用上面的命令开始采集obj数据

配置data/analysis_m_obj.json文件

配置db_server、db_port、username、create_user、task_ip、db_port选项,其他的保持默认即可。

运行命令:

oracle和mysql对象类规则是不需要依赖于采集的数据的,它是直接连接到数据库里进行查询的,由于有的库较大可能时间会比较久,建议在业务低峰期进行。

配置data/analysis_o_text.json文件

配置sid、username、create_user、task_ip、hostname、startdate、stopdate选项,由于数据是按天采集的,因此暂时只支持startdate和stopdate保持一致,hostname和task_ip可以保开发云主机域名持一致,其他的保持默认即可。

执行下面的命令即可以进行规则解析:

配置data/oracle_m_text.json文件

配置username、create_user、taskip、taskport、hostname、hostname_max、startdate、stopdate选项,hostname和task_ip可以保持一致,其他的保持默认即可。

运行下面的命令即可以进行规则解析:

上面两步中的username为需要审核的对象。

配置data/analysis_o_plan.json文件

主要是对capture_date,username, create_user, sid,db_type,rule_type,task_ip,task_port参数进行配置,type分为SQLPLAN,SQLSTAT,TEXT,OBJ四种类型,rule_type的类型同SQLPLAN,只不过一个是代表模块的类型,一个代表规则的类型,db_type分为”O”和“mysql”两种类型,分别代表oracle和mysql,capture_date为我们欠扁配置的数据的抓取日期。

运行上面的命令即可生成解析结果。

配置data/analysis_m_plan.json文件

type类型的含义同上面oracle,hostname_max为mysql的ip:端口号的形式,每一个hostname_max代表一个mysql实例,startdate和stopdate需要加上时、分、秒,这一点同oracle不大一样。

然后运行上面的命令进行mysql的plan的规则解析。

配置data/analysis_o_stat.json文件

配置sid、username、create_user、task_ip、capture_date选项,其他保持默认即可。

运行命令:

进行数据采集。

配置文件data/analysis_m_text.json

配置username、create_user、task_ip、task_port、hostname、hostname_max、startdate、stopdate选项,hostname和task_ip可以保持一致,其他的保持默认即可。

运行命令:

进行数据采集。

上面介绍的手动规则解析都是可以进行测试,或者在一些特殊情况下使用,大部分情况我们会使用自动规则解析。

自动规则解析我们使用celery来完成,关于celery 的使用,请参考http://docs.celeryproject.org/en/master/getting-started/first-steps-with-celery.html。

下面是常用的一些关于celery的命令:

最后我们会将规则解析都加入到supervisor托管,然后通过web界面生成任务,然后用celery进行调度,通过flower查看任务执行状态。

关于具体使用请参考supervisor的配置。

配置data/export.json文件

配置task_uuid和file_id选项,这是任务的唯一标志,可以通过从mongo中sqlreview库中job集合查看,然后运行:

进行手动任务导出,会生成离线的html压缩包,保存在task_export/downloads下,可以直接解压,然后通过浏览器打开查看报告。

通过在celery配合supervisor托管来实现,具体可参考supervisor的配置。

执行如下命令

访问 http://127.0.0.1:7000 即可打开管理端

注意:如果前边建立的用户不同或者使用了不同的目录,需要将这个文件里的/home/themis-test/python-project/替换为自己的路径。

参考:http://www.supervisord.org/

平台的核心就是规则。规则是一组过滤条件的定义及实现。规则集的丰富程度,代表了平台的能力。平台也提供了扩展能力,用户可自行定义规则。 从分类来看,规则可大致分为几类。

规则可以包含参数。例如:执行计划规则中,有个是大表扫描。这里就需要通过参数来限定大表的定义,可通过物理大小来指定。

规则权重及扣分,最终会累积为一个总的扣分,平台会按百分制进行折算。通过这种方式,可起到一定的量化作用。

文件位置:capture/sql.py webui/utils/f

priv

db

user

list.py

有些情况下需要安装python-devel,centos安装 yum install python-devel

mysqldb安装问题参考:http://blog.csdn.net/wklken/article/details/7271019

程序中间出了差错可以通过开启flower来查看,或者通过手工执行的方式进行查看代码。

flower的开启可以通过在supervisor中配置或者

也可以手工开启:

不过都需要配置redis认证选项。

有问题可以直接在 https://github.com/CreditEaseDBA/Themis/issues 提出。

来源:

宜信技术学院

相关推荐: MySQL 选择数据库

在你连接到 MySQL 数据库后,可能有多个可以操作的数据库,所以你需要选择你要操作的数据库。在 mysql> 提示窗口中可以很简单的选择特定的数据库。你可以使用SQL命令来选择指定的数据库。以下实例选取了数据库 RUNOOB:执行以上命令后,你就已经成…

免责声明:本站发布的图片视频文字,以转载和分享为主,文章观点不代表本站立场,本站不承担相关法律责任;如果涉及侵权请联系邮箱:360163164@qq.com举报,并提供相关证据,经查实将立刻删除涉嫌侵权内容。

(0)
打赏 微信扫一扫 微信扫一扫
上一篇 06/05 21:10
下一篇 06/05 21:10

相关推荐