用户使用手册
Moonbox月光宝盒是一款流量回放平台产品，提供可视化的操作使用界面。关于平台的部署请参考项目 Readme 文件。本文着重介绍平台的主要功能和操作方法.
操作路径为：【流量录制-新增模板/编辑】。下面按照页面区域讲解配置项
应用名称： server端接口 /api/app/appNameList 返回，server部署前需修改为用户自身应用标识。需要注意的是，jvm参数需包含该应用标识，否则”远程录制“方式无法启动
单接口采集量：单个接口的最大采集量
任务运行时长：录制任务运行时长，超过该时长后，录制任务为自动关闭
很多新手朋友对上面的"应用名称"和"jvm参数标识"表示疑惑，不知道如何配置和使用，补充说明如下：
- 为了演示方便，"应用名称" 下拉列表对应的数据默认是在接口中硬编码实现的。生产使用时建议自行扩展，可以考虑从数据库、CMDB、注册中心/配置中心等中读取数据；
- "jvm启动参数标识" 是未做强制规范约定的，建议在目标应用启动脚本中使用类似"-DappName=item-center"（item-center是目标应用名/服务名）。
录制的流量类型，目前平台支持 http接口，dubbo接口和java方法的录制。
http uri： 填写http接口相对地址，支持path variable方配置，如/api/thread/{}
采样率： 流量录制采样比率，最大值为 10000，最小值为1
接口名称： 支持正则表达式。采集某个具体接口：com.vivo.test.query.TestRecordApi、采集所有接口：.*
接口方法： 支持正则表达式。采集某个具体方法名：testRecord、采集所有方法：.*
同上，参考dubbo
java方法录制比较特殊，由于是依托于spring实现，因此有如下限制：
-
被录制的方法必须在被Spring容器托管的 bean 中
-
录制的Java方法必须是 无入参、无返回值 的方法，例如被 @Scheduled 注解修饰定时任务方法
-
必须提供一个 获取Spring上下文的静态方法 ，如下所示
@Component public class ApplicationContextUtils implements ApplicationContextAware { private static ApplicationContext applicationContext; @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { ApplicationContextUtils.applicationContext = applicationContext; } public static ApplicationContext getApplicationContext() { return applicationContext; } }
如下图所示，在java方法采集配置时，需要在此处填写上下文方法
插件类型：展示所有支持的插件(即子调用)类型，点击选择本次使用插件。若录制的接口包含该类型子调用但 未选择该插件，则 录制时不会记录该子调用数据；回访时无法对子调用进行mock
step1：运行录制任务
选择上一步创建的录制模板，点击运行按钮，填写 目标 java进程 所在机器的ip、ssh端口、用户名 和密码。点击执行
step2：运行成功
执行成功后，在流量录制功能页会 展示启动成功的任务。在此界面进行任务的停止、查看任务日志、查看录制流量详情等功能
step1：运行接口执行录制
若配置的录制接口有访问流量，且被采样成功，则会在下图出显示。采集的流量数据会在列表分页展示
step2：流量详情
点击“详情”按钮可以查看该条录制的流量详情。包括请求的参数、响应参数 和 该请求的 子调用列表
step3：子调用详情
点击某个子调用，可以查看子调用的详情。包括子调用的入参和响应结果。下图以mybatis子调用举例
流量回放操作有两个入口：一个为【流量录制-录制模板-执行任务-流量回放】，另一个为【流量录制-流量回放-回放任务列表-(失败回放/重新回放)】
录制处回放入口如下图所示：
需要进行回放的数据可以手动选择配置；执行机器处填写 需要回放的 JVM进程 ip、端口、用户名和密码。
此处可以选择sandbox和repeater的日志级别，日志会在目标JVM的业务日志中展示。
选择不同的回放插件，在回放时候可以进行子调用比对和返回结果MOCK。
回放执行的进度会在【流量回放-回放任务列表】中展示。回放的结果按照 回放接口 分组展示
- 全部成功：该接口下所有流量均回放成功
- 部分成功：该接口下部分流量回放成功
- 全部失败：该接口下所有流量均回放失败
点击回放任务会展示此次回放任务的执行结果
点击单个流量详情按钮，可以展示此条回放详细信息。包括 响应内容 和 子调用 比对信息
单条流量回放失败，主要有以下几种失败原因：结果对比失败、子调用未匹配、子调用入参对比失败
指的是入口调用返回值对比时，产生了差异。月光宝盒平台会对比原始结果和回放结果，对差异点进行高亮展示
指回放时，子调用类型匹配异常，有增多或者减少。常见于代码逻辑产生改动
指子调用参数比对存在问题，回放结果异常。特别说明的是，回访时只对子调用参数进行比对；若参数匹配一致，则对于子调用进行mock，返回录制时记录的结果
此功能主要是在回放过程中，忽略对比的某个差异项，包括子调用参数差异 和 回放结果对比差异项。配置入口有两处
可以在回放详情页(路径为【流量回放-回放结果】) 对差异项进行忽略。如下图所示，可以选择需要忽略的参数路径，默认为最小粒度
可以在【回放对比配置】菜单项内，进行差异项忽略配置。也可以对已有的配置进行查询搜索。如下图所示：
- 忽略路径：指需要忽略的参数路径,$符号为根路径标识，支持按照根路径忽略
- 忽略接口：需要忽略的接口，可以是入口url也可以是子调用url
- 接口类型：入口或子调用类型，需要和忽略接口保持一致
相比于“回放详情页”，此处配置略微复杂，需要手动填写接口和参数信息。建议在“回放详情页”直接操作
配置完成后，原先回放异常的流量可以 回放成功。如下图所示，即使结果中出现了差异项，回放结果也是成功状态
回放类&方法mock是一种特殊的mock类型，分为时间mock和普通java方法mock两种
选择时间mock方式(下拉框第一条)，在类名处填写需要mock的入口类信息。系统会对需要改类以及内部调用的所有时间信息进行mock
此mock方式和子调用mock 非常相似，是对特定的某个java类或方法进行mock返回（由UniversalPlugin 插件处理），可以用在例如 随机数 等场景上，提升回放成功率。该配置全局生效
此功能主要为了在moonbox-server服务上传agent文件(包括sandbox-agent 和 moonbox-agent)，以供moonbox-agent端下载使用。 若是本机部署(wins/mac)测试且未修改moonbox-agent源码，可以忽略此章节！！！
如果对moonbox-agent代码未做修改，那么直接使用代码工程中打包好的agent文件
如上图所示点击 moonbox-agent 行 “文件更新”按钮，选择本地的 moonbox-agenr.tar文件。等待文件上传完成
如上图所示点击 sandbox-agent 行 “文件更新”按钮，选择本地的 sandbox-stable-bin.tar 文件等待文件上传完成
如修改过moonbox-agent代码，那么需要把修改过的agent代码重新打包。打包步骤如下
执行 mvn clean install操作
# 执行打包命令，命令路径为 /moonbox-agent/moonbox-java-agent/bin
sh ./install-local-agent.sh linux/mac环境可以直接运行；windows环境可以在git-bash客户端中运行该命令。命令执行完毕后，会在 /moonbox-agent/moonbox-java-agent/target/.sandbox-module 下 生成新的moonbox-agent.tar文件
moonbox-agent “文件更新”上传包，可以选择step2打包生成的 agengt文件即可。
sandbox-agent “文件更新”上传包，可以和使用 /local-agent目录下的 sandbox包