sql自動化檢查和分析工具 之soar和soar-web 安裝和使用體驗(yàn)

# prepare dir and install
mkdir -p /opt/soft/soar && mkdir -p /opt/install/soar/{log,conf}
wget -O /opt/soft/soar/soar -c https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.linux-amd64

# install server
mv /opt/soft/soar/soar /opt/install/soar
 
# 目錄介紹：
# 配置文件為yaml格式。一般情況下只需要配置online-dsn, test-dsn, log-output等少數(shù)幾個(gè)參數(shù)。即使不創(chuàng)建配置文件SOAR仍然會給出基本的啟發(fā)式建議。
# 默認(rèn)文件會按照/etc/soar.yaml, ./etc/soar.yaml, ./soar.yaml順序加載，
# 找到第一個(gè)后不再繼續(xù)加載后面的配置文件。如需指定其他配置文件可以通過-config參數(shù)指定。
# 關(guān)于數(shù)據(jù)庫權(quán)限online-dsn需要相應(yīng)庫表的SELECT權(quán)限，test-dsn需要root最高權(quán)限。
 
# 修改默認(rèn)配置參數(shù)，如下
# 參考
# # 1. 修改soar.conf的基本參數(shù)
root >> cat > /opt/install/soar/conf/soar.yaml << EOF
# 線上環(huán)境配置
online-dsn:
 addr: CNT7XMYSQLD01:13306
 schema: sakila
 user: root
 password: 1t'sB1g3rt
 disable: false
# 測試環(huán)境配置
test-dsn:
 addr: CNT7XMYSQLD01:13307
 schema: test
 user: root
 password: 1t'sB1g3rt
 disable: false
# 是否允許測試環(huán)境與線上環(huán)境配置相同
allow-online-as-test: true
# 是否清理測試時(shí)產(chǎn)生的臨時(shí)文件
drop-test-temporary: true
# 語法檢查小工具
only-syntax-check: false
sampling-statistic-target: 100
sampling: false
# 日志級別，[0:Emergency, 1:Alert, 2:Critical, 3:Error, 4:Warning, 5:Notice, 6:Informational, 7:Debug]
log-level: 7
log-output: ${SOAR_LOG_DIR}/soar.log
# 優(yōu)化建議輸出格式
report-type: markdown
ignore-rules:
- ""
# 黑名單中的 SQL 將不會給評審意見。一行一條 SQL，可以是正則也可以是指紋，填寫指紋時(shí)注意問號需要加反斜線轉(zhuǎn)義。
blacklist: ${SOAR_CONF_DIR}/soar.blacklist
# 啟發(fā)式算法相關(guān)配置
max-join-table-count: 5
max-group-by-cols-count: 5
max-distinct-count: 5
max-index-cols-count: 5
max-total-rows: 9999999
spaghetti-query-length: 2048
allow-drop-index: false
# EXPLAIN相關(guān)配置
explain-sql-report-type: pretty
explain-type: extended
explain-format: traditional
explain-warn-select-type:
- ""
explain-warn-access-type:
- ALL
explain-max-keys: 3
explain-min-keys: 0
explain-max-rows: 10000
explain-warn-extra:
- ""
explain-max-filtered: 100
explain-warn-scalability:
- O(n)
query: ""
list-heuristic-rules: false
list-test-sqls: false
verbose: true
root >> EOF
 step 3: 準(zhǔn)備環(huán)境變量

# env parameter and path
echo '' >> /etc/profile && \
echo 'SOAR_HOME=/opt/install/soar' >> /etc/profile && \
echo 'SOAR_CONF_DIR=$SOAR_HOME/conf' >> /etc/profile && \
echo 'SOAR_LOG_DIR=$SOAR_HOME/log' >> /etc/profile && \
echo 'PATH=$PATH:$SOAR_HOME' >> /etc/profile && \
source /etc/profile
 step 4: 文件賦予權(quán)限

chmod -R 777 $SOAR_HOME/soar
 step 5: 檢查soar全局配置生效

# 查看版本
soar -version
 
# 打印所有的啟發(fā)式規(guī)則
soar -list-heuristic-rules
 
# 打印支持的報(bào)告格式
soar -list-report-types

# 1.1 安裝python3 和 python3-pip 和 gcc (gcc在源代碼安裝pycryptodome等python組件時(shí)候需要)
yum install -y python36 python36-pip gcc
 
# 檢查python3安裝結(jié)果
python -V
# 檢查pip已經(jīng)安裝的python組件
python3 -m pip list
# 卸載pip組件
# python3 -m pip uninstall "packagename"
 
# 1.2 flask (必須先安裝python3)
# 安裝教程：https://www.cnblogs.com/wobeinianqing/p/7650498.html
# yum install -y flask
python3 -m pip install flask
 
 
# 1.3 安裝 pymysql (必須先安裝python3)
# 安裝教程：https://blog.csdn.net/qq_37788558/article/details/73716002
# 安裝教程：https://github.com/PyMySQL/PyMySQL
python3 -m pip install PyMySQL
 
 
# 1.4 安裝 pycryptodome (必須先安裝python3)
python3 -m pip install pycryptodome
# 如果pip下載速度慢，可以用如下命令
#### 或 安裝方式2，如下
python3 -m pip install /opt/soft/soar/pycryptodome-3.9.6.tar.gz
#### 或 安裝方式3，如下
# 格式 = python3 -m pip install https://pypi.tuna.tsinghua.edu.cn/simple/simple/{包名}
# 格式 = python3 -m pip install https://pypi.doubanio.com/simple/{包名}
python3 -m pip install https://pypi.tuna.tsinghua.edu.cn/simple/pycryptodome-3.9.6.tar.gz

# 2.1 下載soar-web的源代碼
wget -O /opt/soft/soar/soar-web-master.zip -c https://codeload.github.com/xiyangxixian/soar-web/zip/master
yum install -y unzip
unzip /opt/soft/soar/soar-web-master.zip -d /opt/soft/soar/
 
# 2.2 安裝soar-web
mkdir -p /opt/install/soar-web && \
mv /opt/soft/soar/soar-web-master/* /opt/install/soar-web
# 運(yùn)行soar-web
chmod -R 777 /opt/install/soar-web/run.sh
bash /opt/install/soar-web/run.sh
 
# 2.3 或者如下方法啟動soar-web
cd /opt/install/soar-web/
python3 ./soar-web.py install