feat(traces): fix for lint and pmd checks

Author: Umaaz

agent/src/main/java/com/intergral/deep/agent/tracepoint/inst/asm/TransformerUtils.java

@@ -33,8 +33,9 @@ public final class TransformerUtils {
 
   private TransformerUtils() {
   }
-  static final boolean ALLOW_LINE_NUMBERS = Boolean.getBoolean( "deep.line.numbers" );
-  static final int LINE_OFFSET = Integer.getInteger( "deep.line.offset", 20000 );
+
+  static final boolean ALLOW_LINE_NUMBERS = Boolean.getBoolean("deep.line.numbers");
+  static final int LINE_OFFSET = Integer.getInteger("deep.line.offset", 20000);
   static final boolean USE_SYNTHETIC = Boolean.parseBoolean(System.getProperty("deep.use.synthetic", "false"));
   private static final List<String> EXCLUDE_PACKAGES = Collections.emptyList();
   private static final List<String> EXCLUDE_CONTAINS = Collections.emptyList();

agent/src/test/java/com/intergral/deep/agent/tracepoint/handler/CallbackTest.java

@@ -37,6 +37,7 @@ class CallbackTest {
   private final Settings settings = Mockito.mock(Settings.class);
   private final TracepointConfigService tracepointConfigService = Mockito.mock(TracepointConfigService.class);
   private final PushService pushService = Mockito.mock(PushService.class);
+
   @BeforeEach
   void setUp() {
     Callback.init(settings, tracepointConfigService, pushService);

agent/src/test/java/com/intergral/deep/agent/tracepoint/inst/MixinTemplate.java renamed to agent/src/test/java/com/intergral/deep/test/MockMixinTemplate.java

@@ -15,7 +15,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package com.intergral.deep.agent.tracepoint.inst;
+package com.intergral.deep.test;
 
 import com.intergral.deep.agent.tracepoint.handler.Callback;
 import java.io.Closeable;
@@ -26,11 +26,14 @@
  * <p>
  * We use the ASM plugin for idea to simplify this process <a href="https://plugins.jetbrains.com/plugin/23368-asm-viewer">ASM Viewer</a>.
  */
-public class MixinTemplate {
+public class MockMixinTemplate {
 
   public void $deep$voidTemplate() {
   }
 
+  public void $deep$voidTemplate(final String arg1) {
+  }
+
   public void voidTemplate() {
     final Closeable closeable = Callback.span("voidTemplate");
     try {
@@ -46,14 +49,10 @@ public void voidTemplate() {
     }
   }
 
-  public int $deep$intTemplate() {
-    return -1;
-  }
-
-  public int intTemplate() {
-    final Closeable closeable = Callback.span("intTemplate");
+  public void voidTemplate(final String arg1) {
+    final Closeable closeable = Callback.span("voidTemplate");
     try {
-      return $deep$intTemplate();
+      $deep$voidTemplate(arg1);
     } finally {
       try {
         if (closeable != null) {
@@ -65,12 +64,16 @@ public int intTemplate() {
     }
   }
 
-  public Object $deep$objectTemplate() {
-    return null;
+  public int $deep$intTemplate() {
+    return -1;
   }
 
-  public Object objectTemplate() {
-    final Closeable closeable = Callback.span("objectTemplate");
+  public int $deep$intTemplate(final String arg1) {
+    return -1;
+  }
+
+  public int intTemplate() {
+    final Closeable closeable = Callback.span("intTemplate");
     try {
       return $deep$intTemplate();
     } finally {
@@ -84,13 +87,11 @@ public Object objectTemplate() {
     }
   }
 
-  public void $deep$voidTemplate(final String arg1) {
-  }
 
-  public void voidTemplate(final String arg1) {
-    final Closeable closeable = Callback.span("voidTemplate");
+  public int intTemplate(final String arg1) {
+    final Closeable closeable = Callback.span("intTemplate");
     try {
-      $deep$voidTemplate(arg1);
+      return $deep$intTemplate(arg1);
     } finally {
       try {
         if (closeable != null) {
@@ -102,14 +103,18 @@ public void voidTemplate(final String arg1) {
     }
   }
 
-  public int $deep$intTemplate(final String arg1) {
-    return -1;
+  public Object $deep$objectTemplate() {
+    return null;
   }
 
-  public int intTemplate(final String arg1) {
-    final Closeable closeable = Callback.span("intTemplate");
+  public Object $deep$objectTemplate(final String arg1) {
+    return null;
+  }
+
+  public Object objectTemplate() {
+    final Closeable closeable = Callback.span("objectTemplate");
     try {
-      return $deep$intTemplate(arg1);
+      return $deep$intTemplate();
     } finally {
       try {
         if (closeable != null) {
@@ -121,9 +126,6 @@ public int intTemplate(final String arg1) {
     }
   }
 
-  public Object $deep$objectTemplate(final String arg1) {
-    return null;
-  }
 
   public Object objectTemplate(final String arg1) {
     final Closeable closeable = Callback.span("objectTemplate");

checkstyle-suppressions.xml

@@ -28,6 +28,8 @@
   <suppress checks="MissingJavadocType" files=".*/tests/.*"/>
   <suppress checks="MissingJavadocMethod" files=".*/tests/.*"/>
   <suppress checks="AvoidStarImport" files=".*Test(Target|).java"/>
+  <!-- We do not care to check the method names in this file  -->
+  <suppress checks="MethodName" files=".*MockMixinTemplate.java"/>
   <!-- These files are imported from external libraries and should not have our copyright -->
   <suppress id="license-agpl" files=".*resource/Resource.*"/>
   <suppress id="license-agpl" files=".*resource/SpiUtil.*"/>

examples/otel-example/src/main/java/com/intergral/deep/examples/Main.java

@@ -124,16 +124,13 @@ public static void main(String[] args) throws Throwable {
         e.printStackTrace();
       }
 
-      double duration = Math.abs(random.nextGaussian() / 10.0 + 0.2);
-      String status = random.nextInt(100) < 20 ? "500" : "200";
-
       //noinspection BusyWait
       Thread.sleep(1000);
       span.end();
     }
   }
 
-  public static OpenTelemetry openTelemetry() {
+  private static OpenTelemetry openTelemetry() {
     Resource resource = Resource.getDefault().toBuilder().put("service-name", "dice-server").put("service-version", "0.1.0").build();
 
     SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
@@ -151,13 +148,12 @@ public static OpenTelemetry openTelemetry() {
         .setResource(resource)
         .build();
 
-    OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
+    return OpenTelemetrySdk.builder()
         .setTracerProvider(sdkTracerProvider)
         .setMeterProvider(sdkMeterProvider)
         .setLoggerProvider(sdkLoggerProvider)
-        .setPropagators(ContextPropagators.create(TextMapPropagator.composite(W3CTraceContextPropagator.getInstance(), W3CBaggagePropagator.getInstance())))
+        .setPropagators(ContextPropagators.create(
+            TextMapPropagator.composite(W3CTraceContextPropagator.getInstance(), W3CBaggagePropagator.getInstance())))
         .buildAndRegisterGlobal();
-
-    return openTelemetry;
   }
 }

plugins/otel-plugin/src/main/java/com/intergral/deep/plugin/OtelPlugin.java

@@ -39,6 +39,13 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * This plugin provides a connection between Deep and Otel. Allowing:
+ * <ul>
+ *  <li>Metrics to be processed via Otel</li>
+ *  <li>Traces to be created using Otel</li>
+ *  </ul>
+ */
 public class OtelPlugin implements IDeepPlugin, ITraceProvider, IMetricProcessor, IConditional, ISnapshotDecorator {
 
   @Override
@@ -112,7 +119,7 @@ public String spanId() {
       }
 
       @Override
-      public void close() throws Exception {
+      public void close() {
         try {
           span.end();
         } catch (Throwable ignored) {