clickhouse-jdbc-plugin support trace sql parameters when enable plugin.jdbc.trace_sql_parameters (#515)

Co-authored-by: litexu <litexu@tencent.com>

Author: xu1009

CHANGES.md

@@ -7,6 +7,7 @@ Release Notes.
 
 * Exclude `synthetic` methods for the WitnessMethod mechanism
 * Support ForkJoinPool trace
+* Support clickhouse-jdbc-plugin trace sql parameters
 
 #### Documentation
 

apm-sniffer/apm-sdk-plugin/clickhouse-0.3.2.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/jdbc/clickhouse/v32/SWClickHousePreparedStatement.java

@@ -19,10 +19,14 @@
 package org.apache.skywalking.apm.plugin.jdbc.trace;
 
 import java.sql.SQLException;
+import java.util.Objects;
+import org.apache.skywalking.apm.agent.core.context.ContextManager;
 import org.apache.skywalking.apm.agent.core.context.tag.Tags;
 import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
 import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer;
-import org.apache.skywalking.apm.agent.core.context.ContextManager;
+import org.apache.skywalking.apm.plugin.jdbc.JDBCPluginConfig;
+import org.apache.skywalking.apm.plugin.jdbc.PreparedStatementParameterBuilder;
+import org.apache.skywalking.apm.plugin.jdbc.define.StatementEnhanceInfos;
 
 /**
  * {@link PreparedStatementTracing} create an exit span when the client call the method in the class that extend {@link
@@ -31,16 +35,23 @@
 public class PreparedStatementTracing {
 
     public static <R> R execute(java.sql.PreparedStatement realStatement, ConnectionInfo connectInfo, String method,
-        String sql, Executable<R> exec) throws SQLException {
-        final AbstractSpan span = ContextManager.createExitSpan(connectInfo.getDBType() + "/JDBC/PreparedStatement/" + method, connectInfo
-            .getDatabasePeer());
+            String sql, Executable<R> exec, StatementEnhanceInfos statementEnhanceInfos) throws SQLException {
+        final AbstractSpan span = ContextManager.createExitSpan(
+                connectInfo.getDBType() + "/JDBC/PreparedStatement/" + method, connectInfo
+                        .getDatabasePeer());
         try {
             Tags.DB_TYPE.set(span, connectInfo.getDBType());
             Tags.DB_INSTANCE.set(span, connectInfo.getDatabaseName());
             Tags.DB_STATEMENT.set(span, sql);
             span.setComponent(connectInfo.getComponent());
-
             SpanLayer.asDB(span);
+            if (JDBCPluginConfig.Plugin.JDBC.TRACE_SQL_PARAMETERS && Objects.nonNull(statementEnhanceInfos)) {
+                final Object[] parameters = statementEnhanceInfos.getParameters();
+                if (parameters != null && parameters.length > 0) {
+                    int maxIndex = statementEnhanceInfos.getMaxIndex();
+                    Tags.SQL_PARAMETERS.set(span, getParameterString(parameters, maxIndex));
+                }
+            }
             return exec.exe(realStatement, sql);
         } catch (SQLException e) {
             span.log(e);
@@ -50,7 +61,15 @@ public static <R> R execute(java.sql.PreparedStatement realStatement, Connection
         }
     }
 
+    private static String getParameterString(Object[] parameters, int maxIndex) {
+        return new PreparedStatementParameterBuilder()
+                .setParameters(parameters)
+                .setMaxIndex(maxIndex)
+                .build();
+    }
+
     public interface Executable<R> {
+
         R exe(java.sql.PreparedStatement realConnection, String sql) throws SQLException;
     }
 }