Apache ShardingSphere Agent 可观察性实用指南

背景

Apache ShardingSphere 作为践行 Database Plus 理念的数据服务平台，其包含数据分片、读写分离、数据加密、影子库、分布式事务、弹性伸缩等多种数据管理功能。当 Apache ShardingSphere 应用于实际生产中，用户往往需要对其性能进行监控，并结合业务分析定位出现的异常问题。我们知道 APM（应用性能监控）是通过对系统可观察性数据进行采集、存储和分析，进行系统的性能监控与诊断，主要功能包括性能指标监控、调用链分析，应用拓扑图等，一般通过 Tracing（链路跟踪）、Metrics（指标监控）和 Logging（日志）的手段来获取系统运行状况的可观察性数据，因此 Apache ShardingSphere 也为用户提供了可观察性的功能。

蒋平川

SphereEx 高级中间件工程师，Apache Tomcat & Apache ShardingSphere Contributor。目前专注于开源技术领域，在 SphereEx 主要负责 SphereEx-Console、SphereEx-Boot 的研发工作。

姜茂林

SphereEx 高级中间件工程师，Apache ShardingSphere Contributor。目前专注于 SphereEx 商业相关研发。

设计目标

Apache ShardingSphere 通过配置已经提供了日志的输出，所以当前 Apache ShardingSphere 可观察性功能目标主要是为用户提供必要的指标数据、链路数据。同时，我们希望在提供可观察性的时候，不会因为这部分功能引入对其他代码模块的改动，避免代码复杂度的上升。

设计内容

我们选择了监控常用的代理探针设计模式来实现 Apache ShardingSphere 的可观察模块，并采用优秀的 ByteBuddy 作为运行时代理生成组件，结合 Java Agent 技术实现了可观察性模块的代码零侵入。此外，我们通过插件化的技术来支持的不同框架或者系统的 Metrics 与 Tracing。通过插件化的设计，也能支持用户进行自定义，开发特定业务的自有功能组件。

当前 Apache ShardingSphere 的 Agent 模块自带功能提供了对 Prometheus、Zipkin、Jaeger、SkyWalking 及 OpenTelemetry 的支持。

实战指南

我们通过在 Apache ShardingSphere-Proxy 上部署 Prometheus 及 Zipkin 的可观察性数据插件的示例来具体实战演示一下 Apache ShardingSphere Agent 模块的使用。

软件准备

• prometheus-2.32.1.linux-amd64.tar.gz (https://prometheus.io/download)

• zipkin-server-2.23.9-exec.jar