可观察性

Agent

源码编译

从 Github 下载 Apache ShardingSphere 源码，对源码进行编译，操作命令如下。

  1. git clone --depth 1 https://github.com/apache/shardingsphere.git
  2. cd shardingsphere
  3. mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease

agent 包输出目录为 distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz

目录说明

创建 agent 目录，解压 agent 二进制包到 agent 目录。

  1. mkdir agent
  2. tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz -C agent
  3. cd agent
  4. tree 
  5. ├── LICENSE
  6. ├── NOTICE
  7. ├── conf
  8. │   └── agent.yaml
  9. ├── plugins
  10. │   ├── lib
  11. │   │   ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
  12. │   │   └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
  13. │   ├── logging
  14. │   │   └── shardingsphere-agent-logging-file-${latest.release.version}.jar
  15. │   ├── metrics
  16. │   │   └── shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
  17. │   └── tracing
  18. │       ├── shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
  19. │       └── shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
  20. └── shardingsphere-agent-${latest.release.version}.jar

Agent 日志输出位置在 agent/logs/stdout.log。

配置说明

conf/agent.yaml 用于管理 agent 配置。内置插件包括 File、Prometheus、OpenTelemetry、OpenTracing。

  1. plugins:
  2. #  logging:
  3. #    File:
  4. #      props:
  5. #        level: "INFO"
  6. #  metrics:
  7. #    Prometheus:
  8. #      host:  "localhost"
  9. #      port: 9090
  10. #      props:
  11. #        jvm-information-collector-enabled: "true"
  12. #  tracing:
  13. #    OpenTelemetry:
  14. #      props:
  15. #        otel.service.name: "shardingsphere"
  16. #        otel.traces.exporter: "jaeger"
  17. #        otel.exporter.otlp.traces.endpoint: "http://localhost:14250"
  18. #        otel.traces.sampler: "always_on"
  19. #    OpenTracing:
  20. #      props:
  21. #        opentracing-tracer-class-name: "org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer"

插件说明

File

目前 File 插件只有构建元数据耗时日志输出，暂无其他日志输出。

Prometheus

用于暴露监控指标

  • 参数说明
名称说明
host主机
port端口
jvm-information-collector-enabled是否采集 JVM 指标信息

OpenTelemetry

OpenTelemetry 可以导出 tracing 数据到 Jaeger，Zipkin。

  • 参数说明
名称说明
otel.service.name服务名称
otel.traces.exportertraces exporter
otel.exporter.otlp.traces.endpointtraces endpoint
otel.traces.samplertraces sampler

参数参考 OpenTelemetry SDK Autoconfigure

ShardingSphere-JDBC 使用

  • 1 准备好已集成 ShardingSphere-JDBC 的 SpringBoot 项目，test-project.jar
  • 2 启动项目
  1. java -javaagent:/agent/shardingsphere-agent-${latest.release.version}.jar -jar test-project.jar
  • 3 访问启动的服务
  • 4 查看对应的插件是否生效

Metrics

指标名称指标类型指标描述
build_infoGAUGE构建信息
parsed_sql_totalCOUNTER按类型（INSERT、UPDATE、DELETE、SELECT、DDL、DCL、DAL、TCL、RQL、RDL、RAL、RUL）分类的解析总数
routed_sql_totalCOUNTER按类型（INSERT、UPDATE、DELETE、SELECT）分类的路由总数
routed_result_totalCOUNTER路由结果总数(数据源路由结果、表路由结果)
jdbc_stateGAUGEShardingSphere-JDBC 状态信息。0 表示正常状态；1 表示熔断状态；2 锁定状态
jdbc_meta_data_infoGAUGEShardingSphere-JDBC 元数据信息
jdbc_statement_execute_totalCOUNTER语句执行总数
jdbc_statement_execute_errors_totalCOUNTER语句执行错误总数
jdbc_statement_execute_latency_millisHISTOGRAM语句执行耗时
jdbc_transactions_totalCOUNTER事务总数，按 commit，rollback 分类