使用适用于 Java 的 X-Ray 开发工具包跟踪 SQL 查询 - AWS X-Ray
SQL 拦截器原生 SQL 跟踪装饰器

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用适用于 Java 的 X-Ray 开发工具包跟踪 SQL 查询

SQL 拦截器

通过将适用于 Java 的 X-Ray 开发工具包 JDBC 拦截程序添加到数据源配置来检测 SQL 数据库查询。

  • PostgreSQL – com.amazonaws.xray.sql.postgres.TracingInterceptor

  • MySQL – com.amazonaws.xray.sql.mysql.TracingInterceptor

这些拦截程序分别位于 aws-xray-recorder-sql-postgres 和 aws-xray-recorder-sql-mysql 子模块中。它们实现 org.apache.tomcat.jdbc.pool.JdbcInterceptor 并与 Tomcat 连接池兼容。

注意

为了安全起见，SQL 拦截程序不在子分段中记录 SQL 查询本身。

对于 Spring，在属性文件中添加拦截程序并使用 Spring Boot 的 DataSourceBuilder 构建数据源。

例 src/main/java/resources/application.properties - ostgreSQL JDBC 拦截器
spring.datasource.continue-on-error=true
spring.jpa.show-sql=false
spring.jpa.hibernate.ddl-auto=create-drop
spring.datasource.jdbc-interceptors=com.amazonaws.xray.sql.postgres.TracingInterceptor
spring.jpa.database-platform=org.hibernate.dialect.PostgreSQL94Dialect
例 src/main/java/myapp/WebConfig.java - 数据源
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

import javax.servlet.Filter;
import javax.sql.DataSource;
import java.net.URL;

@Configuration
@EnableAutoConfiguration
@EnableJpaRepositories("myapp")
public class RdsWebConfig {

  @Bean
  @ConfigurationProperties(prefix = "spring.datasource")
  public DataSource dataSource() {
      logger.info("Initializing PostgreSQL datasource");
      return DataSourceBuilder.create()
              .driverClassName("org.postgresql.Driver")
              .url("jdbc:postgresql://" + System.getenv("RDS_HOSTNAME") + ":" + System.getenv("RDS_PORT") + "/ebdb")
              .username(System.getenv("RDS_USERNAME"))
              .password(System.getenv("RDS_PASSWORD"))
              .build();
  }
...
}

对于 Tomcat，使用对适用于 Java 类的 X-Ray 开发工具包的引用来对 JDBC 数据源调用 setJdbcInterceptors。

例 src/main/myapp/model.java - 数据源
import org.apache.tomcat.jdbc.pool.DataSource;
...
DataSource source = new DataSource();
source.setUrl(url);
source.setUsername(user);
source.setPassword(password);
source.setDriverClassName("com.mysql.jdbc.Driver");
source.setJdbcInterceptors("com.amazonaws.xray.sql.mysql.TracingInterceptor;");

Tomcat JDBC 数据源库包含在适用于 Java 的 X-Ray 开发工具包中，但您可以将其声明为提供的依赖关系来记载您将会使用它。

例 pom.xml - JDBC 数据源
<dependency>
  <groupId>org.apache.tomcat</groupId>
  <artifactId>tomcat-jdbc</artifactId>
  <version>8.0.36</version>
  <scope>provided</scope>
</dependency>

原生 SQL 跟踪装饰器

  • 将 aws-xray-recorder-sdk-sql 添加到依赖项。

  • 装饰您的数据库数据源、连接或语句。

    dataSource = TracingDataSource.decorate(dataSource)
connection = TracingConnection.decorate(connection)
statement = TracingStatement.decorateStatement(statement)
preparedStatement = TracingStatement.decoratePreparedStatement(preparedStatement, sql)
callableStatement = TracingStatement.decorateCallableStatement(callableStatement, sql)