每个服务都有属于自身的核心特性。我们将服务的核心特性进行抽象，并使用核心链路这个概念来具象化核心特性。说的更直白一些，核心链路覆盖了核心服务绝大部分功能(超过80%)，例如某服务为交易服务，那么下单链路、付款链路、退单链路、退款链路都属于核心链路。
rattler是一个集核心链路信息收集以及故障自动注入为一体的综合性链路分析工具。rattler主要包含两个核心内容：链路信息收集、自动故障注入。
需要注意的是：这里核心链路的概念并非指的是多个微服务之间通过HTTP或者RPC组成的调用链路，而是指在单个微服务本身中函数之间的链路调用关系。本工具更加适用于偏底层的核心服务，比如支付的记账管理、搜索引擎的广告检索、金融对账结算等类似场景。
在进行迭代开发的过程中，新增或者修改的代码对核心链路的影响一直都有RD评估后给出，缺乏量化的标准。比如现在对交易服务中的某个公共service做了修改，那么这个service的变动会影响那些核心链路呢？这部分目前没有数据支撑。
通过将变动的代码与核心链路中的函数进行比对，可以轻松的找出核心链路中有哪些函数发生了变更。代码的变更最后反馈到核心链路的变更，这样就有了一个量化的数据来衡量本次需求对原有核心链路的影响。
当前工具提供了注解的方式(CoreChainClass注解、CoreChainMethod注解)来收集服务的链路信息，然后将链路信息存储在本地或者上送到指定的远程服务器(Http协议)
1、在需要进行一些异常场景验证时，有些时候数据很难构造，比如让指定核心链路中的函数抛出异常。
rattler提供了一种基于JVM-SANDBOX的故障注入方法，可以根据核心链路信息，来手动选择待注入的函数并完成注入的过程，当前提供了框架的设计，暂时还未实现。
2、在评估系统的稳定性时，需要构造一些随机的数据，来验证各种各样的输入或者抛出的异常是否都可被系统恰当且正确的处理。
该场景需要一种类似于Android上的Monkey测试(测试各种异常输入下App是否会Crash)的随机策略来验证服务的稳定性以及可交互性。 服务的可交互性主要体现在异常发生时应该返回相应的错误码而不是直接将异常抛给上游。
在上述场景中,rattler同样提供了一种基于JVM-SANDBOX基于核心链路的随机故障注入方法，通过对现有EventWatchBuilder的改造，用户可以自定义核心链路的方法选择策略。上述两种场景分别对应故障注入方式有两种：手动注入、自动注入。
目前链路采集方式，目前主要有两种方式：一种手动采集、手动记录，以文本文档的方式存储（xml,yml,xmind,xls），一种为注解方式，现在就主要的收集方式做一下对比:
| 记录方式 | 优势 | 不足 |
| 以注解形式内嵌在代码中 |
|
|
| 文本文档的方式存储（xml,yml,xmind,etc） |
|
|
1、 定义CoreChainClass、CoreChainMethod注解，使用注解在服务工程中进行标注(侵入式)
2、 利用Reflections的反射机制，静态扫描指定package的标注类或者标注方法
3、 将扫描得到的核心链路数据上送到指定的服务或者存储在本地（Local），上送方式目前仅支持HTTP
由于rattler进行链路信息采集，所以需要在项目中集成该项目SDK，通过jar包引入。
在使用之前需要事先通过pom引入jar文件，可以使用本开源的jar包，也可以自行编译上传到私有maven仓库，示例：
<dependency>
<groupId>com.github.airfer</groupId>
<artifactId>rattler-core</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>注解引入，有两种引入方式。可以通过CoreChainClass注解和CoreChainMethod注解引入。由于目前是侵入式收集，会直接修改代码，所以最好和RD一起来做这个事情。 由于链路收集的收集采用静态扫描方式，所以理论上不会对注入服务造成性能影响。为了避免对线上服务造成潜在影响，可以在线上环境可以关闭链路信息收集以及信息上送服务，如何关闭请参见配置说明部分。
由于CoreChain通过Component引入，所以在注解引入后需要在ComponentScan配置中添加rattler所在的包名，示例如下所示。如果对本项目重新打包并变更包名则可省去扫描包添加的步骤。当前对注解标注的权重信息留在下一期支持
- CoreChainClass注解引入
@CoreChainClass(coreChainName="查询链路",weightEnum=MethodWeightEnum.LOW)
public class QueryService{
/**
* 通过Class方式引入，所有在class中的方法都将被标注相同的链路名称，以及链路权重
*/
}- CoreChainMethod注解引入
@Serivice
public class QueryService{
/**
* 通过Method方式引入，只有该Method会被标注，其他方法不会被标注
*/
@Autowired
private CommonService commonService;
@CoreChainMethod(coreChainName="查询链路",weightEnum=MethodWeightEnum.LOW)
private String queryOrderNum(){
try{
return commonService.queryOrderInfo();
}catch (RuntimeException re){
log.error("runtime error");
}
}
}- ComponentScan扫描包添加
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class,MongoAutoConfiguration.class,MongoAutoConfiguration.class, MongoDataAutoConfiguration.class})
@ComponentScan(basePackages = {"com.airfer.rattler"})
public class Application {
}服务引入jar包，并添加链路注解后，需要添加rattler配置文件。添加方式为在resource目录下新增rattler.properties文件，内容示例如下：
#链路上报开关，true开启，false关闭。在线上环境可以选择关闭【必填】
chain_capture_switch=true
#链路信息的上送接口，采用post方式进行上送【选填】|【链路开关打开必填】
#upload_url=-1 表示不进行上送
upload_url=http://upload.domain.info.com/chain/test
#待扫描的服务package名称，目前不支持多package配置【必填】|【链路开关打开必填】
package_name=com.airfer.rattler.data
#在链路开关开启且后端服务启动后，rattler会按照指定的刷新频率刷新收集，单位秒【选填】|【链路开关打开必填】
# refresh_interval=-1 表示不启动定时刷新
refresh_interval=-1
#server_id唯一标识一个服务，和美团的appkey是同一个概念【选填】|【链路开关打开必填】
server_id=airfer_rattler_test
rattler-func-detetion 是一个基于Git Patch文件的开源代码分析工具(仅限java服务)，主要用于函数变动探测，目前支持python2.x以及python3.x版本。通过以下命令：
git diff feature/* master >result.patch获取patch文件后，解析patch文件，获取变动的函数列表，并将函数列表信息上送到指定服务器，目前仅支持Http协议
- 基于git patch文件分析函数变动，进行服务核心链路冲撞率(collision rate)计算，评估影响面大小
- 统计核心链路的变更频率，为服务的重构以及优化提供数据支持
如果不需要对代码进行查看或者二次开发，可以使用pip来进行安装，支持python2.x以及python3.x，命令如下：
pip install rattler-func-detection
- 下载源代码，使用python setup.py install进行安装
- 使用rattler-func-detection 命令运行,可通过 --help命令查看可选项
Usage: rattler-func-detection [OPTIONS]
:param rootPath: 扫描根路径 :param diffFilePath: :return:
Options:
--root_path TEXT 扫描根路径,git clone代码后根目录
--diff_path TEXT git diff文件路径
--server_id TEXT server_id,服务唯一标识
--upload_url TEXT 数据上送地址
--help Show this message and exit.
假设我们现在有两个核心链路A和A1(单个服务内部函数之间的链路调用关系，非微服务之间的调用，A-G、A1-G1皆为函数),两条链路中的所有调用函数都可通过CoreChain类注解进行收集。而需求迭代所造成的代码变动可通过rattler-func-detection进行收集，链路碰撞示意图如下所示：
拿到链路数据之后，就可以计算每条链路中有多少函数处于被影响的范围。虽然在进行链路信息标注时设置了权重值，但是目前权重值还没有被应用于计算，预计下期项目提供支持
{
u'data': u'{
"all": "0.36", // 整体冲撞率
"A" : "0.57", // 消费链路冲撞率
"A1" : "0.23" // 开户链路冲撞率
}',
u'resCode': u'00'
}
核心链路应用范围远不止链路碰撞分析，核心链路可以被认为是服务的主脉络，它撑起了整个服务。如果脉络中的某个节点或者一批节点发生故障，对整个服务的影响如何呢？ 发生故障以后，是否会按照故障预期将结果返回给上层调用或者直接返回给用户端？上述在通常的功能测试中涉及的很少，而我们在收集核心链路的基础上，可以自动完成故障注入。
故障注入的方式可以分为2种，手动注入和自动注入。
手动注入顾名思义就是手动选择需要注入的类或者方法，自动注入则可按照自定义策略或者默认策略来对方法进行注入。手动注入的方式可参照下方的架构设计：
在上述架构中，核心链路信息被上送到外部处理系统后，会有6步操作完成手动方法注入
step1: 上送的核心链路信息被处理并存储在存储介质中如DB
step2: 配置管理模块获取链路信息,并形成配置项比如可选择那些类、那些方法进行注入,供用户填写
step3: 用户配置完注入信息后,会将个性化定制信息进行存储
step4: 本地缓存系统,会根据特定标识ID去定时拉取需要已配置的故障注入配置项
step5: 配置系统交互返回
step6: 故障注入系统在刷新时,会强制从本地缓存中读取配置信息，完成注入过程
自动注入，通过程序中预设的注入策略来进行故障（Exception）注入，无需人工手动在平台上进行选择。 目前提供以下自动注入方式：
-
根据链路信息进行注入,比如基于核心链路名称的注入方式
-
基于自定义策略的注入,策略可自己来实现, 满足定制化需求
/**
* Author: wangyukun
* Date: 2020/4/2 下午5:42
*/
@MetaInfServices(Module.class)
@Information(id = "auto-injection-rattler",author = "wangyukun",version = "0.0.1")
public class AutoInjectionModule implements Module{
@Resource
private ModuleEventWatcher moduleEventWatcher;
/**
* 基于真实的链路方法,自动注入示例
*/
@Command("autoInjectForLocal")
public void autoInjectForLocal() {
new EventWatchBuilder(moduleEventWatcher)
.onClass("com.*")
/**
* onChain基于链路的注入,会根据服务标识以及链路的名称获取方法列表进行注入
* @param identityId 服务唯一标识
* @name 链路名称
*/
.onChain("airfer_rattler_test","red-alarm",
new LocalChainAgre())
/**
* 如果设置了策略信息，则会根据策略来对方法进行过滤
* 例如：下方设置的为随机50%策略,那么核心链路中50%的方法会进行故障注入
* 策略可自行定义，实现InjectionStrategy接口即可
* 可能存在的情况：
* (1) 核心链路中指定前置的方法进行注入
* (2) 核心链路中对包含某个关键词的方法进行注入
*/
.onStrategy(new RandomStrategy())
/**
* 示例：针对获取的方法直接抛出异常
*/
.onWatch(new AdviceListener() {
@Override
protected void before(Advice advice) throws Throwable {
// 在此，你可以通过ProcessController来改变原有方法的执行流程
// 这里的代码意义是：改变原方法抛出异常的行为，变更为立即返回；void返回值用null表示
ProcessController.throwsImmediately(new RuntimeException("autoInjection"));
}
});
}
}- rattler基于JDK8开发，使用了很多新特性，比如stream，对于基于低于JDK8的服务版本暂不支持
- 目前rattler仅适用于JAVA后端服务，对于非JAVA服务以及前端暂不支持
- 探索核心链路的非侵入收集方法 预计2020/05