Request option that does not include the SQL statement in the tag

[be-hase]

Feature

I want an option that does not include the SQL statement in the tag

Rationale and Example Scenario

Currently, when I apply mysql's Tracing Query Interceptor, sql query is included as a span tag.

brave/instrumentation/mysql8/src/main/java/brave/mysql8/TracingQueryInterceptor.java

Line 58 in 6ff1428

span.tag("sql.query", sql);

While this is very convenient, sql queries often contain sensitive personal information.
For sensitive applications, it would be nice to have an option that doesn't include sql query as a tag.

Prior Art

For example, lettuce (mejor redis client library) also has an option like this.
https://github.com/lettuce-io/lettuce-core/blob/7be77cb8298b456cb68754f71c5eb3fed412c0f9/src/main/java/io/lettuce/core/tracing/BraveTracing.java#L151-L156

[be-hase]

It seems good to add the following implementation specifically for the client side prepared statement.

This will get the args part as ?.
e.g. SELECT * FROM test WHERE id = ?

  @Override
  public <T extends Resultset> T preProcess(Supplier<String> sqlSupplier, Query interceptedQuery) {
    // Gets the next span (and places it in scope) so code between here and postProcess can read it
    Span span = ThreadLocalSpan.CURRENT_TRACER.next();
    if (span == null || span.isNoop()) return null;

    String sql = sqlSupplier.get();

    // ↓ THIS
    if (interceptedQuery instanceof ClientPreparedStatement) {
      Query query = ((ClientPreparedStatement) interceptedQuery).getQuery();
      if (query instanceof ClientPreparedQuery) {
        sql = ((ClientPreparedQuery) query).getOriginalSql();
      }
    }
    // ↑ THIS

    int spaceIndex = sql.indexOf(' '); // Allow span names of single-word statements like COMMIT
    span.kind(CLIENT).name(spaceIndex == -1 ? sql : sql.substring(0, spaceIndex));
    span.tag("sql.query", sql);
    parseServerIpAndPort(connection, span);
    span.start();
    return null;
  }

[jcchavezs]

Thanks for detailed use case. Are you up for a PR to fix this?

[be-hase]

OK, please wait. :)

[jcchavezs]

Awesome!