自動補全、回滾!介紹一款可視化 sql 診斷利器

Yearning簡介

=================

Yearning MYSQL 是一個SQL語句審核平台。提供查詢審計,SQL審核等多種功能,支援Mysql,可以在一定程度上解決運維與開發之間的那一環,功能豐富,程式碼開源,安裝部署容易!

項目地址://gitee.com/cookieYe/Ye…

注意:

Yearning 1.x版本需inception提供SQL審核及回滾功能。

Yearning 2.0開始無需依賴Inception,已自己實現了SQL審核/回滾功能

Yearning 功能介紹

================

  • SQL查詢
  • 查詢工單
  • 導出
  • 自動補全,智慧提示
  • 查詢語句審計
  • SQL審核
  • 流程化工單
  • SQL語句檢測與執行
  • SQL回滾
  • 歷史審核記錄
  • 推送
  • E-mail工單推送
  • 釘釘webhook機器人工單推送
  • 用戶許可權及管理
  • 角色劃分
  • 基於用戶的細粒度許可權
  • 註冊
  • 其他
  • todoList
  • LDAP登錄
  • 動態審核規則配置
  • AutoTask自動執行

Yearning安裝

Yearning 不依賴於任何第三方SQL審核工具作為審核引擎,內部已自己實現審核/回滾相關邏輯。

  • 僅依賴Mysql資料庫。mysql版本必須5.7及以上版本,創建Yearning庫字符集應為UTF8mb4(僅Yearning所需mysql版本)
  • Yearning日誌僅輸出error級別,沒有日誌即可認為無運行錯誤!
  • Yearning 基於1080p解析度開發僅支援1080p及以上顯示器訪問

Yearning下載

Yearning-go官方提供二進位下載包,下載地址 //github.com/cookieY/Ye…。選擇你所需要下載的軟體包進行下載。

源碼安裝:你先需要安裝一些依賴等,一些相關的安裝步驟如下:

[root@test ~]# git clone //github.com/cookieY/Yearning.git  
[root@test ~]# mv Yearning /usr/local/yearning  
[root@test ~]# cd /usr/local/yearning/  
[root@test yearning]# cd install/  
[root@test install]# ll  
total 26728  
-rw-r--r-- 1 root root 57763 Apr 23 16:06 connections.py  
-rw-r--r-- 1 root root 16818 Apr 23 16:06 cursors.py  
-rw-r--r-- 1 root root 679 Apr 23 16:06 docker_start.sh  
-rw-r--r-- 1 root root 27270656 Apr 23 16:06 inception.tar  -rw-r--r-- 1 root root 11762 Apr 23 16:06 Yearning.sh  
[root@test install]# tar xf inception.tar  
[root@test install]# cd inception/bin/  
[root@test bin]# ll  
total 12472  
-rw-r--r-- 1 501 games 722 Jan 3 10:39 inc.cnf  
-rwxr-xr-x 1 501 games 9016999 Oct 12 2017 Inception  
-rwxr-xr-x 1 501 games 3747312 Oct 12 2017 mysql

不過現在官方讓直接下載.zip包,直接解壓即可(所以這裡就不建議使用源碼安裝了),比較方便。

mysql> create database Yearning default character set utf8mb4 collate utf8mb4_unicode_ci;Query OK, 1 row affected (0.00 sec)
mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| Yearning           |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
5 rows in set (0.00 sec)

只需要提前安裝好Mysql資料庫,並按前面的要求進行配置即可。

[root@CentOS7-1 ~]# ll
total 14036
-rw-------. root root     1320 Apr  8 05:08 anaconda-ks.cfg
-rw-r--r--  root root 14349178 Apr 11 09:26 Yearning-2.2.0.linux-amd64.zip

上面我們直接從github上下載的最新版本2.2.0:

[root@CentOS7-1 ~]# cd Yearning-go/
[root@CentOS7-1 Yearning-go]# ll
total 9772
-rw-r--r-- root root     127 Aug  1  2019 conf.toml
drwxr-xr-x root root     116 Apr  22:32 dist
-rw-r--r-- root root     620 Jan  21:06 docker-compose.yml
-rw-r--r-- root root     597 Aug 21  2019 Dockerfile
-rw-r--r-- root root     177 Aug 23  2019 # README
-rwxr--r-- root root 9985356 Apr  22:35 Yearning
-rw-r--r-- root root     283 Jan 15 03:55 yearning.service

修改配置文件

vim conf.toml

[Mysql]
Db = "Yearning"
Host = "127.0.0.1"
Port = "3306"
Password = "xxxx"
User = "root"

[General] #資料庫加解密key,只可更改一次。
SecretKey = "dbcjqheupqjsuwsm"

SecretKey是token/資料庫密碼加密/解密的salt。建議所有用戶在初次安裝Yearning之前將SecretKey更改(不更改將存在安全風險),格式: 大小寫字母均可, 長度必須為16位。

特別注意:此key僅可在初次安裝時更改!之後不可再次更改!如再次更改會導致之前已存放的數據源密碼無法解密,最終導致無法獲取相關數據源資訊。

初始化

./Yearning -m

640.png

務必在-s啟動前首先執行-m 初始化操作!如要再次初始化,需要把yearning庫下所有表刪除,否則重複執行無效。

啟動服務

#默認啟動
./Yearning -s

#參數啟動
./Yearning -s -b "192.168.1.9" -p "8000"

使用幫助


[root@CentOS7-1 Yearning-go]# ./Yearning -h
version: Yearning/2.2.0 general author: HenryYee
Usage: Yearning [-m migrate] [-p port] [-s start] [-b web-bind] [-h help] [-c config file]

Options: -s  啟動Yearning 
-m  數據初始化(第一次安裝時執行) 
-p  埠 
-b  釘釘/郵件推送時顯示的平台地址 
-x  表結構修復,升級時可以操作。如出現錯誤可直接忽略。 
-h  幫助 
-c  配置文件路徑 
-k  用戶許可權變更為許可權組(2.1.7以下升級至2.1.7及以上使用) 
-f  初始化Admin用戶密碼

打開瀏覽器 //192.168.1.9:8000

默認密碼:admin/Yearning_admin

相關功能模組介紹

1、用戶模組

Dashboard:dashboard主要展示Yearning各項數據包括用戶數/數據源數/工單數/查詢數以及其他圖表,個人資訊欄內用戶可以修改密碼/郵箱/真實姓名,同時可以查看該用戶許可權以及申請許可權(申請許可權2.1.7版本後作廢)。

我的工單:展示用戶提交的工單資訊,對於執行失敗/駁回的工單點擊詳細資訊後可以重新修改sql並提交,對於執行成功的工單可以查看回滾語句並且快速提交SQL。

工單DLL:DDL相關SQL提交審核,查看錶結構/索引,SQL語法高亮/自動補全。

DML審核:DML相關SQL提交審核,SQL語法高亮/自動補全。

查詢:查詢/導出數據 SQL語法高亮/自動補全 快速DML語句提交。

2、審核模組

工單審核:DDL/DML管理員審核並執行。

查詢審核:用戶的查詢審核。

許可權審核:用戶的許可權審核(2.1.7版本以下)

3、管理管理模組

用戶管理:創建/修改/刪除用戶

資料庫管理:添加/編輯/刪除 數據源

用戶許可權:用戶許可權修改/清空

功能設置:設置消息推送相關資訊 包括釘釘機器人/email,設置LDAP相關資訊,全局配置資訊,全局配置開關

審核規則:設置SQL檢測規則

AutoTask自動執行任務

2.1.4版本新增:用戶可通過改功能設置自動執行任務。當提交的dml語句符合相應任務條件。將會自動執行,無需審核人審核。該功能僅限dml語句使用。請慎重使用!

總結

Yearning是一個SQL審核平台,在一定程度上可以解決運維與開發中間的問題,遺憾的是只支援Mysql,感興趣的可以嘗試下!

參考資料:
//guide.yearning.io/
//gitee.com/cookieYe/Ye…