DataSource 埋点接入

更新时间: 2019-06-21

在本文档将演示如何使用 SOFATracer 对 DataSource 进行埋点，本示例工程地址。

SOFATracer 2.2.0 基于标准的 JDBC 接口实现，支持对标准的数据库连接池（如 DBCP、Druid、c3p0、tomcat、HikariCP、BoneCP）埋点。下面演示如何接入 SOFATracer 埋点能力。

假设你已经基于 SOFABoot 构建了一个简单的 Spring Web 工程，那么可以通过如下步骤进行操作：

依赖引入

引入 SOFATracer 依赖

  1. <dependency>
  2.     <groupId>com.alipay.sofa</groupId>
  3.     <artifactId>tracer-sofa-boot-starter</artifactId>
  4. </dependency>

引入 h2database 依赖

为了方便，我们使用 h2database 内存数据库测试，引入如下依赖：

  1. <dependency>
  2.     <groupId>com.h2database</groupId>
  3.     <artifactId>h2</artifactId>
  4.     <scope>runtime</scope>
  5. </dependency>
  7. <dependency>
  8.     <groupId>mysql</groupId>
  9.     <artifactId>mysql-connector-java</artifactId>
  10. </dependency>

引入所需的连接池依赖

用户引入所需的连接池依赖包，如 druid, c3p0, tomcat, dbcp, Hikari 等。

  1. <dependency>
  2.     <groupId>com.alibaba</groupId>
  3.     <artifactId>druid</artifactId>
  4.     <version>1.0.12</version>
  5. </dependency>
  6. <dependency>
  7.     <groupId>c3p0</groupId>
  8.     <artifactId>c3p0</artifactId>
  9.     <version>0.9.1.1</version>
  10. </dependency>
  11. <dependency>
  12.     <groupId>org.apache.tomcat</groupId>
  13.     <artifactId>tomcat-jdbc</artifactId>
  14.     <version>8.5.31</version>
  15. </dependency>
  16. <dependency>
  17.     <groupId>commons-dbcp</groupId>
  18.     <artifactId>commons-dbcp</artifactId>
  19.     <version>1.4</version>
  20. </dependency>
  21. <dependency>
  22.     <groupId>com.zaxxer</groupId>
  23.     <artifactId>HikariCP-java6</artifactId>
  24.     <version>2.3.8</version>
  25. </dependency>

配置数据源

我们以 HikariCP 为例，新建一个名为datasource.xml Spring 配置文件，定义如下内容:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
  5.     <!-- dataSource pool -->
  6.     <bean id="simpleDataSource" class="com.zaxxer.hikari.HikariDataSource" destroy-method="close" primary="true">
  7.         <property name="driverClassName" value="org.h2.Driver"/>
  8.         <property name="jdbcUrl" value="jdbc:h2:~/test"/>
  9.         <property name="username" value="sofa"/>
  10.         <property name="password" value="123456"/>
  11.     </bean>
  12. </beans>

应用配置

  • 必要配置需要注意一点，引入 SOFATracer 需要强制配置应用名，否则应用启动失败。这一属性和 SOFABoot 框架要求一致，配置如下：
  1. spring.application.name=SOFATracerDataSource
  • 非必要配置为了该演示工程正常运行，需要配置 h2database 属性；另为了方便查看日志，配置日志路径。如下：
  1. # logging path
  2. logging.path=./logs
  4. # h2 web consloe 路径
  5. spring.h2.console.path=/h2-console
  6. # 开启 h2 web consloe，默认为 false
  7. spring.h2.console.enabled=true
  8. #允许远程访问 h2 web consloe
  9. spring.h2.console.settings.web-allow-others=true
  11. spring.datasource.username=sofa
  12. spring.datasource.password=123456
  13. spring.datasource.url=jdbc:h2:~/test
  14. spring.datasource.driver-class-name=org.h2.Driver

新建 Rest 服务

为了达到演示效果，我们新建一个 Rest 服务，触发 SQL 语句执行，便于查看 sql 的 tracer 记录。Rest 服务如下创建：

  1. @RestController
  2. public class SimpleRestController {
  4.     @Autowired
  5.     private DataSource simpleDataSource;
  7.     @RequestMapping("/create")
  8.     public Map<String, Object> create() {
  9.         Map<String, Object> resultMap = new HashMap<String, Object>();
  10.         try {
  11.             Connection cn = simpleDataSource.getConnection();
  12.             Statement st = cn.createStatement();
  13.             st.execute("DROP TABLE IF EXISTS TEST;"
  14.                     + "CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255));");
  15.             resultMap.put("success", true);
  16.             resultMap.put("result", "CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255))");
  17.         } catch (Throwable throwable) {
  18.             resultMap.put("success", false);
  19.             resultMap.put("error", throwable.getMessage());
  20.         }
  21.         return resultMap;
  22.     }
  24. }

可以看到该 Rest 服务执行了一个建表操作。

演示

启动应用，访问 localhost:8080/create 执行上述 Rest 服务，可以在 ./logs/datasource-client-digest.log 和 ./logs/datasource-client-stat.log 看到 sql 执行的 tracer 日志：+ datasource-client-digest.log

  1. {"time":"2018-09-05 11:48:16.917","local.app":"SOFATracerDataSource","traceId":"1e323a031536119296795100182779","spanId":"0.1.2","database.name":"test","sql":"DROP TABLE IF EXISTS TEST;CREATE TABLE TEST(ID INT PRIMARY KEY%2C NAME VARCHAR(255));","result.code":"success","total.time":"103ms","connection.establish.span":"92ms","db.execute.cost":"8ms","database.type":"h2","database.endpoint":"jdbc:h2:~/test:-1","current.thread.name":"http-nio-8080-exec-1","baggage":""}
  • datasource-client-stat.log (默认60s打印一次，)
  1. {"time":"2018-09-05 11:49:10.117","stat.key":{"local.app":"SOFATracerDataSource","database.name":"test"},"count":1,"total.cost.milliseconds":103,"success":"true","load.test":"F"}

其他

在 Spring Boot 工程引入 SOFATracer 依赖，会自动开启 DataSource 的埋点，可以通过设置如下开关禁止启动 DataSource 埋点，默认是打开的：

  1. com.alipay.sofa.tracer.datasource.enable=false

注意

  • 引入 SOFATracer 需要强制配置应用名，否则应用启动失败。属性名称为：spring.application.name
  • SOFATracer 2.2.0基于标准的 JDBC 接口实现，理论上支持对所有标准的数据库连接池（如 DBCP，BoneCP 等）埋点。在 Spring Boot 环境，对于 DBCP、Druid、c3p0、tomcat、HikariCP 五种连接池支持自动埋点，即用户只需要引入 SOFATracer 依赖即可。在非 Spring Boot 环境或者对其他连接池（如 BoneCP）还需要增加手动配置，比如：```xml …`<code> 即需要额外配置 SOFATracer 提供的</code>com.alipay.sofa.tracer.plugins.datasource.SmartDataSource