Skip to content

deipss/jvm-sandbox-inspector

Repository files navigation

1. 简介

Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge

简要的用户下单流程

  • 1.用户通过Http请求到交易线下单,交易会查询用户的信息以及门店的营业状态,再防重验证后,创建订单。
  • 2.用户去拉起支付的支付界面。
flowchart LR
    consumer --> trade-facade
    consumer --> payment-facade
    subgraph trade
        trade-facade --> store-facade
        trade-facade --> user-facade
        trade-facade --> trade-query
        trade-facade --> trade-order
    end
    subgraph payment
        payment-facade --> payment-platform
        payment-platform --> trade-facade
    end
    subgraph store
        store-facade --> store-index
        store-index --> es[\Elastic Search\]
    end
    subgraph user
        user-facade --> user-core
        user-core --> mysql[(mysql)]
    end

    style consumer fill: #CCCCCC
    style user-core fill: #FF0000

1.1. 需求

  • 微服务架构下,非组内业务不了解,对接时,参数不对,发生异常,都要去找日志,或是arthas watch一下方法的调用
  • 常用的测试账号过期了,如何快速MOCK接口结果是检查通过
  • 发现bug,提交时,需要手工编写入参、出参、异常信息等
  • SQL语句错误、分表分库策略失效导致全表扫描等问题主动发现
  • ……

jvm-sandbox-repeater实现了流量的录制回放,受其启发,编码了jvm-sandbox-inspector

2. 源代码模块介绍

module 用途
jvm-sandbox-inspector-agent 使用jvm-sandbox,实现一个JavaAgent模块,具体部署方法见jvm-sandbox快速开始 ,实现分布式链路、接口参数录制、接口MOCK等功能
jvm-sandbox-inspector-data 数据同步模块(暂未实现),一般用于消费kafka的消息体(消息体中包含接口参数、响应等信息)保存到存储引擎中(ElasticSearch)
jvm-sandbox-inspector-web 用户操作界面模块,查看链路,数据回放,上报配置等
jvm-sandbox-inspector-debug-consumer 服务调试模块,服务消费者(rocketmq consumer,dubbo consumer,okhttp)
jvm-sandbox-inspector-debug-provider 服务调试模块,服务提供者(rocketmq sent,dubbo provider,restful 接口)

3. 分布式链路

在不同的应用中,使用不同的通信协议将span上下文传递。如用户使用http来支付,到了payment-facade应用,从header没有 解析出span,就初始化一个新span,作为链路的起始,payment-facade通过RPC调用payment-platform时,将span就放在 RpcContext中,如果使用rocket mq,可以将span放在user property中。作为通信中的接收方,就解析span是否存在,存在就 继续沿用,不存在就初始化。

flowchart LR
    consumer --> trade-facade
    consumer --> http(inject span to http header)

    subgraph payment-facade-machine
        http --> payment-facade
        payment-facade --> dubbo-consumer(inject span to RpcContext)
    end
    subgraph payment-platform-machine
        dubbo-consumer --> dubbo-provider(get span from RpcContext)
        dubbo-provider --> payment-platform
    end

    subgraph trade
        payment-platform --> trade-facade
        trade-facade --> store-facade
    end

    style consumer fill: #CCCCCC
    style http fill: #CCFFFF
    style dubbo-consumer fill: #CCFFFF
    style dubbo-provider fill: #CCFFFF



4. 接口录制

使用jvm-sandbox的事件监听,

  • BEFORE事件时,获取接口的参数
  • RETURN事件时,获取调用的返回结果
  • THROWS事件时,获取异常信息

com.alibaba.jvm.sandbox.api.listener.EventListener源码如下:

/**
 * 事件监听器
 *
 * @author luanjia@taobao.com
 */
public interface EventListener {

    /**
     * 触发事件处理
     * <p>
     * 事件处理是整个sandbox最重要的一环,也是整个系统设计的精髓所在
     * </p>
     * <pre>
     * {@code
     * 事件流转流程
     *
     *                                        +-------+
     *                                        |       |
     * +========+  <return>             +========+    | <return immediately>
     * |        |  <return immediately> |        |    |
     * | BEFORE |---------------------->| RETURN |<---+
     * |        |                       |        |
     * +========+                       +========+
     *     |                              |    ^
     *     |         <throws immediately> |    |
     *     |                              |    | <return immediately>
     *     |                              v    |
     *     |                            +========+
     *     |                            |        |
     *     +--------------------------->| THROWS |<---+
     *                    <throws>      |        |    |
     *        <throws immediately>      +========+    | <throws immediately>
     *                                        |       |
     *                                        +-------+
     * }
     * </pre>
     *
     * @param event 触发事件
     * @throws Throwable 处理异常
     */
    void onEvent(Event event) throws Throwable;

}

5. MOCK

使用jvm-sandbox提供的api,在方法调用前进行结果返回或异常抛出

import static com.alibaba.jvm.sandbox.api.ProcessController.returnImmediately;
import static com.alibaba.jvm.sandbox.api.ProcessController.throwsImmediately;

6. 阅读

About

distributed trace, function mock, result recorded

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published