Java OpenTelemetry

Question

Java agent OpenTelemetry
java启动命令加了
-Dotel.instrumentation.common.db-statement-sanitizer.enabled=false，但是最后链路中的sql参数还是被占位符替换了，版本是1.33.0的，Springboot 2.3.12的，jdk8，有人遇到过吗？
希望是可以关闭数据清理，sql展示实际参数值

Answer 1

本答案参考 多次询问 ChatGPT-3.5 后选择的最佳回答，若是满意，还请采纳，谢谢

1. 问题分析
   • 在使用OpenTelemetry Java代理时，即使设置了-Dotel.instrumentation.common.db - statement - sanitizer.enabled = false，SQL参数仍然被占位符替换，这可能是由于多种原因导致的。
   • 可能是配置没有被正确加载，或者在OpenTelemetry的版本1.33.0以及Spring Boot 2.3.12的特定组合下存在兼容性问题。
   • 也有可能是在代码中存在其他逻辑，例如在自定义的拦截器或者过滤器中对SQL进行了处理，导致这个设置没有生效。
2. 可能的解决方案
   • 检查配置加载顺序
     • 在Java启动命令中添加系统属性时，确保这个属性在其他可能影响数据库语句处理的属性之前被加载。例如，如果有其他自定义的OpenTelemetry配置文件或者环境变量设置，它们的加载顺序可能会影响到这个属性的生效。
     • 可以尝试将-Dotel.instrumentation.common.db - statement - sanitizer.enabled = false放在启动命令的最前面，以确保它最先被加载。
   • 检查OpenTelemetry版本兼容性
     • 查阅OpenTelemetry的官方文档，查看版本1.33.0是否存在已知的与关闭SQL参数清理相关的问题。可能需要升级或降级OpenTelemetry版本来解决这个问题。
     • 例如，在某些版本中，可能存在一个Bug，导致这个属性虽然被设置了，但是在特定的数据库驱动或者Spring Boot版本下无法正确生效。
   • 检查代码中的其他逻辑
     • 查看项目中的代码，是否存在自定义的数据库访问层拦截器或者过滤器。这些组件可能会在OpenTelemetry处理之前对SQL进行处理，从而导致即使关闭了OpenTelemetry的清理功能，SQL参数仍然被替换。
     • 例如，可能有一个自定义的StatementInterceptor，它会自动将SQL中的参数替换为占位符，如下：

import java.sql.Statement;
import java.util.Properties;

public class CustomStatementInterceptor implements StatementInterceptor {
    @Override
    public void init(Properties properties) {
        // 初始化逻辑
    }

    @Override
    public ResultSet executeQuery(Statement statement, String sql) throws SQLException {
        // 这里可能会对sql进行处理，将参数替换为占位符
        return statement.executeQuery(sql);
    }

    @Override
    public int executeUpdate(Statement statement, String sql) throws SQLException {
        // 类似地，这里也可能对sql进行处理
        return statement.executeUpdate(sql);
    }

    @Override
    public void close() {
        // 关闭逻辑
    }
}

 - 如果存在这样的代码，需要对其进行修改，以确保它不会干扰OpenTelemetry的设置。

• 检查Spring Boot配置
  • 在Spring Boot项目中，可能存在一些自动配置的功能会影响到数据库语句的处理。检查application.properties或者application.yml文件，看是否有与数据库相关的配置，例如数据库连接池的配置（如HikariCP、Tomcat JDBC连接池等）。
  • 例如，如果使用HikariCP连接池，可能存在一些配置项会影响SQL的处理。确保这些配置不会与OpenTelemetry的设置冲突。

1. 总结
   • 要解决SQL参数仍然被占位符替换的问题，需要从配置加载顺序、版本兼容性、代码逻辑以及Spring Boot配置等多个方面进行检查和调整。通过仔细排查这些可能的原因，有望实现关闭数据清理并展示SQL实际参数值的目标。