流量錄製回放工具jvm-sandbox-repeater入門篇——服務部署

趨於當前技術不斷更新、產品功能多元化之下，流量回放的熱度也是越來越高。

在前一段時間，測試團隊也提到阿里開源的流量回放工具 jvm-sandbox-repeater

我個人就先嚐試一下，期間還是遇到一些問題，通過諮詢和度孃的幫助下，整體功能的使用流程是跑通了。

jvm-sandbox-repeater簡介

在聊之前，我們先來了解下jvm-sandbox-repeater，其實在官網上也有詳細的介紹，這裡就直接搬官網的吧

jvm-sandbox-repeater是JVM-Sandbox生態體系下的重要模組，它具備了JVM-Sandbox的所有特點，外掛式設計便於快速適配各種中介軟體，封裝請求錄製/回放基礎協議，也提供了通用可擴充套件的各種豐富API。

目標人群

• 線上有個使用者請求一直不成功，我想在測試環境Debug一下，能幫我復現一下嗎？

• 壓測流量不知道怎麼構造，資料結構太複雜，壓測模型也難以評估，有什麼好的辦法嗎？

• 不想寫介面測試指令碼了，我想做一個流量錄製系統，把線上使用者場景做業務迴歸，可能會接入很多服務系統，不想讓每個系統都進行改造，有好的框架選擇嗎？

• 我想做一個業務監控系統，對線上核心介面取樣之後做一些業務校驗，實時監控業務正確性。

如果你有以上的想法或需求，jvm-sandbox-repeater 都將是你的不二選擇方案；框架基於JVM-Sandbox，擁有JVM-Sandbox的一切特性，同時封裝了以下能力：

• 錄製/回放基礎協議，可快速配置/編碼實現一類中介軟體的錄製/回放
• 開放資料上報，對於錄製結果可上報到自己的服務端，進行監控、迴歸、問題排查等上層平臺搭建

repeater的核心能力

• 通用錄製/回放能力
  無侵入式錄製HTTP/Java/Dubbo入參/返回值錄製能力（業務系統無感知）
  基於TTL提供多執行緒子呼叫追蹤，完整追蹤一次請求的呼叫路徑
  入口請求（HTTP/Dubbo/Java）流量回放、子呼叫（Java/Dubbo）返回值Mock能力

• 快速可擴充套件API實現
  錄製/回放外掛式架構
  提供標準介面，可通過配置/簡單編碼實現一類通用外掛

• standalone工作模式
  無需依賴任何服務端/儲存，可以單機工作，提供錄製/回放能力

repeater的應用場景

• 業務快速回歸
  基於線上流量的錄製/回放，無需人肉準備自動化測試指令碼、準備測試資料

• 線上問題排查
  錄製回放提供"昨日重現"能力，還原線上真實場景到線下做問題排查和Debug
  動態方法入參/返回值錄製，提供線上快速問題定位

• 壓測流量準備
  0成本錄製HTTP/Dubbo等入口流量，作為壓測流量模型進行壓測

• 實時業務監控
  動態業務監控，基於核心介面資料錄製迴流到平臺，對介面返回資料正確性進行校驗和監控

jvm-sandbox-repeater服務部署

環境準備

建議在Linux環境下使用，windows下可能會出現路徑不一致的情況，我使用的環境如下：

• Linux
• JDK 1.8
• Maven 3.2
• Mysql 5.7

如果只是想簡單體驗下，則用不到Mysql，可以參考官網的使用者手冊

安裝repeater

克隆原始碼

git clone https://github.com/alibaba/jvm-sandbox-repeater.git

安裝repeater

進入到jvm-sandbox-repeater專案bin目錄下，執行命令./install-repeater.sh

介面展示如下所示，則說明安裝成功

修改repeater配置

路徑為：~/.sandbox-module/cfg/repeater.properties

主要修改2個值

• repeat.standalone.mode，修改為false

# 是否開啟離線工作模式
repeat.standalone.mode=false

• url主機地址和埠，這個按需修改，每個人的伺服器地址都不一樣

# 錄製訊息投遞地址
broadcaster.record.url=http://127.0.0.1:8001/facade/api/record/save

# 回放結果投遞地址
broadcaster.repeat.url=http://127.0.0.1:8001/facade/api/repeat/save

# 回放訊息取資料地址
repeat.record.url=http://127.0.0.1:8001/facade/api/record/%s/%s

# 配置檔案拉取地址
repeat.config.url=http://127.0.0.1:8001/facade/api/config/%s/%s

說到這裡，可能會疑問，為什麼要修改這2個配置？原因如下：

repeat.standalone.mode控制 repeater 是否以 standalone 模式啟動，我們要與 repeater-console 結合使用，所以配置為false

其他 url 都是與 repeater-console 互動的 url，所以需要將 host 改為本地啟動的 repeater-console 的地址

修改console配置

console配置路徑：/jvm-sandbox-repeater/repeater-console/repeater-console-start/src/main/resources/

# 使用本地資料來源進行測試
console.use.localCache =false
# 示例回放地址（工程使用需要維護repeater外掛的ip:port替換，指定ip發起回放）
repeat.repeat.url=http://%s:%s/sandbox/default/module/http/repeater/repeat
# 示例配置地址（工程使用需要維護repeater外掛的ip:port替換，指定ip發起回放）
repeat.config.url=http://%s:%s/sandbox/default/module/http/repeater/pushConfig
# 示例過載地址（工程使用需要維護repeater外掛的ip:port替換，指定ip發起回放）
repeat.reload.url=http://%s:%s/sandbox/default/module/http/repeater/reload

這裡主要修改ip+埠，這個也是按實際服務配置來。console.use.localCache預設為false，不修改即可

建庫建表

由於我這裡是結合console一起使用，所以需要用到Mysql，自然就需要建立所需的資料庫和表。建庫建表語句在專案中是有的，路徑為：/jvm-sandbox-repeater/repeater-console/repeater-console-dal/src/main/resources/database.sql，語句如下所示：

CREATE DATABASE IF NOT EXISTS repeater
    DEFAULT CHARSET utf8
    COLLATE utf8_general_ci;
DROP TABLE IF EXISTS repeater.record;
CREATE TABLE repeater.record
(
    id             BIGINT(20)    NOT NULL AUTO_INCREMENT PRIMARY KEY
        COMMENT '主鍵',
    gmt_create     DATETIME      NOT NULL
        COMMENT '建立時間',
    gmt_record     DATETIME      NOT NULL
        comment '錄製時間',
    app_name       VARCHAR(255)  NOT NULL
        COMMENT '應用名',
    environment    VARCHAR(255)  NOT NULL
        COMMENT '環境資訊',
    host           VARCHAR(36)   NOT NULL
        COMMENT '機器IP',
    trace_id       VARCHAR(32)   NOT NULL
        COMMENT '鏈路追蹤ID',
    entrance_desc  VARCHAR(2000) NOT NULL
        COMMENT '鏈路追蹤ID',
    wrapper_record LONGTEXT      NOT NULL
        COMMENT '記錄序列化資訊',
    request        LONGTEXT      NOT NULL
        COMMENT '請求引數JSON',
    response       LONGTEXT      NOT NULL
        COMMENT '返回值JSON'
)
    ENGINE = InnoDB
    COMMENT = '錄製資訊'
    DEFAULT CHARSET = utf8
    AUTO_INCREMENT = 1;

DROP TABLE IF EXISTS repeater.replay;
CREATE TABLE repeater.replay
(
    id              BIGINT(20)   NOT NULL AUTO_INCREMENT PRIMARY KEY
        COMMENT '主鍵',
    gmt_create      DATETIME     NOT NULL
        COMMENT '建立時間',
    gmt_modified    DATETIME     NOT NULL
        comment '修改時間',
    app_name        VARCHAR(255) NOT NULL
        COMMENT '應用名',
    environment     VARCHAR(255) NOT NULL
        COMMENT '環境資訊',
    ip              VARCHAR(36)  NOT NULL
        COMMENT '機器IP',
    repeat_id       VARCHAR(32)  NOT NULL
        COMMENT '回放ID',
    status          TINYINT      NOT NULL
        COMMENT '回放狀態',
    trace_id        VARCHAR(32)
        COMMENT '鏈路追蹤ID',
    cost            BIGINT(20)
        COMMENT '回放耗時',
    diff_result     LONGTEXT
        COMMENT 'diff結果',
    response        LONGTEXT
        COMMENT '回放結果',
    mock_invocation LONGTEXT
        COMMENT 'mock過程',
    success         BIT
        COMMENT '是否回放成功',
    record_id       BIGINT(20)
        COMMENT '外來鍵'

)
    ENGINE = InnoDB
    COMMENT = '回放資訊'
    DEFAULT CHARSET = utf8
    AUTO_INCREMENT = 1;


DROP TABLE IF EXISTS repeater.module_info;
CREATE TABLE repeater.module_info
(
    id           BIGINT(20)   NOT NULL AUTO_INCREMENT PRIMARY KEY
        COMMENT '主鍵',
    gmt_create   DATETIME     NOT NULL
        COMMENT '建立時間',
    gmt_modified DATETIME     NOT NULL
        comment '修改時間',
    app_name     VARCHAR(255) NOT NULL
        COMMENT '應用名',
    environment  VARCHAR(255) NOT NULL
        COMMENT '環境資訊',
    ip           VARCHAR(36)  NOT NULL
        COMMENT '機器IP',
    port         VARCHAR(12)  NOT NULL
        COMMENT '鏈路追蹤ID',
    version      VARCHAR(128) NOT NULL
        COMMENT '模組版本號',
    status       VARCHAR(36)  NOT NULL
        COMMENT '模組狀態'
)
    ENGINE = InnoDB
    COMMENT = '線上模組資訊'
    DEFAULT CHARSET = utf8
    AUTO_INCREMENT = 1;


DROP TABLE IF EXISTS repeater.module_config;
CREATE TABLE repeater.module_config
(
    id           BIGINT(20)   NOT NULL AUTO_INCREMENT PRIMARY KEY
        COMMENT '主鍵',
    gmt_create   DATETIME     NOT NULL
        COMMENT '建立時間',
    gmt_modified DATETIME     NOT NULL
        comment '錄製時間',
    app_name     VARCHAR(255) NOT NULL
        COMMENT '應用名',
    environment  VARCHAR(255) NOT NULL
        COMMENT '環境資訊',
    config       LONGTEXT     NOT NULL
        COMMENT '配置資訊'
)
    ENGINE = InnoDB
    COMMENT = '模組配置資訊'
    DEFAULT CHARSET = utf8
    AUTO_INCREMENT = 1;

執行完建庫建表語句後，就會生成對應的四張表了。

修改repeater專案程式碼

• #parse("/blocks替換為#parse("blocks

路徑為：/jvm-sandbox-repeater/repeater-console/repeater-console-start/src/main/resources/velocity，將velocity路徑下的所有檔案，存在#parse("/blocks的替換為#parse("blocks

這個點，我是看之前的文章有提及，但我拉取原始碼來看的時候，這個點的問題已經不存在的，原始碼中就已經是#parse("blocks

所以我這個點沒有修改程式碼

• 修改 ReplayController.java

路徑為：/jvm-sandbox-repeater/repeater-console/repeater-console-start/src/main/java/com/alibaba/repeater/console/start/controller/page/ReplayController.java，將return "/replay/detail";修改為return "replay/detail";，去掉雙引號裡面第一個 /

• 修改 RegressPageController.java

路徑為：/jvm-sandbox-repeater/repeater-console/repeater-console-start/src/main/java/com/alibaba/repeater/console/start/controller/test/RegressPageController.java，將return "/regress/index";修改為return "regress/index";，去掉雙引號裡面第一個 /

啟動repeater專案

進入到路徑：/jvm-sandbox-repeater下，使用命令mvn clean install -Dmaven.test.skip=true && java -jar repeater-console/repeater-console-start/target/repeater-console.jar，出現如下所示內容，說明專案構建成功

出現如下所示內容，說明repeater專案啟動成功

訪問repeater-console頁面

通過url http://ip:埠/regress/index.htm，訪問頁面，進入到如下測試頁面，說明通過url訪問也ok，服務沒有問題

該頁面總共三個選單：線上流量、配置管理、線上模組

先簡單講下，線上流量就是錄製的請求，配置管理就是針對要錄製的應用配置，線上模組就是sandbox的心跳。後續文章會繼續講到，今天先簡單描述下。

問題

./install-repeater.sh執行失敗

執行命令，出現如下報錯

解決辦法：

通過命令 vim install-repeater.sh 將 tar xz 中的 z 刪除即可，因為該壓縮包沒有用gzip格式壓縮，所以不用加z引數

啟動repeater專案空指標

啟動repeater專案提示空指標，報錯如下所示：

解決辦法：

module_config、module_info表中的appname和environment不一致，修改為一致即可

以上就是今天分享的內容，下期再會。