Allow changing slowQueryThresholdMs in code (#111)

Fixes #107
opentracing-contrib · Feb 23, 2021 · e6b2ef9 · e6b2ef9
1 parent 6b7c2b6
commit e6b2ef9
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -164,7 +164,7 @@ public class OpenTracingConfig {
 Span is marked by tag `slow=true` if duration exceed `slowQueryThresholdMs`.
 `slowQueryThresholdMs` defaults to `0` which means disabled, can be enabled in two ways:
 1. Passing system property, E.g. `-Dio.opentracing.contrib.jdbc.slowQueryThresholdMs=100`
-2. Modified static field value by code, E.g. `io.opentracing.contrib.jdbc.JdbcTracingUtils.slowQueryThresholdMs=100`
+2. Modify value by code, E.g. `io.opentracing.contrib.jdbc.JdbcTracing.setSlowQueryThresholdMs(100)`
 
 ## Troubleshooting
 In case of _Unable to find a driver_ error the database driver should be registered before configuring

diff --git a/src/main/java/io/opentracing/contrib/jdbc/JdbcTracing.java b/src/main/java/io/opentracing/contrib/jdbc/JdbcTracing.java
@@ -28,4 +28,18 @@ public static void setTraceEnabled(boolean traceEnabled) {
   public static boolean isTraceEnabled() {
     return JdbcTracing.traceEnabled;
   }
+
+  /**
+   * can be modified by application code
+   */
+  private static int slowQueryThresholdMs = Integer.getInteger("io.opentracing.contrib.jdbc.slowQueryThresholdMs", 0);
+
+  public static int getSlowQueryThresholdMs() {
+    return slowQueryThresholdMs;
+  }
+
+  public static void setSlowQueryThresholdMs(final int slowQueryThresholdMs) {
+    JdbcTracing.slowQueryThresholdMs = slowQueryThresholdMs;
+  }
+
 }
diff --git a/src/main/java/io/opentracing/contrib/jdbc/JdbcTracingUtils.java b/src/main/java/io/opentracing/contrib/jdbc/JdbcTracingUtils.java
@@ -36,11 +36,6 @@ class JdbcTracingUtils {
 
   static final BooleanTag SLOW = new BooleanTag("slow");
 
-  /**
-   * can be modified by application code
-   */
-  public static int slowQueryThresholdMs = Integer.getInteger("io.opentracing.contrib.jdbc.slowQueryThresholdMs", 0);
-
   static Span buildSpan(String operationName,
       String sql,
       ConnectionInfo connectionInfo,
@@ -76,14 +71,14 @@ static <E extends Exception> void execute(String operationName,
 
     final Span span = buildSpan(operationName, sql, connectionInfo, withActiveSpanOnly,
     ignoreStatements, tracer);
-    long time = slowQueryThresholdMs  > 0 ? System.nanoTime() : 0;
+    long time = JdbcTracing.getSlowQueryThresholdMs()  > 0 ? System.nanoTime() : 0;
     try (Scope ignored = tracer.activateSpan(span)) {
        runnable.run();
     } catch (Exception e) {
       JdbcTracingUtils.onError(e, span);
       throw e;
     } finally {
-      if (slowQueryThresholdMs > 0 && System.nanoTime() - time > TimeUnit.MILLISECONDS.toNanos(slowQueryThresholdMs)) {
+      if (JdbcTracing.getSlowQueryThresholdMs() > 0 && System.nanoTime() - time > TimeUnit.MILLISECONDS.toNanos(JdbcTracing.getSlowQueryThresholdMs())) {
         SLOW.set(span, true);
       }
       span.finish();
@@ -103,14 +98,14 @@ static <T, E extends Exception> T call(String operationName,
 
     final Span span = buildSpan(operationName, sql, connectionInfo, withActiveSpanOnly,
         ignoreStatements, tracer);
-    long time = slowQueryThresholdMs  > 0 ? System.nanoTime() : 0;
+    long time = JdbcTracing.getSlowQueryThresholdMs()  > 0 ? System.nanoTime() : 0;
     try (Scope ignored = tracer.activateSpan(span)) {
       return callable.call();
     } catch (Exception e) {
       JdbcTracingUtils.onError(e, span);
       throw e;
     } finally {
-      if (slowQueryThresholdMs > 0 && System.nanoTime() - time > TimeUnit.MILLISECONDS.toNanos(slowQueryThresholdMs)) {
+      if (JdbcTracing.getSlowQueryThresholdMs() > 0 && System.nanoTime() - time > TimeUnit.MILLISECONDS.toNanos(JdbcTracing.getSlowQueryThresholdMs())) {
         SLOW.set(span, true);
       }
       span.finish();

diff --git a/src/test/java/io/opentracing/contrib/jdbc/JdbcTracingUtilsTest.java b/src/test/java/io/opentracing/contrib/jdbc/JdbcTracingUtilsTest.java
@@ -23,6 +23,7 @@
 import java.sql.Connection;
 import java.sql.DriverManager;
 import java.sql.Statement;
+import java.util.Collections;
 import java.util.List;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -41,11 +42,13 @@ public static void init() {
   @Before
   public void before() {
     mockTracer.reset();
+    JdbcTracing.setSlowQueryThresholdMs(0);
   }
 
   @AfterClass
   public static void afterClass() {
     TracingDriver.setTraceEnabled(true);
+    JdbcTracing.setSlowQueryThresholdMs(0);
   }
 
   @Test
@@ -73,4 +76,24 @@ public void buildSpanWithoutTraceEnabled() throws Exception {
 
     assertTrue(mockTracer.finishedSpans().isEmpty());
   }
+
+  @Test
+  public void setSlowTagCorrectly() throws Exception {
+    final int slowQueryThresholdMs = 100;
+    JdbcTracing.setSlowQueryThresholdMs(slowQueryThresholdMs);
+
+    JdbcTracingUtils.execute(
+        "SlowQuery",
+        () -> Thread.sleep(slowQueryThresholdMs * 2),
+        null,
+        ConnectionInfo.UNKNOWN_CONNECTION_INFO,
+        false,
+        Collections.emptySet(),
+        mockTracer);
+
+    final List<MockSpan> finishedSpans = mockTracer.finishedSpans();
+    assertEquals("Should have traced a query execution", 1, finishedSpans.size());
+    final MockSpan slowQuerySpan = finishedSpans.get(0);
+    assertTrue("Span should be tagged slow", slowQuerySpan.tags().containsKey(JdbcTracingUtils.SLOW.getKey()));
+  }
 }