前言
Tsung對(duì)具體協(xié)議、通道的支持，一般以插件形式提供接口，接口不是很復(fù)雜，插件也很容易編寫(xiě)，支持協(xié)議多，也就不足為怪了。
下面首先梳理一下當(dāng)前Tsung 1.6.0所有內(nèi)置插件，然后為一個(gè)名稱(chēng)為Qmsg的私有二進(jìn)制協(xié)議編寫(xiě)插件, 運(yùn)行Qmsg服務(wù)器端程序，執(zhí)行壓力測(cè)試，最后查看測(cè)試報(bào)告。
已支持插件梳理
Tsung 1.6.0支持的協(xié)議很多，簡(jiǎn)單梳理一下：
?
- 壓測(cè)的協(xié)議首先需要支持xml形式配置，配置內(nèi)容需要
tsung_config_protocolname 模塊解析
- 其次是tsung client端也要插件
ts_protocolname 模塊支持?jǐn)?shù)據(jù)操作
- 同時(shí)在tsung項(xiàng)目examples目錄下也給出了已支持協(xié)議配置簡(jiǎn)單示范xml文件
已經(jīng)支持協(xié)議簡(jiǎn)單說(shuō)明：
- amqp，Advanced Message Queuing Protocol縮寫(xiě)，只要支持高級(jí)消息隊(duì)列協(xié)議的應(yīng)用，都可以用來(lái)做壓測(cè)，比如RabbitMQ，ActiveMQ等
- http，基本協(xié)議，構(gòu)建于HTTP協(xié)議之上的，還有類(lèi)似于BOSH，WebDav等上層業(yè)務(wù)協(xié)議
- jabber，也稱(chēng)之為XMPP，支持的相當(dāng)豐富，除了TCP/SSl，還可以通過(guò)Websocekt進(jìn)行傳遞
- raw，針對(duì)原始類(lèi)型消息，不做編解碼處理，直接在TCP / UDP / SSL等傳輸層中傳遞，這個(gè)對(duì)部分私有協(xié)議，比較友好，不用寫(xiě)單獨(dú)的編解碼處理，直接透?jìng)骱昧?/li>
- shell，針對(duì)LInux/Unix終端命令調(diào)用進(jìn)行壓測(cè)，這種場(chǎng)景比較小眾
- fs，filesystem縮寫(xiě)，針對(duì)文件系統(tǒng)的讀寫(xiě)性能進(jìn)行壓測(cè)
- job，針對(duì)任務(wù)調(diào)度程序進(jìn)行的壓測(cè)，比如PBS/torqueLSF、OAR等
Tsung插件工作機(jī)制
粗一點(diǎn)來(lái)看Tsung插件的工作流程（點(diǎn)擊可以看大圖）：
?
放大一些（引用 hncscwc 博客圖片，相當(dāng)贊！）：
為什么要編寫(xiě)插件
Tsung針對(duì)通用協(xié)議有支持，若是私有或不那么通用的協(xié)議，就不會(huì)有專(zhuān)門(mén)的插件支持了，那么可選的有兩條路子：
- 使用raw模式發(fā)送原始消息，需要自行組裝
- 自己編寫(xiě)插件，靈活處理編解碼
既然談到了插件，我們也編寫(xiě)一個(gè)插件也體驗(yàn)一下編寫(xiě)插件的過(guò)程。
Qmsg協(xié)議定義
假設(shè)一個(gè)虛擬場(chǎng)景，打造一個(gè)新的協(xié)議Qmsg，二進(jìn)制格式組成：
?
這種隨意假象出來(lái)的格式，不妨稱(chēng)作為qmsg（Q可愛(ài)形式的message）協(xié)議，僅作為Demo演示而存在。簡(jiǎn)單場(chǎng)景：
- 用戶(hù)發(fā)言，包含用戶(hù)id和發(fā)言?xún)?nèi)容
- User ID，32位自然數(shù)類(lèi)型
- 發(fā)言為文字內(nèi)容，字符串形式，長(zhǎng)度不固定
- 組裝后的請(qǐng)求體為二進(jìn)制協(xié)議格式
PocketLen:**##UserId + UserComment##**
- 服務(wù)器端返回用戶(hù)ID和一個(gè)幸運(yùn)數(shù)字(32位表示)
PocketLen:**##UserId + RandomCode##**
為了卡哇伊一些，多了一些點(diǎn)綴的“**####**”符號(hào)。
編寫(xiě)一個(gè)完整插件
這里基于Tsung 1.6.0版本構(gòu)建一個(gè)Qmsg插件，假定你懂一些Erlang代碼，以及熟悉Tsung一些基本概念。
0. 創(chuàng)建一個(gè)項(xiàng)目
要?jiǎng)?chuàng)建Tsung的一個(gè)Qmsg插件項(xiàng)目，雖沒(méi)有固定規(guī)范，但按照已有格式組織好代碼層級(jí)也是有必要的。
├── include
│?? └── ts_qmsg.hrl
├── src
│?? ├── tsung
│?? │?? └── ts_qmsg.erl
│?? └── tsung_controller
│?? └── ts_config_qmsg.erl
└── tsung-1.0.dtd
1. 創(chuàng)建配置文件
Tsung的壓測(cè)以xml文件驅(qū)動(dòng)，因此需要界定一個(gè)Qmsg插件形式的完整會(huì)話(huà)的XML呈現(xiàn)，比如：
<session probability="100" name="qmsg-demo" type="ts_qmsg">
<request>
<qmsg uid="1001">Hello Tsung Plugin</qmsg>
</request>
<request>
<qmsg uid="1002">This is a Tsung Plugin</qmsg>
</request>
</session>
ts_qmsg，會(huì)話(huà)類(lèi)型所依賴(lài)協(xié)議模擬客戶(hù)端實(shí)現(xiàn)<qmsg uid="Number">Text</qmsg> 定義了qmsg會(huì)話(huà)可配置形式，內(nèi)嵌在request元素內(nèi)uid為屬性
此時(shí)，你若直接在xml文件中編輯，會(huì)遇到校驗(yàn)錯(cuò)誤。
2. 更新DTD文件
Tsung的xml文件依賴(lài)tsung-1.0.dtd文件進(jìn)行校驗(yàn)配置是否有誤，需要做對(duì)DTD文件做修改，以支持所添加新的協(xié)議。
在tsung-1.0.dtd項(xiàng)目中，最小支持：
- session元素type屬性中添加上
ts_qmsg
- request元素處添加
qmsg :
<!ELEMENT request ( match*, dyn_variable*, ( http | jabber | raw | pgsql | ldap | mysql |fs | shell | job | websocket | amqp | mqtt | qmsg) )>
- 添加qmsg元素定義：
<!ELEMENT qmsg (#PCDATA) >
<!ATTLIST qmsg
uid CDATA "0"
ack (local | no_ack | parse) #REQUIRED
>
完整內(nèi)容，可參考tsung_plugin_demo/tsung-1.0.dtd文件。
3. 頭文件 include/ts_qmsg.hrl
頭文件include/ts_qmsg.hrl定義數(shù)據(jù)保存的結(jié)構(gòu)（也稱(chēng)之為記錄/record）：
-record(qmsg_request, {
uid,
data
}).
-record(qmsg_dyndata, {
none
}
).
- qmsg_request: 存儲(chǔ)從xml文件解析的qmsg請(qǐng)求數(shù)據(jù)，用于生成壓力請(qǐng)求
- qmsg_dyndata: 存儲(chǔ)動(dòng)態(tài)參數(shù)（當(dāng)前暫未使用到）
4. XML文件解析
ts_config_qmsg.erl文件，用于解析和協(xié)議Qmsg關(guān)聯(lián)的配置：
- 只需要實(shí)現(xiàn)parse_config/2唯一方法
- 解析xml文件中所配置Qmsg協(xié)議請(qǐng)求相關(guān)配置
- 被ts_config:parse/1在遇到Qmsg協(xié)議配置時(shí)調(diào)用
備注：
- 若要支持動(dòng)態(tài)替換，需要的字段以字符串形式讀和存儲(chǔ)
5. ts_qmsg.erl
ts_qmsg.erl模塊主要提供Qmsg協(xié)議的編解碼的完整動(dòng)作, 以及當(dāng)前協(xié)議界定下的用戶(hù)會(huì)話(huà)屬性設(shè)定。
首先需要實(shí)現(xiàn)接口ts_plugin規(guī)范定義的所有需要函數(shù)，定義了參數(shù)值和返回值。
-behavior(ts_plugin).
...
-export([add_dynparams/4,
get_message/2,
session_defaults/0,
subst/2,
parse/2,
parse_bidi/2,
dump/2,
parse_config/2,
decode_buffer/2,
new_session/0]).
相對(duì)來(lái)說(shuō)，核心為協(xié)議的編解碼功能：
get_message/2，構(gòu)造請(qǐng)求數(shù)據(jù)，編碼成二進(jìn)制，上層ts_client模塊通過(guò)Socket連接發(fā)送給目標(biāo)服務(wù)器parse/2，(當(dāng)對(duì)響應(yīng)作出校驗(yàn)時(shí))從原始Socket上返回的數(shù)據(jù)進(jìn)行解碼，取出協(xié)議定義業(yè)務(wù)內(nèi)容
這部分代碼可以參考 tsung_plugin_demo/src/tsung/ts_client.erl 文件。
6. 如何編譯
雖然理論上可以單獨(dú)編，生成的beam文件直接拷貝到已經(jīng)安裝的tsung對(duì)應(yīng)目錄下面，但實(shí)際上插件編寫(xiě)過(guò)程中要依賴(lài)多個(gè)tsung的hrl文件，這造成了依賴(lài)路徑問(wèn)題。采用直接和tsung打包一起部署，實(shí)際操作上有些麻煩，
為了節(jié)省體力，使用一個(gè)shell腳本 - build_plugin.sh，方便快速編譯、部署：
# !/bin/bash
cp tsung-1.0.dtd $1/
cp include/ts_qmsg.hrl $1/include/
cp src/tsung_controller/ts_config_qmsg.erl $1/src/tsung_controller/
cp src/tsung/ts_qmsg.erl $1/src/tsung/
cd $1/
make uninstall
./configure --prefix=/usr/local
make install
這里指定安裝Tsung的指定目錄為/usr/local，可以根據(jù)需要修改
需要提前準(zhǔn)備好tsung-1.6.0目錄：
wget http://tsung.erlang-projects.org/dist/tsung-1.6.0.tar.gz
tar xf tsung-1.6.0.tar.gz
在編譯Qmsg插件腳本時(shí), 指定一下tsung-1.6.0解壓后的路徑即可：
sh build_plugin.sh /your_path/tsung-1.6.0
后面嘛，就等著自動(dòng)編譯和安裝唄。
啟動(dòng)Qmsg協(xié)議的壓測(cè)
1. 首先啟動(dòng)Qmsg服務(wù)器端程序
既然有壓測(cè)端，就需要一個(gè)Qmsg協(xié)議處理的后端程序qmsg_server.erl，用于接收客戶(hù)端請(qǐng)求，獲得用戶(hù)ID值之后，生成一個(gè)隨機(jī)數(shù)字，組裝成二進(jìn)制協(xié)議，然后發(fā)給客戶(hù)端，這就是全部功能。
這個(gè)程序，簡(jiǎn)單一個(gè)文件，在 tsung_plugin_demo目錄下面，編譯運(yùn)行, 默認(rèn)監(jiān)聽(tīng)5678端口：
erlc qmsg_server.erl && erl -s qmsg_server start
另外，還提供了一個(gè)手動(dòng)調(diào)用接口，方便在Erlang Shell端調(diào)試：
%% 下面為
qmsg_server:sendmsg(1001, "這里是用戶(hù)發(fā)言").
啟動(dòng)之后，監(jiān)聽(tīng)地址 *: 5678
源碼見(jiàn)：tsung_plugin_demo/qmsg_server.erl
2. 編寫(xiě)Qmsg壓測(cè)XML配置文件
因?yàn)槭茄菔臼痉叮慌_(tái)Linxu主機(jī)上就可以進(jìn)行了：
- 連接本機(jī)的 127.0.0.1:5678
- 最多產(chǎn)生10個(gè)用戶(hù)，每秒產(chǎn)生1個(gè)，壓力負(fù)載設(shè)置的很低
- 兩個(gè)不同類(lèi)型會(huì)話(huà)，比重10% + 90% = 100%
qmsg-subst-example會(huì)話(huà)使用了用戶(hù)ID個(gè)和用戶(hù)發(fā)言?xún)?nèi)容自動(dòng)生成機(jī)制
<tsung loglevel="debug" dumptraffic="false" version="1.0">
<clients>
<client host="localhost" use_controller_vm="true"/>
</clients>
<servers>
<server host="127.0.0.1" port="5678" type="tcp"/>
</servers>
<load>
<arrivalphase phase="1" duration="1" unit="minute">
<users maxnumber="10" interarrival="1" unit="second"/>
</arrivalphase>
</load>
<sessions>
<session probability="10" name="qmsg-example" type="ts_qmsg">
<request>
<qmsg uid="1001" ack="parse">Hello Tsung Plugin Qmsg!</qmsg>
</request>
</session>
<session probability="90" name="qmsg-subst-example" type="ts_qmsg">
<setdynvars sourcetype="random_number" start="3" end="32">
<var name="random_uid"/>
</setdynvars>
<setdynvars sourcetype="random_string" length="13">
<var name="random_txt"/>
</setdynvars>
<request subst="true">
<qmsg uid="%%_random_uid%%" ack="parse">Haha : %%_random_txt%%</qmsg>
</request>
<thinktime value="6"/>
<request subst="true">
<qmsg uid="%%_random_uid%%" ack="parse">This is a Tsung Plugin</qmsg>
</request>
</session>
</sessions>
</tsung>
這部分內(nèi)容，請(qǐng)參考 tsung_plugin_demo/tsung_qmsg.xml 文件。
3. 執(zhí)行壓力測(cè)試
當(dāng)Qmsg的壓力測(cè)試配置文件寫(xiě)好之后，可以開(kāi)始執(zhí)行壓力測(cè)試了：
tsung -f tsung_qmsg.xml start
其輸出：
tarting Tsung
Log directory is: /root/.tsung/log/20160621-1334
[os_mon] memory supervisor port (memsup): Erlang has closed
[os_mon] cpu supervisor port (cpu_sup): Erlang has closed
其中, 其日志為：/root/.tsung/log/20160621-1334。
4. 查看壓測(cè)報(bào)告
進(jìn)入其生成壓測(cè)日志目錄，然后生成報(bào)表，查看壓測(cè)結(jié)果哈：
cd /root/.tsung/log/20160621-1334
/usr/local/lib/tsung/bin/tsung_stats.pl
echo "open your browser (URL: http://IP:8000/report.html) and vist the report now :))"
/usr/bin/python -m SimpleHTTPServer
嗯，打開(kāi)你的瀏覽器，輸出所在服務(wù)器的IP地址，就可以看到壓測(cè)結(jié)果了。
小結(jié)
以上代碼已經(jīng)放入github倉(cāng)庫(kù)：https://github.com/weibomobile/tsung_plugin_demo。
實(shí)際業(yè)務(wù)的私有協(xié)議內(nèi)容要比上面Demo出來(lái)的Qmsg復(fù)雜的多，但其私有協(xié)議插件編寫(xiě)，如上面所述幾個(gè)步驟，按照規(guī)范編寫(xiě)，單機(jī)測(cè)試，然后延伸到分布式集群，完整流程都是一致的。
嗯，搞定了插件，就可以對(duì)系統(tǒng)愉快地進(jìn)行壓測(cè)了 :))