从 Github 下载 Apache ShardingSphere 源码，对源码进行编译，操作命令如下。
git clone --depth 1 https://github.com/apache/shardingsphere.git
cd shardingsphere
mvn clean install -DskipITs -DskipTests -Prelease
Agent 制品 distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
Proxy 制品 distribution/proxy/target/apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin.tar.gz
创建 agent 目录，解压 agent 二进制包到 agent 目录。
mkdir agent
tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz -C agent
cd agent
tree
├── LICENSE
├── NOTICE
├── conf
│ └── agent.yaml
├── plugins
│ ├── lib
│ │ ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
│ │ └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
│ ├── logging
│ │ └── shardingsphere-agent-logging-file-${latest.release.version}.jar
│ ├── metrics
│ │ └── shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
│ └── tracing
│ ├── shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
└── shardingsphere-agent-${latest.release.version}.jar
conf/agent.yaml 用于管理 agent 配置。内置插件包括 File、Prometheus、OpenTelemetry。
plugins:
# logging:
# File:
# props:
# level: "INFO"
# metrics:
# Prometheus:
# host: "localhost"
# port: 9090
# props:
# jvm-information-collector-enabled: "true"
# tracing:
# OpenTelemetry:
# props:
# otel.service.name: "shardingsphere"
# otel.traces.exporter: "jaeger"
# otel.exporter.otlp.traces.endpoint: "http://localhost:14250"
# otel.traces.sampler: "always_on"
目前 File 插件只有构建元数据耗时日志输出，暂无其他日志输出。
用于暴露监控指标
| 名称 | 说明 |
|---|---|
| host | 主机 |
| port | 端口 |
| jvm-information-collector-enabled | 是否采集 JVM 指标信息 |
OpenTelemetry 可以导出 tracing 数据到 Jaeger，Zipkin。
| 名称 | 说明 |
|---|---|
| otel.service.name | 服务名称 |
| otel.traces.exporter | traces exporter |
| otel.exporter.otlp.traces.endpoint | traces endpoint |
| otel.traces.sampler | traces sampler |
参数参考 OpenTelemetry SDK Autoconfigure
启动 ShardingSphere-Proxy
tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin.tar.gz
cd apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin
./bin/start.sh -g
正常启动后，可以在 ShardingSphere-Proxy 日志中找到 plugin 的加载信息，访问 Proxy 后，可以通过配置的监控地址查看到 Metric 和 Tracing 的数据。
| 指标名称 | 指标类型 | 指标描述 |
|---|---|---|
| build_info | GAUGE | 构建信息 |
| parsed_sql_total | COUNTER | 按类型（INSERT、UPDATE、DELETE、SELECT、DDL、DCL、DAL、TCL、RQL、RDL、RAL、RUL）分类的解析总数 |
| routed_sql_total | COUNTER | 按类型（INSERT、UPDATE、DELETE、SELECT）分类的路由总数 |
| routed_result_total | COUNTER | 路由结果总数(数据源路由结果、表路由结果) |
| proxy_state | GAUGE | ShardingSphere-Proxy 状态信息。0 表示正常状态；1 表示熔断状态；2 锁定状态 |
| proxy_meta_data_info | GAUGE | ShardingSphere-Proxy 元数据信息，database_count：逻辑库数量，storage_unit_count：存储节点数量 |
| proxy_current_connections | GAUGE | ShardingSphere-Proxy 的当前连接数 |
| proxy_requests_total | COUNTER | ShardingSphere-Proxy 的接受请求总数 |
| proxy_transactions_total | COUNTER | ShardingSphere-Proxy 的事务总数，按 commit，rollback 分类 |
| proxy_execute_latency_millis | HISTOGRAM | ShardingSphere-Proxy 的执行耗时毫秒直方图 |
| proxy_execute_errors_total | COUNTER | ShardingSphere-Proxy 的执行异常总数 |