elastic#3030: Introduce SPI for plugins to avoid need for dependency …

…on main Elastic agent. Refactor plugins in a binary compatible manner to make use of the new API.
raphw · Feb 22, 2023 · fed3133 · fed3133
1 parent 0f0b724
commit fed3133
Show file tree

Hide file tree

Showing 337 changed files with 3,072 additions and 1,279 deletions.
diff --git a/apm-agent-core/pom.xml b/apm-agent-core/pom.xml
@@ -38,6 +38,11 @@
             <artifactId>apm-agent-cached-lookup-key</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>apm-agent-plugin-spi</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>com.blogspot.mydailyjava</groupId>
             <artifactId>weak-lock-free</artifactId>

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/collections/SpanConcurrentHashMap.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/collections/SpanConcurrentHashMap.java
@@ -18,7 +18,7 @@
  */
 package co.elastic.apm.agent.collections;
 
-import co.elastic.apm.agent.impl.transaction.AbstractSpan;
+import co.elastic.apm.plugin.spi.AbstractSpan;
 
 import javax.annotation.Nullable;
 import java.util.Iterator;

diff --git a/...agent-core/src/main/java/co/elastic/apm/agent/collections/WeakConcurrentProviderImpl.java b/...agent-core/src/main/java/co/elastic/apm/agent/collections/WeakConcurrentProviderImpl.java
@@ -18,11 +18,11 @@
  */
 package co.elastic.apm.agent.collections;
 
-import co.elastic.apm.agent.impl.transaction.AbstractSpan;
 import co.elastic.apm.agent.sdk.weakconcurrent.DetachedThreadLocal;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakConcurrent;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakMap;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakSet;
+import co.elastic.apm.plugin.spi.AbstractSpan;
 import com.blogspot.mydailyjava.weaklockfree.AbstractWeakConcurrentMap;
 import com.blogspot.mydailyjava.weaklockfree.WeakConcurrentSet;
 

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/ServiceInfo.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/ServiceInfo.java
@@ -28,18 +28,13 @@
 import java.util.jar.JarFile;
 import java.util.jar.Manifest;
 
-public class ServiceInfo {
+public class ServiceInfo extends co.elastic.apm.plugin.spi.ServiceInfo {
 
     private static final String JAR_VERSION_SUFFIX = "-(\\d+\\.)+(\\d+)(.*)?$";
     private static final String DEFAULT_SERVICE_NAME = "unknown-java-service";
     private static final ServiceInfo EMPTY = new ServiceInfo(null, null);
     private static final ServiceInfo AUTO_DETECTED = autoDetect(System.getProperties(), PrivilegedActionUtils.getEnv());
 
-    private final String serviceName;
-    @Nullable
-    private final String serviceVersion;
-    private final boolean multiServiceContainer;
-
     public ServiceInfo(@Nullable String serviceName) {
         this(serviceName, null);
     }
@@ -49,13 +44,7 @@ private ServiceInfo(@Nullable String serviceName, @Nullable String serviceVersio
     }
 
     private ServiceInfo(@Nullable String serviceName, @Nullable String serviceVersion, boolean multiServiceContainer) {
-        this.multiServiceContainer = multiServiceContainer;
-        if (serviceName == null || serviceName.trim().isEmpty()) {
-            this.serviceName = DEFAULT_SERVICE_NAME;
-        } else {
-            this.serviceName = replaceDisallowedServiceNameChars(serviceName).trim();
-        }
-        this.serviceVersion = serviceVersion;
+        super(serviceName, serviceVersion, multiServiceContainer);
     }
 
     public static ServiceInfo empty() {

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
@@ -28,7 +28,6 @@
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakConcurrent;
 import co.elastic.apm.agent.sdk.weakconcurrent.WeakMap;
-import org.stagemonitor.configuration.ConfigurationOptionProvider;
 
 import javax.annotation.Nullable;
 import java.util.Collections;
@@ -326,11 +325,11 @@ protected boolean hasServiceName() {
 
     @Nullable
     @Override
-    public ServiceInfo getServiceInfoForClassLoader(@Nullable ClassLoader initiatingClassLoader) {
-        if (initiatingClassLoader == null) {
+    public ServiceInfo getServiceInfoForClassLoader(@Nullable ClassLoader classLoader) {
+        if (classLoader == null) {
             return null;
         }
-        return serviceInfoByClassLoader.get(initiatingClassLoader);
+        return serviceInfoByClassLoader.get(classLoader);
     }
 
     @Override
@@ -441,11 +440,68 @@ public TracerState getState() {
     }
 
     @Override
-    public <T extends ConfigurationOptionProvider> T getConfig(Class<T> configProvider) {
+    public <T> T getConfig(Class<T> configProvider) {
         try {
             return configProvider.getConstructor().newInstance();
         } catch (Exception e) {
             throw new IllegalStateException("Failed to create empty configuration for " + configProvider.getName(), e);
         }
     }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, final co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return startChildTransaction(headerCarrier, new TextHeaderGetterBridge<>(textHeadersGetter), initiatingClassLoader);
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader, long epochMicros) {
+        return startChildTransaction(headerCarrier, new TextHeaderGetterBridge<C>(textHeadersGetter), initiatingClassLoader, epochMicros);
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.BinaryHeaderGetter<C> binaryHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return startChildTransaction(headerCarrier, new BinaryHeaderGetterBridge<C>(binaryHeadersGetter), initiatingClassLoader);
+    }
+
+    @Nullable
+    @Override
+    public String captureAndReportException(long epochMicros, @Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent) {
+        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);
+    }
+
+    @Override
+    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()
+            ? ServiceInfo.ofMultiServiceContainer(serviceInfo.getServiceName())
+            : ServiceInfo.of(serviceInfo.getServiceName(), serviceInfo.getServiceVersion()));
+    }
+
+    @Override
+    public ServiceInfo autoDetectedServiceName() {
+        return ServiceInfo.autoDetected();
+    }
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/ElasticApmTracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/ElasticApmTracer.java
@@ -207,8 +207,13 @@ public ConfigurationRegistry getConfigurationRegistry() {
     }
 
     @Override
-    public <T extends ConfigurationOptionProvider> T getConfig(Class<T> configProvider) {
-        return configurationRegistry.getConfig(configProvider);
+    @SuppressWarnings({"unchecked", "rawtypes"})
+    public <T> T getConfig(Class<T> configProvider) {
+        if (ConfigurationOptionProvider.class.isAssignableFrom(configProvider)) {
+            return (T) configurationRegistry.getConfig((Class) configProvider);
+        } else {
+            throw new IllegalArgumentException("Configuration types must subclass " + ConfigurationOptionProvider.class.getName());
+        }
     }
 
     @Override

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
@@ -29,7 +29,6 @@
 import co.elastic.apm.agent.objectpool.ObjectPoolFactory;
 import co.elastic.apm.agent.util.PrivilegedActionUtils;
 import co.elastic.apm.agent.util.VersionUtils;
-import org.stagemonitor.configuration.ConfigurationOptionProvider;
 
 import javax.annotation.Nullable;
 import java.io.File;
@@ -125,6 +124,7 @@ public static synchronized void init(Tracer tracer) {
         if (!isNoop()) {
             throw new IllegalStateException("Tracer is already initialized");
         }
+        co.elastic.apm.plugin.spi.GlobalTracer.init(tracer);
         INSTANCE.tracer = tracer;
     }
 
@@ -264,7 +264,7 @@ public void endError(ErrorCapture errorCapture) {
     }
 
     @Override
-    public <T extends ConfigurationOptionProvider> T getConfig(Class<T> configuration) {
+    public <T> T getConfig(Class<T> configuration) {
         return tracer.getConfig(configuration);
     }
 
@@ -277,4 +277,59 @@ public ObjectPoolFactory getObjectPoolFactory() {
     public void recycle(ErrorCapture errorCapture) {
         tracer.recycle(errorCapture);
     }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return tracer.startChildTransaction(headerCarrier, textHeadersGetter, initiatingClassLoader);
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader, long epochMicros) {
+        return tracer.startChildTransaction(headerCarrier, textHeadersGetter, initiatingClassLoader, epochMicros);
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.BinaryHeaderGetter<C> binaryHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return tracer.startChildTransaction(headerCarrier, binaryHeadersGetter, initiatingClassLoader);
+    }
+
+    @Nullable
+    @Override
+    public String captureAndReportException(long epochMicros, @Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent) {
+        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);
+    }
+
+    @Override
+    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);
+    }
+
+    @Override
+    public ServiceInfo autoDetectedServiceName() {
+        return tracer.autoDetectedServiceName();
+    }
 }
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
@@ -27,7 +27,6 @@
 import co.elastic.apm.agent.impl.transaction.TextHeaderGetter;
 import co.elastic.apm.agent.impl.transaction.Transaction;
 import co.elastic.apm.agent.objectpool.ObjectPoolFactory;
-import org.stagemonitor.configuration.ConfigurationOptionProvider;
 
 import javax.annotation.Nullable;
 
@@ -173,12 +172,63 @@ public void endTransaction(Transaction transaction) { }
     public void endError(ErrorCapture errorCapture) { }
 
     @Override
-    public <T extends ConfigurationOptionProvider> T getConfig(Class<T> configuration) {
+    public <T> T getConfig(Class<T> configuration) {
         return null;
     }
 
     @Override
     public ObjectPoolFactory getObjectPoolFactory() {
         return null;
     }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return null;
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.TextHeaderGetter<C> textHeadersGetter, @Nullable ClassLoader initiatingClassLoader, long epochMicros) {
+        return null;
+    }
+
+    @Nullable
+    @Override
+    public <C> co.elastic.apm.plugin.spi.Transaction<?> startChildTransaction(@Nullable C headerCarrier, co.elastic.apm.plugin.spi.BinaryHeaderGetter<C> binaryHeadersGetter, @Nullable ClassLoader initiatingClassLoader) {
+        return null;
+    }
+
+    @Nullable
+    @Override
+    public String captureAndReportException(long epochMicros, @Nullable Throwable e, @Nullable co.elastic.apm.plugin.spi.AbstractSpan<?> parent) {
+        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;
+    }
+
+    @Override
+    public void endSpan(co.elastic.apm.plugin.spi.Span<?> span) {
+    }
+
+    @Override
+    public void endTransaction(co.elastic.apm.plugin.spi.Transaction<?> transaction) {
+    }
+
+    @Override
+    public void endError(co.elastic.apm.plugin.spi.ErrorCapture errorCapture) {
+    }
+
+    @Override
+    public void setServiceInfoForClassLoader(ClassLoader classLoader, co.elastic.apm.plugin.spi.ServiceInfo serviceInfo) {
+    }
+
+    @Override
+    public ServiceInfo autoDetectedServiceName() {
+        return null;
+    }
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/Scope.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/Scope.java
@@ -41,7 +41,7 @@
  * {@link co.elastic.apm.agent.impl.transaction.AbstractSpan}.
  * </p>
  */
-public interface Scope extends AutoCloseable {
+public interface Scope extends AutoCloseable, co.elastic.apm.plugin.spi.Scope {
 
     @Override
     void close();

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/Tracer.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/Tracer.java
@@ -28,11 +28,10 @@
 import co.elastic.apm.agent.impl.transaction.TextHeaderGetter;
 import co.elastic.apm.agent.impl.transaction.Transaction;
 import co.elastic.apm.agent.objectpool.ObjectPoolFactory;
-import org.stagemonitor.configuration.ConfigurationOptionProvider;
 
 import javax.annotation.Nullable;
 
-public interface Tracer {
+public interface Tracer extends co.elastic.apm.plugin.spi.Tracer {
 
     /**
      * Starts a trace-root transaction
@@ -191,10 +190,12 @@ <C> Transaction startChildTransaction(@Nullable C headerCarrier, BinaryHeaderGet
 
     void endError(ErrorCapture errorCapture);
 
-    <T extends ConfigurationOptionProvider> T getConfig(Class<T> configuration);
+    <T> T getConfig(Class<T> configuration);
 
     ObjectPoolFactory getObjectPoolFactory();
 
+    ServiceInfo autoDetectedServiceName();
+
     /**
      * An enumeration used to represent the current tracer state.
      */

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/AbstractContext.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/AbstractContext.java
@@ -25,7 +25,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-public abstract class AbstractContext implements Recyclable {
+public abstract class AbstractContext implements Recyclable, co.elastic.apm.plugin.spi.AbstractContext {
 
     public static final String REDACTED_CONTEXT_STRING = "[REDACTED]";
 

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/CloudOrigin.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/CloudOrigin.java
@@ -28,7 +28,7 @@
  * If a request originated from a cloud component that provides information about the cloud origin,
  * the cloud origin interface can be used to collect this information.
  */
-public class CloudOrigin implements Recyclable {
+public class CloudOrigin implements Recyclable, co.elastic.apm.plugin.spi.CloudOrigin {
 
     @Nullable
     protected String accountId;

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Db.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Db.java
@@ -34,7 +34,7 @@
 /**
  * An object containing contextual data for database spans
  */
-public class Db implements Recyclable {
+public class Db implements Recyclable, co.elastic.apm.plugin.spi.Db {
 
     private static final ObjectPool<CharBuffer> charBufferPool = QueueBasedObjectPool.of(new MpmcAtomicArrayQueue<CharBuffer>(128), false,
         new Allocator<CharBuffer>() {