宜信开源|数据库审核软件Themis部署攻略

fsmStudy 发布于2019-06-25 19:15 / 1688人阅读

摘要：一介绍是宜信公司团队开发的一款数据库审核产品，可帮助开发人员快速发现数据库质量问题，提升工作效率。此平台可实现对数据库进行多维度对象结构文本执行计划及执行特征的审核，用以评估对象结构设计质量及运行效率。执行计划指数据库中的执行计划。

一、介绍

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

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

开源地址： https://github.com/CreditEaseDBA

1.1 功能概述

事后审核，自主优化部分放在二期实现。亦可在项目设计阶段引入，起到一部分事前审核的作用。

通过WEB界面完成全部工作，主要使用者是DBA和有一定数据库基础的研发人员。

可针对某个用户审核，可审核包括数据结构、SQL文本、SQL执行特征、SQL执行计划等多个维度。

审核结果通过WEB页面或导出文件的形式提供。

平台支持主流的Oracle、MySQL数据库，其他数据库放在二期实现。

尽量提供灵活定制的能力，便于日后扩展功能。

1.2 支持的数据库

MySQL（5.6及以上）

Oracle（10g及以上)

1.3 审核维度

数据库结果（对象）=》指数据库对象，常见的表、分区、索引、视图、触发器等。

SQL文本（语句）=》指SQL语句文本本身。

SQL执行计划=》指数据库中SQL的执行计划。

SQL执行特征=》指语句在数据库上的真实执行情况。

1.4 实现原理

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

1.5 平台架构

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

数据采集模块。它是负责从数据源抓取审核需要的基础数据。目前支持从Oracle、MySQL抓取。

OBJ/SQL存储库。这是系统的共同存储部分，采集的数据和处理过程中的中间数据、结果数据都保存在这里。其核心数据分为对象类和SQL类。物理是采用的MongoDB。

核心管理模块。图中右侧虚线部分包含的两个模块：SQL管理和OBJ管理就是这部分。它主要是完成对象的全生命周期管理。目前只做了简单的对象过滤功能，因此还是白色底色，核心的功能尚未完成。

审核规则和审核引擎模块。这部分是平台一期的核心组件。审核规则模块是完成规则的定义、配置工作。审核引擎模块是完成具体规则的审核执行部分。

优化规则和优化引擎模块。这部分是平台二期的核心组件。目前尚未开发，因此为白色底色。

系统管理模块。这部分是完成平台基础功能，例如任务调度、空间管理、审核报告生成、导出等功能。

1.6 操作流程

二、环境搭建

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

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

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

2.1 依赖安装 新建用户

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

    adduser themis-test
    su - themis-test

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

安装cx_Oracle依赖

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

安装python依赖

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

如果联网不方便，或者在公司内网，可以从https://pan.baidu.com/s/1o7AI...，提取码：3sy3

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

安装virtualenv

tar -zxvf virtualenv-13.0.3.tar.gz
cd virtualenv-13.1.0
python setup.py install

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

安装其他依赖

首先初始化虚拟环境

virtualenv python-project --python=python2.7
source /home/themis-test/python-project/bin/activate

解释一下上面的命令：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这里。

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

pip install -r requirement.txt

多带带安装Pyh,下载地址：https://github.com/hanxiaomax...

unzip pyh-master.zip
cd pyh-master
python setup.py install

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

pip install --no-index -f file:///home/themis-test/software -r requirement.txt

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

2.2 配置文件介绍

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

# # set oracle ipaddress, port, sid, account, password
# ipaddres : port -> key
ORACLE_ACCOUNT = {
    # oracle
    "127.0.0.1:1521": ["cedb", "system", "password"]
}

# set mysql ipaddress, port, account, password
MYSQL_ACCOUNT = {
    "127.0.0.1:3307": ["mysql", "user", "password"]
}

# pt-query save data for mysql account, password
PT_QUERY_USER = "user"
PT_QUERY_PORT = 3306
PT_QUERY_SERVER = "127.0.0.1"
PT_QUERY_PASSWD = "password"
PT_QUERY_DB = "slow_query_log"

# celery setting
REDIS_BROKER = "redis://:password@127.0.0.1:6379/0"
# REDIS_BROKER = "redis://:@127.0.0.1:6379/0"


REDIS_BACKEND = "redis://:password@127.0.0.1:6379/0"
# REDIS_BACKEND = "redis://:@127.0.0.1:6379/0"


CELERY_CONF = {
    "CELERYD_POOL_RESTARTS": True
}

# mongo server settings
MONGO_SERVER = "127.0.0.1"
MONGO_PORT = 27017
# MONGO_USER = "sqlreview"
MONGO_USER = "sqlreview"
# MONGO_PASSWORD = ""
MONGO_PASSWORD = "sqlreview"
MONGO_DB = "sqlreview"

# server port setting
SERVER_PORT = 7000

# capture time setting
CAPTURE_OBJ_HOUR = "18"
CAPTURE_OBJ_MINUTE = 15
CAPTURE_OTHER_HOUR = "18"
CAPTURE_OTHER_MINUTE = 30

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的数据采集模块需要设置的采集时间，根据自己的实际情况设置不同的时间即可，避开业务高峰期。

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

2.3 规则导入

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

mongoimport -h 127.0.0.1 --port 27017 -u sqlreview -p password -d sqlreview -c rule --file script/rule.json

三、数据采集

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

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

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

3.1 oracle部分 手动数据采集

手动采集oracle obj信息

配置data/capture_obj.json文件

{
    "module": "capture",   
    "type": "OBJ",    
    "db_type": "O",    
    "db_server": "127.0.0.1",    
    "db_port": 1521,   
    "capture_date": "2017-02-28"
}

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

执行命令

python command.py -m capture_obj -c data/capture_obj.json

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

配置data/capture_other.json文件。

{
    "module": "capture",   
    "type": "OTHER",    
    "db_type": "O",    
    "db_server": "127.0.0.1",    
    "db_port": 1521,    
    "capture_date": "2017-02-28"
}

配置方式同上面的obj

执行命令

python command.py -m capture_obj -c data/capture_obj.json

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

自动数据采集

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

ORACLE_ACCOUNT = {    
    # oracle    
    "127.0.0.1:1521": ["cedb", "system", "password"]
}

配置调度时间

# capture time setting
CAPTURE_OBJ_HOUR = "18"
CAPTURE_OBJ_MINUTE = 15
CAPTURE_OTHER_HOUR = "18"
CAPTURE_OTHER_MINUTE = 30

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

3.2 mysql部分 pt-query-digest使用

可以将慢日志集中到一个地方，再集中入库。

也可以在每台mysql机器上安装pt-query-digest,再将解析结果推送到存储机器上。

本平台采用第二种方案

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

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

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

pt-query-digest --user=root --password=password --review h=127.0.0.1,D=slow_query_log,t=global_query_review --history h=127.0.0.1,D=slow_query_log,t=global_query_review_history --no-report --limit=0% --filter=" $event->{Bytes} = length($event->{arg}) and $event->{hostname}="127.0.0.1:3306" and $event->{client}=$event->{ip}" slow.log

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

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

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

四、任务导出 4.1 手动任务导出

配置data/export.json文件

{
    "module": "export",
    "type": "export",
    "task_uuid": "08d03ec6-f80a-11e6-adbc-005056a30561",
    "file_id": "08d03ec6-f80a-11e6-adbc-005056a30561"
}

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

python command.py -m export -c data/export.json

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

4.2 自动任务导出

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

五、web管理端 5.1 手动开启web管理端

执行如下命令

python command.py -m web -c data/web.json

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

六、supervisor配置 6.1 supervisor配置

;web管理端开启
[program:themis-web]
command=/home/themis-test/python-project/bin/python command.py -m web -c data/web.json
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_web.log
loglevel=info

;开启文件下载服务器
[program:themis-download]
command=/home/themis-test/python-project/bin/python task_export/file_download.py
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_download.log
loglevel=info

;开启任务导出模块
[program:themis-export]
command=/home/themis-test/python-project/bin/celery -A task_exports worker -E -l info
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_export.log
loglevel=info
;开启规则解析模块
[program:themis-analysis]
command=/home/themis-test/python-project/bin/celery -A task_other worker -E -Q sqlreview_analysis -l info
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_analysis.log
loglevel=info
;开启obj信息抓取模块
[program:themis-capture-obj]
command=/home/themis-test/python-project/bin/celery -A task_capture worker -E -Q sqlreview_obj -l debug -B -n celery-capture-obj
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_capture_obj.log
loglevel=info
;开启plan、stat、text信息抓取模块
[program:themis-capture-other]
command=/home/themis-test/python-project/bin/celery -A task_capture worker -E -Q sqlreview_other -l info -B -n celery-capture-other
autostart=true
redirect_stderr=true
stdout_logfile=tmp/themis_capture_other.log
loglevel=info
;celery的任务管理模块,去掉前边的";"即可开启，需要配置redis的连接方式
;[program:themis-flower]
;command=/home/themis-test/python-project/bin/celery flower --address=0.0.0.0 --broker=redis://:password@127.0.0.1:6379/0
;autostart=true
;redirect_stderr=true
;stdout_logfile=tmp/themis_flower.log
;loglevel=info

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

supervisor常用命令

开启supervisor
supervisord -c script/supervisord.conf
重载supervisor
supervisorctl -u sqlreview -p sqlreview.themis reload
进入supervisor管理控制台,这里的-u,-p代表supervisorctl的用户名和密码，在supervisord.conf中配置
supervisorctl -u username -p password

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

七、常见问题

主机名称不一致，导致cx_Oracle出错。

celery与flower版本不一致，导致flower不能启动，升级flower到0.8.1以上。

mysql5.7不能初始化，datetime默认类型为(DEFAULT "0000-00-00 00:00:00)。

mongodb文档最大插入数据有限制，导致生成结果时插入文档失败。

在oracle获取用户的时候，有的系统可能会将用户建到users下，因此需要将 NOT IN ("USERS", "SYSAUX"))改成 NOT IN ("SYSAUX"))

文件位置：capture/sql.py webui/utils/f_priv_db_user_list.py

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

mysqldb安装问题参考：http://blog.csdn.net/wklken/a...

八、异常处理

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

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

;celery的任务管理模块,去掉前边的";"即可开启，需要配置redis的连接方式
;[program:themis-flower]
;command=/home/themis-test/python-project/bin/celery flower --address=0.0.0.0 --broker=redis://:password@127.0.0.1:6379/0
;autostart=true
;redirect_stderr=true
;stdout_logfile=tmp/themis_flower.log
;loglevel=info

也可以手工开启：

celery flower --address=0.0.0.0 --broker=redis://:password@127.0.0.1:6379/0

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

九、加入开发

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

本文选自：wiki：https://tuteng.gitbooks.io/th...。
由于篇幅关系内容有所调整，请点击链接查看原文。

来源：宜信技术学院

云服务器 GPU云服务器视频点播审核包购买攻略开源数据库软件 Themis 开源数据分析软件

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/18007.html

宜信开源|数据库审核软件Themis的规则解析

摘要：导语是宜信公司团队开发的一款数据库审核产品，可帮助开发人员快速发现数据库质量问题，提升工作效率。此平台可实现对数据库进行多维度对象结构文本执行计划及执行特征的审核，用以评估对象结构设计质量及运行效率。阀值阀值，代表违反规则的扣分上限。导语 Themis是宜信公司DBA团队开发的一款数据库审核产品，可帮助DBA、开发人员快速发现数据库质量问题，提升工作效率。此平台可实现对Oracle...

longmon 2019-06-25 19:15 评论0 收藏0

发表评论

登陆后可评论

0条评论

fsmStudy

男|高级讲师

我要关注我要私信

TA的文章

C++从0到1之命名空间

阅读 3298·2021-11-25 09:43
立即更新您的Windows PC!微软周二补丁修复易受主动攻击的0 Day漏洞!

阅读 2988·2021-10-15 09:43
关于这个大一结束——————

阅读 1924·2021-09-08 09:36
CSS相关面试题——三栏等高布局

阅读 2891·2019-08-30 15:56
设置图片水平垂直居中

阅读 718·2019-08-30 15:54
浮动及浮动相关问题(初次)

阅读 2644·2019-08-30 15:54
反思：我使用ID选择器时应该考虑这些问题

阅读 2938·2019-08-30 11:26
004-盒模型及文本溢出

阅读 1212·2019-08-29 17:27

资讯专栏INFORMATION COLUMN

上云采购季！| 2核2G4M爆款云服务器低至59元/年，更有多台、长期优惠，快来选购！

宜信开源|数据库审核软件Themis部署攻略

相关文章

**宜信开源|数据库审核软件Themis的规则解析**

发表评论

0条评论

fsmStudy

男|高级讲师

TA的文章

C++从0到1之命名空间

立即更新您的Windows PC!微软周二补丁修复易受主动攻击的0 Day漏洞!

关于这个大一结束——————

CSS相关面试题——三栏等高布局

设置图片水平垂直居中

浮动及浮动相关问题(初次)

反思：我使用ID选择器时应该考虑这些问题

004-盒模型及文本溢出

最新活动