DBA的福音，SQL审核利器-goinception

导读

最近在重构公司自动化运维平台的SQL审核部分，于是调研了一下goinception。在之前的公司审核引擎用的是去哪儿网开源的inception，由于某些原因，inception长久不更新并且已经不再开源，所以就把目光转向了goinception。

一、goinception简介

使用过inception的人对SQL审核这块获取都比较熟悉，作为DBA，审核SQL是日常工作中的很重要的一块内容，审核好SQL对于后期项目以及数据库维护上起着至关重要的作用，好比一座大厦没有坚实的地基支撑，也就无法长期屹立不倒。

goInception是一个集审核、执行、备份及生成回滚语句于一身的MySQL运维工具， 通过对执行SQL的语法解析，返回基于自定义规则的审核结果，并提供执行和备份及生成回滚语句的功能。

goinception的github地址：https://github.com/hanchuanchuan/goInception

相关的详细文档：https://hanchuanchuan.github.io/goInception/

goinception的架构：

从架构上来说，goinception简直跟inception一模一样，SQL提交到goinception，goinception连接到线上MySQL进行审核。执行的时候也是连接到线上MySQL进行执行，goinception提供了备份、回滚的功能，意思就是能够监听执行期间的binlog，基于binlog生成反向的回滚SQL。

二、安装测试

废话不多说，咱们直接安装测试一把。

下载、安装

官方提供了二进制包，简直安装部署的一大福利。

下载地址：https://github.com/hanchuanchuan/goInception/releases

下载好对应版本的goinception，直接解压即可，解压完成以后在config/config.toml.default有一个默认的配置文件，大概意思也写得比较清楚了，那我修改的部分已经写在下面的配置文件中了，其他部分我都没有修改

# 日志文件  
[log.file]  
filename = "/opt/goinception/logs/goinception.log"  
max-days = 7  
max-backups = 7  
[inc]  
backup_host = "xxxx"  
backup_port = 3306  
backup_user = "goinception"  
backup_password = "goinception"  
sql_safe_updates = 1  
lang = "zh-CN"  
[osc]  
osc_min_table_size = 1024  
[ghost]  
ghost_on = true  
ghost_chunk_size = 10000  
ghost_dml_batch_size = 100 

那么，我们启动goinception 

./goInception -config=config/config.toml & 

启动以后，我们可以看到端口4000已经启动监听了 

[root@VM_0_9_centos ~]# netstat -lntp|grep 4000  
tcp6       0      0 :::4000                 :::*                    LISTEN      31404/./goInception 

测试

goinception可以沿用inception的调用方法，示例如下： 

/*--user=root;--password=root;--host=127.0.0.1;--check=1;--port=3306;*/  
inception_magic_start;  
use test;  
create table t1(id int primary key);  
inception_magic_commit; 

那么我们构建一个python脚本来进行测试： 

#!/usr/bin/env python3  
# -*- coding:utf-8 -*-  
import pymysql  
import prettytable as pt  
tb = pt.PrettyTable()  
sql = '''/*--user=xucl;--password=xuclxucl123;--host=127.0.0.1;--check=1;--port=3308;*/  
inception_magic_start;  
use sbtest;  
create table t1(id int primary key,c1 int, c2 int);  
insert into t1(id,c1,c2) values(1,1,1);  
inception_magic_commit;'''  
conn = pymysql.connect(host='127.0.0.1', user='', passwd='',  
                       db='', port=4000, charset="utf8mb4")  
cur = conn.cursor()  
ret = cur.execute(sql)  
result = cur.fetchall()  
cur.close()  
conn.close() 
tb.field_names = [i[0] for i in cur.description]  
for row in result:  
    tb.add_row(row)  
print(tb) 

执行后输出如下： 

[root@VM_0_9_centos goinception]# python3 test.py   
+----------+---------+-------------+-----------------+-----------------+----------------------------------------------------+---------------+--------------+---------------+--------------+---------+-------------+ 
| ------+---------------+--------------+---------------+--------------+---------+-------------+|order_id|stage|error_ |  ------+---------------+--------------+---------------+--------------+---------+-------------+|order_id|stage|error_  | ------+---------------+--------------+---------------+--------------+---------+-------------+|order_id|stage|error_level |   ------+---------------+--------------+---------------+--------------+---------+-------------+|order_id|stage|error__status  |  ------+---------------+--------------+---------------+--------------+---------+-------------+|order_id|stage|error_message  |                        sql                         | affected_rows |   sequence   | backup_dbname | execute_time | sqlsha1 | backup_time | 
+----------+---------+-------------+-----------------+-----------------+----------------------------------------------------+---------------+--------------+---------------+--------------+---------+-------------+ 
|    1     | CHECKED |      0      | Audit Completed |       None      |                     use sbtest                     |       0       | 0_0_00000000 |      None     |      0       |   None  |      0      | 
|    2     | CHECKED |      2      | Audit Completed | 表 't1' 已存在. | create table t1(id int primary key,c1 int, c2 int) |       0       | 0_0_00000001 |      None     |      0       |   None  |      0      | 
|    3     | CHECKED |      0      | Audit Completed |       None      |       insert into t1(id,c1,c2) values(1,1,1)       |       1       | 0_0_00000002 |      None     |      0       |   None  |      0      | 
+----------+---------+-------------+-----------------+-----------------+----------------------------------------------------+---------------+--------------+---------------+--------------+---------+-------------+ 

 可以看到审核结果还是非常清晰的

那如果需要执行的话怎么做呢？我们只需要修改示例中的头部，将--check=1改成--execute=1即可 

/*--user=xucl;--password=xuclxucl123;--host=127.0.0.1;--execute=1;--port=3308;*/ 

那你如果想备份的话，添加选项--backup=1即可 

/*--user=xucl;--password=xuclxucl123;--host=127.0.0.1;--execute=1;--backup=1;--port=3308;*/ 

三、审核规则

goinception的审核规则可以见文档：https://hanchuanchuan.github.io/goInception/rules.html

我捡了一些我认为比较重要的审核规则，列成表格如下：

create table

表属性

列属性

索引属性检查项

默认值

自增列

ALTER

DML

INSERT

INSERT SELECT

UPDATE/DELETE

四、使用感受

简单测试了一下goinception，整体体验下来感觉还是很不错的，相比于之前的inception来说，goinception有如下几个优点：

1.  安装部署非常简单，官方直接提供了二进制包
2.  集成了gh-ost无需另外安装，同时也提供pt-osc方式执行DDL
3.  提供了基于表大小的ALTER执行选项，并且可配置大小
4.  支持关联更新，inception本身是不支持的
5.  提供了更加丰富的审核规则选项，并且是基于MySQL5.7的，相比于inception来说支持度更好
6.  长期稳定更新，从github上的commit记录看作者还是更新得很勤奋的
7.  更快的备份功能，之前使用inception的时候经常会碰到需要备份的binlog过大，网络超时的现象（从文档上看goinception使用的批量备份，据说速度能快很多）

五、系统集成

到这里，我们已经基本上选择goinception作为我们的审核引擎了，那么如何集成到现有的自动化系统中是个问题。

先说一下我们公司的情况，我们公司有流程中心，也就是开发会在上面选择库，提交SQL，DBA收到工单以后人工审核，手工执行。

在审核过程中，对于DBA来说，肉眼审核也太过于辛酸了，手工执行一不小心就是背黑锅。所以，基于goinception，我这边提供了几个restful的接口，分别如下：

1.  db信息接口，根据用户权限，返回该用户所能看到的dbname
2.  SQL检查接口，用户提交SQL，调用goinception进行审核，审核通过以后到DBA
3.  SQL执行接口，DBA选择执行的实例，调用goinception进行SQL执行，执行完成以后通知开发工单完成
4.  开发查看工单，可以下载对应的回滚SQL

这样一来，DBA的双手可以大大地解放了，不仅提高了工作效率，并且能够准确无误地执行SQL，减少背黑锅的概率，还提供了回滚SQL的功能，假如开发发现SQL提交有误可以及时查看回滚SQL进行数据修复。