elastic#3030: Removing unused error capture and make use of a tracer …

…subtype in one module to demonstrate expandability.
raphw · Feb 22, 2023 · 5d0a5f7 · 5d0a5f7
1 parent 73ee8a8
commit 5d0a5f7
Show file tree

Hide file tree

Showing 22 changed files with 135 additions and 135 deletions.
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/BasicTracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/BasicTracer.java
@@ -36,6 +36,7 @@
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakConcurrent;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakMap;
 import co.elastic.apm.plugin.spi.*;
+import co.elastic.apm.plugin.spi.Tracer;
 
 import javax.annotation.Nullable;
 import java.util.Collections;
@@ -487,12 +488,6 @@ public String captureAndReportException(long epochMicros, @Nullable Throwable e,
         return captureAndReportException(epochMicros, e, (AbstractSpan<?>) parent);
     }
 
-    @Nullable
-    @Override
-    public co.elastic.apm.plugin.spi.ErrorCapture captureException(@Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader) {
-        return captureException(e, (AbstractSpan<?>) parent, initiatingClassLoader);
-    }
-
     @Override
     public void endSpan(co.elastic.apm.plugin.spi.Span<?> span) {
         endSpan((Span) span);
@@ -503,11 +498,6 @@ public void endTransaction(co.elastic.apm.plugin.spi.Transaction<?> transaction)
         endTransaction((Transaction) transaction);
     }
 
-    @Override
-    public void endError(co.elastic.apm.plugin.spi.ErrorCapture errorCapture) {
-        endError((ErrorCapture) errorCapture);
-    }
-
     @Override
     public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm.plugin.spi.ServiceInfo serviceInfo) {
         setServiceInfoForClassLoader(classLoader, serviceInfo.isMultiServiceContainer()
@@ -519,4 +509,23 @@ public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm
     public ServiceInfo autoDetectedServiceName() {
         return ServiceInfo.autoDetected();
     }
+
+    @Nullable
+    @Override
+    public <T extends Tracer> T probe(Class<T> type) {
+        if (type.isInstance(this)) {
+            return type.cast(this);
+        } else {
+            return null;
+        }
+    }
+
+    @Override
+    public <T extends Tracer> T require(Class<T> type) {
+        T tracer = probe(type);
+        if (tracer == null) {
+            throw new IllegalStateException(this + " tracer does not support features of " + type.getName());
+        }
+        return tracer;
+    }
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/GlobalTracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/GlobalTracer.java
@@ -51,22 +51,9 @@ public static Tracer get() {
         return INSTANCE;
     }
 
-    @Nullable
-    public static <T extends Tracer> T get(Class<T> type) {
-        Tracer tracer = INSTANCE.tracer;
-        if (type.isInstance(tracer)) {
-            return type.cast(tracer);
-        }
-        return null;
-    }
-
-    public static <T extends Tracer> T require(Class<T> type) {
-        return Objects.requireNonNull(get(type), "Registered tracer is not an instance of " + type.getName());
-    }
-
     @Nullable
     public static ElasticApmTracer getTracerImpl() {
-        return get(ElasticApmTracer.class);
+        return get().probe(ElasticApmTracer.class);
     }
 
     public static ElasticApmTracer requireTracerImpl() {
@@ -302,12 +289,6 @@ public String captureAndReportException(long epochMicros, @Nullable Throwable e,
         return tracer.captureAndReportException(epochMicros, e, parent);
     }
 
-    @Nullable
-    @Override
-    public co.elastic.apm.plugin.spi.ErrorCapture captureException(@Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader) {
-        return tracer.captureException(e, parent, initiatingClassLoader);
-    }
-
     @Override
     public void endSpan(co.elastic.apm.plugin.spi.Span<?> span) {
         tracer.endSpan(span);
@@ -318,11 +299,6 @@ public void endTransaction(co.elastic.apm.plugin.spi.Transaction<?> transaction)
         tracer.endTransaction(transaction);
     }
 
-    @Override
-    public void endError(co.elastic.apm.plugin.spi.ErrorCapture errorCapture) {
-        tracer.endError(errorCapture);
-    }
-
     @Override
     public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm.plugin.spi.ServiceInfo serviceInfo) {
         tracer.setServiceInfoForClassLoader(classLoader, serviceInfo);
@@ -332,4 +308,15 @@ public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm
     public ServiceInfo autoDetectedServiceName() {
         return tracer.autoDetectedServiceName();
     }
+
+    @Nullable
+    @Override
+    public <T extends co.elastic.apm.plugin.spi.Tracer> T probe(Class<T> type) {
+        return tracer.probe(type);
+    }
+
+    @Override
+    public <T extends co.elastic.apm.plugin.spi.Tracer> T require(Class<T> type) {
+        return tracer.require(type);
+    }
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/MetricsAwareTracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/MetricsAwareTracer.java
@@ -18,9 +18,22 @@
  */
 package co.elastic.apm.agent.impl;
 
+import co.elastic.apm.agent.impl.metadata.MetaDataFuture;
 import co.elastic.apm.agent.metrics.MetricRegistry;
+import co.elastic.apm.agent.report.Reporter;
+
+import java.io.Closeable;
+import java.util.concurrent.ScheduledExecutorService;
 
 public interface MetricsAwareTracer extends SpanAwareTracer {
 
     MetricRegistry getMetricRegistry();
+
+    Reporter getReporter();
+
+    void addShutdownHook(Closeable closeable);
+
+    ScheduledExecutorService getSharedSingleThreadedPool();
+
+    MetaDataFuture getMetaDataFuture();
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/NoopTracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/NoopTracer.java
@@ -205,30 +205,31 @@ public String captureAndReportException(long epochMicros, @Nullable Throwable e,
         return null;
     }
 
-    @Nullable
     @Override
-    public co.elastic.apm.plugin.spi.ErrorCapture captureException(@Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader) {
-        return null;
+    public void endSpan(co.elastic.apm.plugin.spi.Span<?> span) {
     }
 
     @Override
-    public void endSpan(co.elastic.apm.plugin.spi.Span<?> span) {
+    public void endTransaction(co.elastic.apm.plugin.spi.Transaction<?> transaction) {
     }
 
     @Override
-    public void endTransaction(co.elastic.apm.plugin.spi.Transaction<?> transaction) {
+    public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm.plugin.spi.ServiceInfo serviceInfo) {
     }
 
     @Override
-    public void endError(co.elastic.apm.plugin.spi.ErrorCapture errorCapture) {
+    public ServiceInfo autoDetectedServiceName() {
+        return null;
     }
 
+    @Nullable
     @Override
-    public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm.plugin.spi.ServiceInfo serviceInfo) {
+    public <T extends co.elastic.apm.plugin.spi.Tracer> T probe(Class<T> type) {
+        return null;
     }
 
     @Override
-    public ServiceInfo autoDetectedServiceName() {
+    public <T extends co.elastic.apm.plugin.spi.Tracer> T require(Class<T> type) {
         return null;
     }
 }
diff --git a/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/GlobalTracer.java b/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/GlobalTracer.java
@@ -19,7 +19,6 @@
 package co.elastic.apm.plugin.spi;
 
 import javax.annotation.Nullable;
-import java.util.Objects;
 
 public class GlobalTracer implements Tracer {
 
@@ -33,19 +32,6 @@ public static Tracer get() {
         return INSTANCE;
     }
 
-    @Nullable
-    public static <T extends Tracer> T get(Class<T> type) {
-        Tracer tracer = INSTANCE.tracer;
-        if (type.isInstance(tracer)) {
-            return type.cast(tracer);
-        }
-        return null;
-    }
-
-    public static <T extends Tracer> T require(Class<T> type) {
-        return Objects.requireNonNull(get(type), "Registered tracer is not an instance of " + type.getName());
-    }
-
     public static synchronized void init(Tracer tracer) {
         if (!isNoop()) {
             throw new IllegalStateException("Tracer is already initialized");
@@ -110,11 +96,6 @@ public String captureAndReportException(long epochMicros, @Nullable Throwable e,
         return tracer.captureAndReportException(epochMicros, e, parent);
     }
 
-    @Nullable
-    public ErrorCapture captureException(@Nullable Throwable e, @Nullable AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader) {
-        return tracer.captureException(e, parent, initiatingClassLoader);
-    }
-
     @Nullable
     @Override
     public Span<?> getActiveExitSpan() {
@@ -137,11 +118,6 @@ public void endTransaction(Transaction<?> transaction) {
         tracer.endTransaction(transaction);
     }
 
-    @Override
-    public void endError(ErrorCapture errorCapture) {
-        tracer.endError(errorCapture);
-    }
-
     @Override
     public <T> T getConfig(Class<T> configuration) {
         return tracer.getConfig(configuration);
@@ -171,4 +147,15 @@ public ServiceInfo getServiceInfoForClassLoader(ClassLoader classLoader) {
     public ServiceInfo autoDetectedServiceName() {
         return tracer.autoDetectedServiceName();
     }
+
+    @Nullable
+    @Override
+    public <T extends Tracer> T probe(Class<T> type) {
+        return tracer.probe(type);
+    }
+
+    @Override
+    public <T extends Tracer> T require(Class<T> type) {
+        return tracer.require(type);
+    }
 }
diff --git a/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/NoopTracer.java b/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/NoopTracer.java
@@ -67,12 +67,6 @@ public String captureAndReportException(long epochMicros, @Nullable Throwable e,
         return null;
     }
 
-    @Nullable
-    @Override
-    public ErrorCapture captureException(@Nullable Throwable e, @Nullable AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader) {
-        return null;
-    }
-
     @Nullable
     @Override
     public Span<?> getActiveExitSpan() {
@@ -93,10 +87,6 @@ public void endSpan(Span<?> span) {
     public void endTransaction(Transaction<?> transaction) {
     }
 
-    @Override
-    public void endError(ErrorCapture errorCapture) {
-    }
-
     @Override
     public <T> T getConfig(Class<T> configuration) {
         return null;
@@ -125,4 +115,15 @@ public ServiceInfo getServiceInfoForClassLoader(ClassLoader classLoader) {
     public ServiceInfo autoDetectedServiceName() {
         return null;
     }
+
+    @Nullable
+    @Override
+    public <T extends Tracer> T probe(Class<T> type) {
+        return null;
+    }
+
+    @Override
+    public <T extends Tracer> T require(Class<T> type) {
+        return null;
+    }
 }
diff --git a/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/Tracer.java b/apm-agent-plugin-spi/src/main/java/co/elastic/apm/plugin/spi/Tracer.java
@@ -51,9 +51,6 @@ public interface Tracer {
     @Nullable
     String captureAndReportException(long epochMicros, @Nullable Throwable e, @Nullable AbstractSpan<?> parent);
 
-    @Nullable
-    ErrorCapture captureException(@Nullable Throwable e, @Nullable AbstractSpan<?> parent, @Nullable ClassLoader initiatingClassLoader);
-
     @Nullable
     Span<?> getActiveExitSpan();
 
@@ -64,8 +61,6 @@ public interface Tracer {
 
     void endTransaction(Transaction<?> transaction);
 
-    void endError(ErrorCapture errorCapture);
-
     <T> T getConfig(Class<T> configuration);
 
     ObjectPoolFactory getObjectPoolFactory();
@@ -77,4 +72,9 @@ public interface Tracer {
     ServiceInfo getServiceInfoForClassLoader(ClassLoader classLoader);
 
     ServiceInfo autoDetectedServiceName();
+
+    @Nullable
+    <T extends Tracer> T probe(Class<T> type);
+
+    <T extends Tracer> T require(Class<T> type);
 }
diff --git a/...c/main/java/co/elastic/apm/agent/awslambda/helper/APIGatewayProxyV1TransactionHelper.java b/...c/main/java/co/elastic/apm/agent/awslambda/helper/APIGatewayProxyV1TransactionHelper.java
@@ -19,10 +19,10 @@
 package co.elastic.apm.agent.awslambda.helper;
 
 import co.elastic.apm.agent.awslambda.MapTextHeaderGetter;
-import co.elastic.apm.agent.impl.ElasticApmTracer;
-import co.elastic.apm.agent.impl.GlobalTracer;
+import co.elastic.apm.agent.impl.MetricsAwareTracer;
 import co.elastic.apm.agent.impl.transaction.Transaction;
 import co.elastic.apm.agent.util.PrivilegedActionUtils;
+import co.elastic.apm.plugin.spi.GlobalTracer;
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent;
@@ -35,13 +35,13 @@ public class APIGatewayProxyV1TransactionHelper extends AbstractAPIGatewayTransa
     @Nullable
     private static APIGatewayProxyV1TransactionHelper INSTANCE;
 
-    private APIGatewayProxyV1TransactionHelper(ElasticApmTracer tracer) {
+    private APIGatewayProxyV1TransactionHelper(MetricsAwareTracer tracer) {
         super(tracer);
     }
 
     public static APIGatewayProxyV1TransactionHelper getInstance() {
         if (INSTANCE == null) {
-            INSTANCE = new APIGatewayProxyV1TransactionHelper(GlobalTracer.requireTracerImpl());
+            INSTANCE = new APIGatewayProxyV1TransactionHelper(GlobalTracer.get().require(MetricsAwareTracer.class));
         }
         return INSTANCE;
     }

diff --git a/...c/main/java/co/elastic/apm/agent/awslambda/helper/APIGatewayProxyV2TransactionHelper.java b/...c/main/java/co/elastic/apm/agent/awslambda/helper/APIGatewayProxyV2TransactionHelper.java
@@ -19,10 +19,10 @@
 package co.elastic.apm.agent.awslambda.helper;
 
 import co.elastic.apm.agent.awslambda.MapTextHeaderGetter;
-import co.elastic.apm.agent.impl.ElasticApmTracer;
-import co.elastic.apm.agent.impl.GlobalTracer;
+import co.elastic.apm.agent.impl.MetricsAwareTracer;
 import co.elastic.apm.agent.impl.transaction.Transaction;
 import co.elastic.apm.agent.util.PrivilegedActionUtils;
+import co.elastic.apm.plugin.spi.GlobalTracer;
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPEvent;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPResponse;
@@ -33,13 +33,13 @@ public class APIGatewayProxyV2TransactionHelper extends AbstractAPIGatewayTransa
     @Nullable
     private static APIGatewayProxyV2TransactionHelper INSTANCE;
 
-    private APIGatewayProxyV2TransactionHelper(ElasticApmTracer tracer) {
+    private APIGatewayProxyV2TransactionHelper(MetricsAwareTracer tracer) {
         super(tracer);
     }
 
     public static APIGatewayProxyV2TransactionHelper getInstance() {
         if (INSTANCE == null) {
-            INSTANCE = new APIGatewayProxyV2TransactionHelper(GlobalTracer.requireTracerImpl());
+            INSTANCE = new APIGatewayProxyV2TransactionHelper(GlobalTracer.get().require(MetricsAwareTracer.class));
         }
         return INSTANCE;
     }