深度好文|Sharding-Sphere在甜橙金融的应用性能监控实践（ODF强烈推荐）

Posted 2021-05-01 安可数据库论坛

陈清阳

中国电信甜橙金融技术创新中心

高级工程师

多年JAVA及常用互联网中间件开发及运维经验

Sharding-Sphere是一套开源的分布式数据库中间件解决方案组成的生态圈，它为分布式数据存储提供了多种形式的解决方案。其中的Sharding-JDBC产品在甜橙金融的技术架构中得到了广泛应用，并且在业内已成为最重要的解决方案之一。在使用Sharding-JDBC的过程中，少不了性能测试与运维性能监控的工作。作为Sharding-Sphere开源项目的重要支持者，甜橙金融技术创新中心团队很荣幸的参与并负责解决Sharing-JDBC的应用性能监控问题。本文将针对这个问题，进行Sharding-Sphere与APM之间结合的实践探索。

——前言

1

Sharding-Opentracing简介

Sharding-Opentracing是Sharding-Sphere为大家提供的基于Opentracing规范的APM工具包。它采用发布 - 订阅式的组件通信机制实现了对核心链路方法的跟踪记录，包括sql解析路由方法、sql执行方法和结果归并方法。

Opentracing（https://github.com/opentracing）规范的产生，目的是为了解决不同的分布式追踪系统API不兼容的问题。它是一个轻量级的标准化层，位于应用程序/类库和追踪或日志分析程序之间。

Sharding-Sphere使用Opentracing进行方法的追踪，使得系统开发人员可以方便的添加或替换追踪系统的实现。使用ShardingJDBCTracer类可以方便的完成Tracer的注入。

public final class ShardingJDBCTracer {
   
   /**
    * 通过读取系统属性进行注册
    * -Dshardingjdbc.opentracing.tracer.class=*****     
    */
   public static void init() {...}
   
   /**
    * 通过方法参数进行注册
    */
   public static void init(final Tracer tracer) {...}
   
}

然后通过事件监听器订阅核心方法事件，完成方法拦截实现方法追踪。目前实现的事件监听器如下：

• SqlRoutingEventListener     

  Sql路由事件追踪

• ExecuteEventListener           

  Sql执行事件追踪

• MergeEventListener               

  Sql执行结果合并事件追踪

  
  

2

基于Opentracing规范的性能追踪——SkyWalking实践

SkyWalking（https://github.com/apache/incubator-skywalking）是由国人大神吴晟创建的一款开源的针对分布式系统的APM系统，它提供了Opentracing标准的支持。下面我们通过SkyWalking来看看如何在你的应用中使用Sharding-Opentracing工具包。

在应用系统中引入相关依赖包

<dependency>
  <groupId>io.shardingsphere</groupId>
  <artifactId>sharding-opentracing</artifactId>
  <version>3.0.0.M2-SNAPSHOT</version>
</dependency>
<dependency>
  <groupId>org.apache.skywalking</groupId>
  <artifactId>apm-toolkit-opentracing</artifactId>
  <version>5.0.0-beta</version>
</dependency>

SkyWalking的apm-toolkit-opentracing包中的SkyWalkingTracer实现了Tracer接口，在应用系统启动时完成Tracer的注入。

ShardingJDBCTracer.init(new SkywalkingTracer());

通过简单的两步就完成了SkyWalking的接入。通过SkyWalking的Trace视图可以查看业务请求的调用链信息,包括Sharding-JDBC在sql路由，sql执行和结果归并的执行信息。其中sql执行是采用多条sql并行执行的策略，这里也可以看到每个线程的执行情况。

通过SkyWalking的Span Info视图可以看到每个追踪Span的相关参数信息。包括路由库信息、sql解析语句与执行入参等。

3

基于字节码增强的性能追踪——Pinpoint实践

上面我们了解了如何使用实现了Opentracing规范的APM框架进行Sharding-JDBC的性能监控，那么对于没有实现Opentracing规范，采用字节码增强技术的APM框架，我们又该如何入手了？针对这种采用字节码增强技术的APM框架，我们的策略是编写对应的插件，实现对Sharding-Sphere核心方法的增强。接下来我们看看如何在Pinpoint框架中实现一个针对Sharding-Sphere组件的插件。

实现Interceptor接口，完成组件方法拦截器。在组件方法执行前开启追踪，在组件方法执行后结束追踪，这里展示结果归并方法追踪的实现。

public class ResultSetMergeInterceptor implements AroundInterceptor1 {
   
   private final TraceContext traceContext;
   private final MethodDescriptor descriptor;
   private final PLogger logger = PLoggerFactory.getLogger(getClass());
   
   public ResultSetMergeInterceptor(TraceContext traceContext, MethodDescriptor descriptor) {
       this.traceContext = traceContext;
       this.descriptor = descriptor;
   }
   
   @Override
   public void before(Object target, Object arg0) {
       if (logger.isDebugEnabled()) {
           logger.beforeInterceptor(target, new Object[]{arg0});
       }
       final Trace trace = traceContext.currentTraceObject();
       if (trace == null) {
           return;
       }
       trace.traceBlockBegin();
   }
   
   @Override
   public void after(Object target, Object arg0, Object result, Throwable throwable) {
       if (logger.isDebugEnabled()) {
           logger.afterInterceptor(target, new Object[]{arg0}, result, throwable);
       }  
       final Trace trace = traceContext.currentTraceObject();
       if (trace == null) {
           return;
       }    
       try {
           SpanEventRecorder recorder = trace.currentSpanEventRecorder();
           recorder.recordServiceType(ShardingSphereConstants.SHARDING_SPHERE_MERGE);
           recorder.recordApi(descriptor);
           recorder.recordException(throwable);
       } finally {
           trace.traceBlockEnd();
       }
   }
}

实现ProfilerPlugin和TransformTemplateAware接口，完成插件标识和转换模版注册。其中需要通过TransformTemplate的transform方法来完成追踪方法和方法拦截器的绑定关系。例如ShardingPreparedStatement类的merge方法与上面实现的ResultSetMergeInterceptor进行绑定。

public class ShardingSpherePlugin implements ProfilerPlugin, TransformTemplateAware {
   
   private final PLogger logger = PLoggerFactory.getLogger(this.getClass());
   
   private static final String SHARDINGSPHERE_SCOPE = "SHARDINGSPHERE_SCOPE";
   
   private TransformTemplate transformTemplate;
   
   @Override
   public void setup(ProfilerPluginSetupContext context) {
       ShardingSphereConfig config = new ShardingSphereConfig(context.getConfig());
       logger.debug("[ShardingSphere] pluginEnable={}", config.isPluginEnable());
       if (config.isPluginEnable()) {
           addSqlRouteTransformer();
           addSqlExecutorTransformer();
           addResultMergeTransformer();
       }
   }
   
   @Override
   public void setTransformTemplate(TransformTemplate transformTemplate) {
       this.transformTemplate = transformTemplate;
   }
   
   private void addResultMergeTransformer() {
       TransformCallback transformCallback = new TransformCallback() {
           @Override
           public byte[] doInTransform(Instrumentor instrumentor, ClassLoader classLoader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws InstrumentException {
               InstrumentClass target = instrumentor.getInstrumentClass(classLoader, className, classfileBuffer);
               InstrumentMethod method = target.getDeclaredMethod("merge", "io.shardingsphere.core.merger.MergeEngine");
               method.addScopedInterceptor("com.navercorp.pinpoint.plugin.shardingsphere.interceptor.ResultSetMergeInterceptor", SHARDINGSPHERE_SCOPE);
               return target.toBytecode();
           }
       };
       transformTemplate.transform("io.shardingsphere.core.jdbc.core.statement.ShardingPreparedStatement", transformCallback);
       transformTemplate.transform("io.shardingsphere.core.jdbc.core.statement.ShardingStatement", transformCallback);
   }
   
}

完整插件代码请参考：

https://github.com/beckhampu/pinpoint/tree/sharding-sphere-1.7.2/plugins

通过Pinpoint的CallTree效果图，我们可以清楚的看到一次业务过程中Sharding-JDBC核心方法的调用效果。

至此，关于Sharding-Sphere与APM的相关实践就介绍到这里。希望自己的一得之见可以让大家有所收获。如果大家有什么想法、意见和建议，欢迎留言与我交流。在这里也呼吁大家一起贡献自己的力量，让Sharding-Sphere发展的更好。

Sharding-Sphere

Sharding-Sphere是一套开源的分布式数据库中间件解决方案组成的生态圈，它由Sharding-JDBC、Sharding-Proxy和Sharding-Sidecar这3款相互独立的产品组成。他们均提供标准化的数据分片、读写分离、柔性事务和数据治理功能，可适用于如Java同构、异构语言、容器、云原生等各种多样化的应用场景。

亦步亦趋，开源不易，您对我们最大支持，就是在github上留下一个star。

https://github.com/sharding-sphere/sharding-sphere/

https://gitee.com/sharding-sphere/sharding-sphere/

更多信息请浏览官网：

http://shardingsphere.io/

或加入Sharding-Sphere官方讨论群  

感谢您的支持与关注

我们将不忘初心，不负众望！

原文地址：

https://mp.weixin.qq.com/s/FHRnLwUGD32a7mAPNqJ3ug

温馨提醒

9月8日，京东金融数据研发负责人、Sharding-Sphere作者张亮将在“2018 ODF 开源数据库论坛暨MariaDB中国用户者大会”的RDS专场作主题演讲，分享《剖析云原生数据库中间件生态Sharding-Sphere》，主要介绍面向云原生的开源数据库中间件产品Sharding-Sphere，集合了数据分片、分布式事务以及数据库治理等核心功能，并且对外提供了基于JDBC协议的Sharding-JDBC以及基于mysql协议的Sharding-Proxy。本次分享将与您一起聊聊云原生时代的数据库中间件所带来的机遇与挑战，并深度剖析Sharding-Sphere的实现内幕。

欢迎来现场与大咖交流。

点击“阅读原文”