Tracing: added abstract tracing classes to driver

While building a Cluster object, one can pass a TracingInfo class
implementation and it will be used for tracing in all sessions
with this cluster from now on.

Author: wprzytula

clirr-ignores.xml

@@ -16,6 +16,12 @@
     Modified by ScyllaDB
 -->
 <differences>
+    <difference>
+        <differenceType>7012</differenceType> <!-- method added to interface -->
+        <className>com/datastax/driver/core/Session</className>
+        <method>com.datastax.driver.core.tracing.TracingInfoFactory getTracingInfoFactory()</method>
+        <justification>New method to get the TracingInfo data factory associated with this Session</justification>
+    </difference>
     <difference>
         <differenceType>7004</differenceType> <!-- the number of arguments has changed -->
         <className>com/datastax/driver/core/Metadata</className>

driver-core/src/main/java/com/datastax/driver/core/Cluster.java

@@ -39,6 +39,8 @@
 import com.datastax.driver.core.policies.ReconnectionPolicy;
 import com.datastax.driver.core.policies.RetryPolicy;
 import com.datastax.driver.core.policies.SpeculativeExecutionPolicy;
+import com.datastax.driver.core.tracing.NoopTracingInfoFactory;
+import com.datastax.driver.core.tracing.TracingInfoFactory;
 import com.datastax.driver.core.utils.MoreFutures;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Functions;
@@ -146,6 +148,8 @@ public class Cluster implements Closeable {
 
   final Manager manager;
 
+  private TracingInfoFactory tracingInfoFactory = new NoopTracingInfoFactory();
+
   /**
    * Constructs a new Cluster instance.
    *
@@ -197,6 +201,25 @@ private Cluster(
     this.manager = new Manager(name, contactPoints, configuration, listeners);
   }
 
+  /**
+   * The tracingInfo factory class used by this Cluster.
+   *
+   * @return the factory used currently by this Cluster.
+   */
+  public TracingInfoFactory getTracingInfoFactory() {
+    return tracingInfoFactory;
+  }
+
+  /**
+   * Sets desired factory for tracing information for this Cluster. By default it is {@link
+   * com.datastax.driver.core.tracing.NoopTracingInfoFactory}
+   *
+   * @param tracingInfoFactory the factory to be set for this Cluster.
+   */
+  public void setTracingInfoFactory(TracingInfoFactory tracingInfoFactory) {
+    this.tracingInfoFactory = tracingInfoFactory;
+  }
+
   /**
    * Initialize this Cluster instance.
    *

driver-core/src/main/java/com/datastax/driver/core/Session.java

@@ -13,13 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/*
+ * Copyright (C) 2021 ScyllaDB
+ *
+ * Modified by ScyllaDB
+ */
 package com.datastax.driver.core;
 
 import com.datastax.driver.core.exceptions.AuthenticationException;
 import com.datastax.driver.core.exceptions.NoHostAvailableException;
 import com.datastax.driver.core.exceptions.QueryExecutionException;
 import com.datastax.driver.core.exceptions.QueryValidationException;
 import com.datastax.driver.core.exceptions.UnsupportedFeatureException;
+import com.datastax.driver.core.tracing.TracingInfoFactory;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.io.Closeable;
 import java.util.Collection;
@@ -41,6 +48,13 @@
  */
 public interface Session extends Closeable {
 
+  /**
+   * The tracingInfo factory class used by this Session.
+   *
+   * @return the factory used currently by this Session.
+   */
+  TracingInfoFactory getTracingInfoFactory();
+
   /**
    * The keyspace to which this Session is currently logged in, if any.
    *

driver-core/src/main/java/com/datastax/driver/core/SessionManager.java

@@ -29,6 +29,7 @@
 import com.datastax.driver.core.policies.LoadBalancingPolicy;
 import com.datastax.driver.core.policies.ReconnectionPolicy;
 import com.datastax.driver.core.policies.SpeculativeExecutionPolicy;
+import com.datastax.driver.core.tracing.TracingInfoFactory;
 import com.datastax.driver.core.utils.MoreFutures;
 import com.google.common.base.Functions;
 import com.google.common.collect.ImmutableList;
@@ -76,6 +77,11 @@ class SessionManager extends AbstractSession {
     this.poolsState = new HostConnectionPool.PoolState();
   }
 
+  @Override
+  public TracingInfoFactory getTracingInfoFactory() {
+    return cluster.getTracingInfoFactory();
+  }
+
   @Override
   public Session init() {
     try {

driver-core/src/main/java/com/datastax/driver/core/tracing/NoopTracingInfoFactory.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (C) 2021 ScyllaDB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.datastax.driver.core.tracing;
+
+public class NoopTracingInfoFactory implements TracingInfoFactory {
+
+  private static class NoopTracingInfo implements TracingInfo {
+    @Override
+    public void setNameAndStartTime(String name) {}
+
+    @Override
+    public void tracingFinished() {}
+  }
+
+  public static final NoopTracingInfo INSTANCE = new NoopTracingInfo();
+
+  @Override
+  public TracingInfo buildTracingInfo() {
+    return INSTANCE;
+  }
+
+  @Override
+  public TracingInfo buildTracingInfo(TracingInfo parent) {
+    return new NoopTracingInfo();
+  }
+}

driver-core/src/test/java/com/datastax/driver/core/AsyncQueryTest.java

@@ -27,6 +27,7 @@
 import static org.testng.Assert.assertTrue;
 
 import com.datastax.driver.core.exceptions.InvalidQueryException;
+import com.datastax.driver.core.tracing.TracingInfoFactory;
 import com.datastax.driver.core.utils.CassandraVersion;
 import com.google.common.base.Function;
 import com.google.common.base.Throwables;
@@ -286,6 +287,11 @@ public ResultSet execute(Statement statement) {
       return executeAsync(statement).getUninterruptibly();
     }
 
+    @Override
+    public TracingInfoFactory getTracingInfoFactory() {
+      return session.getTracingInfoFactory();
+    }
+
     @Override
     public String getLoggedKeyspace() {
       return session.getLoggedKeyspace();

driver-core/src/test/java/com/datastax/driver/core/DelegatingClusterTest.java

@@ -29,7 +29,8 @@
 import org.testng.annotations.Test;
 
 public class DelegatingClusterTest {
-  private static final Set<String> NON_DELEGATED_METHODS = ImmutableSet.of("getClusterName");
+  private static final Set<String> NON_DELEGATED_METHODS =
+      ImmutableSet.of("getClusterName", "setTracingInfoFactory", "getTracingInfoFactory");
 
   /**
    * Checks that all methods of {@link DelegatingCluster} invoke their counterpart in {@link