elastic#3030: Introduce configuration API within SPI package that act…

…s as a binary compatible mirror of the current configuration.
raphw · Feb 22, 2023 · 73ee8a8 · 73ee8a8
1 parent e89545a
commit 73ee8a8
Show file tree

Hide file tree

Showing 89 changed files with 1,321 additions and 204 deletions.
diff --git a/apm-agent-common/src/main/java/co/elastic/apm/agent/common/util/WildcardMatcher.java b/apm-agent-common/src/main/java/co/elastic/apm/agent/common/util/WildcardMatcher.java
@@ -83,7 +83,7 @@ public static WildcardMatcher matchAll() {
         return MATCH_ALL;
     }
 
-    public static List<WildcardMatcher> matchAllList() {
+    public static List<? extends WildcardMatcher> matchAllList() {
         return MATCH_ALL_LIST;
     }
 
@@ -138,7 +138,7 @@ public static WildcardMatcher valueOf(final String wildcardString) {
      * @param s        the string to match against
      * @return {@code true}, if any of the matchers match the provided string
      */
-    public static boolean isAnyMatch(List<WildcardMatcher> matchers, @Nullable CharSequence s) {
+    public static boolean isAnyMatch(List<? extends WildcardMatcher> matchers, @Nullable CharSequence s) {
         return anyMatch(matchers, s) != null;
     }
 
@@ -149,7 +149,7 @@ public static boolean isAnyMatch(List<WildcardMatcher> matchers, @Nullable CharS
      * @param s        the string to match against
      * @return {@code true}, if none of the matchers match the provided string
      */
-    public static boolean isNoneMatch(List<WildcardMatcher> matchers, @Nullable CharSequence s) {
+    public static boolean isNoneMatch(List<? extends WildcardMatcher> matchers, @Nullable CharSequence s) {
         return !isAnyMatch(matchers, s);
     }
 
@@ -161,7 +161,7 @@ public static boolean isNoneMatch(List<WildcardMatcher> matchers, @Nullable Char
      * @return the first matching {@link WildcardMatcher}, or {@code null} if none match.
      */
     @Nullable
-    public static WildcardMatcher anyMatch(List<WildcardMatcher> matchers, @Nullable CharSequence s) {
+    public static WildcardMatcher anyMatch(List<? extends WildcardMatcher> matchers, @Nullable CharSequence s) {
         if (s == null || matchers.isEmpty()) {
             return null;
         }
@@ -178,7 +178,7 @@ public static WildcardMatcher anyMatch(List<WildcardMatcher> matchers, @Nullable
      * @see #matches(CharSequence, CharSequence)
      */
     @Nullable
-    public static WildcardMatcher anyMatch(List<WildcardMatcher> matchers, CharSequence firstPart, @Nullable CharSequence secondPart) {
+    public static WildcardMatcher anyMatch(List<? extends WildcardMatcher> matchers, CharSequence firstPart, @Nullable CharSequence secondPart) {
         for (int i = 0; i < matchers.size(); i++) {
             if (matchers.get(i).matches(firstPart, secondPart)) {
                 return matchers.get(i);

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/bci/bytebuddy/CustomElementMatchers.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/bci/bytebuddy/CustomElementMatchers.java
@@ -293,7 +293,7 @@ public String toString() {
         };
     }
 
-    public static ElementMatcher.Junction<NamedElement> anyMatch(final List<WildcardMatcher> matchers) {
+    public static ElementMatcher.Junction<NamedElement> anyMatch(final List<? extends WildcardMatcher> matchers) {
         return new ElementMatcher.Junction.AbstractBase<NamedElement>() {
             @Override
             public boolean matches(NamedElement target) {

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/CoreConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/CoreConfiguration.java
@@ -19,15 +19,11 @@
 package co.elastic.apm.agent.configuration;
 
 import co.elastic.apm.agent.bci.ElasticApmAgent;
-import co.elastic.apm.agent.configuration.converter.ListValueConverter;
-import co.elastic.apm.agent.configuration.converter.RoundedDoubleConverter;
-import co.elastic.apm.agent.configuration.converter.TimeDuration;
-import co.elastic.apm.agent.configuration.converter.TimeDurationValueConverter;
+import co.elastic.apm.agent.configuration.converter.*;
 import co.elastic.apm.agent.configuration.validation.RegexValidator;
 import co.elastic.apm.agent.impl.transaction.Span;
 import co.elastic.apm.agent.matcher.MethodMatcher;
 import co.elastic.apm.agent.matcher.MethodMatcherValueConverter;
-import co.elastic.apm.agent.common.util.WildcardMatcher;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import co.elastic.apm.agent.sdk.logging.Logger;
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;
@@ -59,7 +55,7 @@
 import static co.elastic.apm.agent.configuration.validation.RangeValidator.isInRange;
 import static co.elastic.apm.agent.logging.LoggingConfiguration.AGENT_HOME_PLACEHOLDER;
 
-public class CoreConfiguration extends ConfigurationOptionProvider {
+public class CoreConfiguration extends ConfigurationOptionProvider implements co.elastic.apm.plugin.spi.CoreConfiguration {
 
     private final Logger logger = LoggerFactory.getLogger(getClass());
 
@@ -1077,6 +1073,11 @@ public TraceContinuationStrategy getTraceContinuationStrategy() {
         return traceContinuationStrategy.get();
     }
 
+    @Override
+    public boolean isCaptureBody() {
+        return getCaptureBody() != EventType.OFF;
+    }
+
     public enum EventType {
         /**
          * Request bodies will never be reported

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/MessagingConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/MessagingConfiguration.java
@@ -18,7 +18,7 @@
  */
 package co.elastic.apm.agent.configuration;
 
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.agent.configuration.converter.WildcardMatcher;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import org.stagemonitor.configuration.ConfigurationOption;
 import org.stagemonitor.configuration.ConfigurationOptionProvider;
@@ -28,7 +28,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class MessagingConfiguration extends ConfigurationOptionProvider {
+public class MessagingConfiguration extends ConfigurationOptionProvider implements co.elastic.apm.plugin.spi.MessagingConfiguration {
     private static final String MESSAGING_CATEGORY = "Messaging";
     private static final String MESSAGE_POLLING_TRANSACTION_STRATEGY = "message_polling_transaction_strategy";
     private static final String MESSAGE_BATCH_STRATEGY = "message_batch_strategy";
@@ -130,6 +130,21 @@ public Collection<String> getJmsListenerPackages() {
         return jmsListenerPackages.get();
     }
 
+    @Override
+    public boolean isMessageTransactionPolling() {
+        return getMessagePollingTransactionStrategy() != JmsStrategy.HANDLING;
+    }
+
+    @Override
+    public boolean isMessageTransactionHandling() {
+        return getMessagePollingTransactionStrategy() != JmsStrategy.POLLING;
+    }
+
+    @Override
+    public boolean isMessageBatchHandling() {
+        return getMessageBatchStrategy() == BatchStrategy.BATCH_HANDLING;
+    }
+
     public enum JmsStrategy {
         /**
          * Create a transaction capturing JMS {@code receive} invocations

diff --git a/...gent-core/src/main/java/co/elastic/apm/agent/configuration/converter/WildcardMatcher.java b/...gent-core/src/main/java/co/elastic/apm/agent/configuration/converter/WildcardMatcher.java
@@ -0,0 +1,48 @@
+package co.elastic.apm.agent.configuration.converter;
+
+import javax.annotation.Nullable;
+import java.util.Collections;
+import java.util.List;
+
+public class WildcardMatcher extends co.elastic.apm.agent.common.util.WildcardMatcher implements co.elastic.apm.plugin.spi.WildcardMatcher {
+
+    private static final WildcardMatcher MATCH_ALL = new WildcardMatcher(co.elastic.apm.agent.common.util.WildcardMatcher.matchAll());
+    private static final List<WildcardMatcher> MATCH_ALL_LIST = Collections.singletonList(MATCH_ALL);
+
+    private final co.elastic.apm.agent.common.util.WildcardMatcher matcher;
+
+    public WildcardMatcher(co.elastic.apm.agent.common.util.WildcardMatcher matcher) {
+        this.matcher = matcher;
+    }
+
+    public static WildcardMatcher valueOf(String wildcardString) {
+        return new WildcardMatcher(co.elastic.apm.agent.common.util.WildcardMatcher.valueOf(wildcardString));
+    }
+
+    public static WildcardMatcher caseSensitiveMatcher(String matcher) {
+        return new WildcardMatcher(co.elastic.apm.agent.common.util.WildcardMatcher.caseSensitiveMatcher(matcher));
+    }
+
+    public static WildcardMatcher matchAll() {
+        return MATCH_ALL;
+    }
+
+    public static List<WildcardMatcher> matchAllList() {
+        return MATCH_ALL_LIST;
+    }
+
+    @Override
+    public boolean matches(CharSequence s) {
+        return matcher.matches(s);
+    }
+
+    @Override
+    public boolean matches(CharSequence firstPart, @Nullable CharSequence secondPart) {
+        return matcher.matches(firstPart, secondPart);
+    }
+
+    @Override
+    public String getMatcher() {
+        return matcher.getMatcher();
+    }
+}
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
@@ -21,13 +21,21 @@
 import co.elastic.apm.agent.configuration.ServiceInfo;
 import co.elastic.apm.agent.impl.error.ErrorCapture;
 import co.elastic.apm.agent.impl.sampling.Sampler;
+import co.elastic.apm.agent.impl.transaction.AbstractSpan;
+import co.elastic.apm.agent.impl.transaction.BinaryHeaderGetter;
+import co.elastic.apm.agent.impl.transaction.ElasticContext;
+import co.elastic.apm.agent.impl.transaction.Span;
+import co.elastic.apm.agent.impl.transaction.TextHeaderGetter;
+import co.elastic.apm.agent.impl.transaction.TraceContext;
+import co.elastic.apm.agent.impl.transaction.Transaction;
 import co.elastic.apm.agent.impl.transaction.*;
 import co.elastic.apm.agent.objectpool.ObjectPool;
 import co.elastic.apm.agent.objectpool.ObjectPoolFactory;
 import co.elastic.apm.agent.sdk.logging.Logger;
 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 co.elastic.apm.plugin.spi.*;
 
 import javax.annotation.Nullable;
 import java.util.Collections;
@@ -440,11 +448,18 @@ public TracerState getState() {
     }
 
     @Override
+    @SuppressWarnings("unchecked")
     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);
+        if (configProvider == CoreConfiguration.class) {
+            return (T) EmptyCoreConfiguration.INSTANCE;
+        } else if (configProvider == StacktraceConfiguration.class) {
+            return (T) EmptyStacktraceConfiguration.INSTANCE;
+        } else if (configProvider == MessagingConfiguration.class) {
+            return (T) EmptyMessagingConfiguration.INSTANCE;
+        } else if (configProvider == WebConfiguration.class) {
+            return (T) EmptyWebConfiguration.INSTANCE;
+        } else {
+            throw new IllegalArgumentException("Unknown configuration: " + configProvider.getName());
         }
     }
 

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
@@ -21,10 +21,12 @@
 import co.elastic.apm.agent.common.JvmRuntimeInfo;
 import co.elastic.apm.agent.common.util.WildcardMatcher;
 import co.elastic.apm.agent.configuration.CoreConfiguration;
+import co.elastic.apm.agent.configuration.MessagingConfiguration;
 import co.elastic.apm.agent.configuration.ServiceInfo;
 import co.elastic.apm.agent.configuration.SpanConfiguration;
 import co.elastic.apm.agent.context.ClosableLifecycleListenerAdapter;
 import co.elastic.apm.agent.context.LifecycleListener;
+import co.elastic.apm.agent.impl.context.web.WebConfiguration;
 import co.elastic.apm.agent.impl.error.ErrorCapture;
 import co.elastic.apm.agent.impl.metadata.MetaDataFuture;
 import co.elastic.apm.agent.impl.sampling.ProbabilitySampler;
@@ -42,8 +44,6 @@
 import co.elastic.apm.agent.report.ReporterConfiguration;
 import co.elastic.apm.agent.sdk.logging.Logger;
 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 co.elastic.apm.agent.util.DependencyInjectingServiceLoader;
 import co.elastic.apm.agent.util.ExecutorUtils;
 import org.stagemonitor.configuration.ConfigurationOption;
@@ -207,13 +207,24 @@ public ConfigurationRegistry getConfigurationRegistry() {
     }
 
     @Override
-    @SuppressWarnings({"unchecked", "rawtypes"})
+    @SuppressWarnings("unchecked")
     public <T> T getConfig(Class<T> configProvider) {
-        if (ConfigurationOptionProvider.class.isAssignableFrom(configProvider)) {
-            return (T) configurationRegistry.getConfig((Class) configProvider);
+        Class<? extends ConfigurationOptionProvider> actualConfigProvider;
+        if (configProvider == co.elastic.apm.plugin.spi.CoreConfiguration.class) {
+            actualConfigProvider = CoreConfiguration.class;
+        } else if (configProvider == co.elastic.apm.plugin.spi.StacktraceConfiguration.class) {
+            actualConfigProvider = StacktraceConfiguration.class;
+        } else if (configProvider == co.elastic.apm.plugin.spi.MessagingConfiguration.class) {
+            actualConfigProvider = MessagingConfiguration.class;
+        } else if (configProvider == co.elastic.apm.plugin.spi.WebConfiguration.class) {
+            actualConfigProvider = WebConfiguration.class;
+        } else if (ConfigurationOptionProvider.class.isAssignableFrom(configProvider)) {
+            actualConfigProvider = (Class<? extends ConfigurationOptionProvider>) configProvider;
         } else {
-            throw new IllegalArgumentException("Configuration types must subclass " + ConfigurationOptionProvider.class.getName());
+            throw new IllegalArgumentException("Configuration types must subclass " + ConfigurationOptionProvider.class.getName()
+                + " and this does not apply to " + configProvider.getName() + " which was provided");
         }
+        return (T) configurationRegistry.getConfig(actualConfigProvider);
     }
 
     @Override

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Request.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Request.java
@@ -344,10 +344,10 @@ public void copyFrom(Request other) {
 
     public boolean hasContent() {
         return method != null ||
-            headers.size() > 0 ||
+            !headers.isEmpty() ||
             httpVersion != null ||
-            cookies.size() > 0 ||
-            postParams.size() > 0 ||
+            !cookies.isEmpty() ||
+            !postParams.isEmpty() ||
             socket.hasContent() ||
             url.hasContent();
     }

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Response.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/Response.java
@@ -124,6 +124,6 @@ public void copyFrom(Response other) {
     }
 
     public boolean hasContent() {
-        return statusCode > 0 || headers.size() > 0;
+        return statusCode > 0 || !headers.isEmpty();
     }
 }
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/web/WebConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/web/WebConfiguration.java
@@ -18,7 +18,7 @@
  */
 package co.elastic.apm.agent.impl.context.web;
 
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.agent.configuration.converter.WildcardMatcher;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import org.stagemonitor.configuration.ConfigurationOption;
 import org.stagemonitor.configuration.ConfigurationOptionProvider;
@@ -28,7 +28,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class WebConfiguration extends ConfigurationOptionProvider {
+public class WebConfiguration extends ConfigurationOptionProvider implements co.elastic.apm.plugin.spi.WebConfiguration {
 
     private static final String HTTP_CATEGORY = "HTTP";
 

diff --git a/...gent-core/src/main/java/co/elastic/apm/agent/impl/stacktrace/StacktraceConfiguration.java b/...gent-core/src/main/java/co/elastic/apm/agent/impl/stacktrace/StacktraceConfiguration.java
@@ -26,7 +26,7 @@
 import java.util.Collection;
 import java.util.Collections;
 
-public class StacktraceConfiguration extends ConfigurationOptionProvider {
+public class StacktraceConfiguration extends ConfigurationOptionProvider implements co.elastic.apm.plugin.spi.StacktraceConfiguration {
 
     private static final String STACKTRACE_CATEGORY = "Stacktrace";
     public static final String APPLICATION_PACKAGES = "application_packages";

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/logging/LoggingConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/logging/LoggingConfiguration.java
@@ -21,7 +21,7 @@
 import co.elastic.apm.agent.common.util.SystemStandardOutputLogger;
 import co.elastic.apm.agent.configuration.converter.ByteValue;
 import co.elastic.apm.agent.configuration.converter.ByteValueConverter;
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.agent.configuration.converter.WildcardMatcher;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;
 import org.apache.logging.log4j.Level;

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/matcher/WildcardMatcherValueConverter.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/matcher/WildcardMatcherValueConverter.java
@@ -18,7 +18,7 @@
  */
 package co.elastic.apm.agent.matcher;
 
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.agent.configuration.converter.WildcardMatcher;
 import org.stagemonitor.configuration.converter.ValueConverter;
 
 /**

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/report/ReporterConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/report/ReporterConfiguration.java
@@ -18,11 +18,7 @@
  */
 package co.elastic.apm.agent.report;
 
-import co.elastic.apm.agent.configuration.converter.ByteValue;
-import co.elastic.apm.agent.configuration.converter.ByteValueConverter;
-import co.elastic.apm.agent.configuration.converter.TimeDuration;
-import co.elastic.apm.agent.configuration.converter.TimeDurationValueConverter;
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.agent.configuration.converter.*;
 import co.elastic.apm.agent.matcher.WildcardMatcherValueConverter;
 import co.elastic.apm.agent.sdk.logging.LoggerFactory;
 import org.stagemonitor.configuration.ConfigurationOption;

diff --git a/...gent-core/src/main/java/co/elastic/apm/agent/tracemethods/TraceMethodInstrumentation.java b/...gent-core/src/main/java/co/elastic/apm/agent/tracemethods/TraceMethodInstrumentation.java
@@ -74,7 +74,7 @@ public ElementMatcher<? super TypeDescription> getTypeMatcher() {
     public ElementMatcher<? super MethodDescription> getMethodMatcher() {
         ElementMatcher.Junction<? super MethodDescription> matcher = matches(methodMatcher.getMethodMatcher());
 
-        final List<WildcardMatcher> methodsExcludedFromInstrumentation = config.getMethodsExcludedFromInstrumentation();
+        final List<? extends WildcardMatcher> methodsExcludedFromInstrumentation = config.getMethodsExcludedFromInstrumentation();
         if (!methodsExcludedFromInstrumentation.isEmpty()) {
             matcher = matcher.and(not(new ElementMatcher<MethodDescription>() {
                 @Override

diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/util/TransactionNameUtils.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/util/TransactionNameUtils.java
@@ -18,7 +18,8 @@
  */
 package co.elastic.apm.agent.util;
 
-import co.elastic.apm.agent.common.util.WildcardMatcher;
+import co.elastic.apm.plugin.spi.WildcardMatcher;
+import co.elastic.apm.plugin.spi.WildcardMatcherUtil;
 
 import javax.annotation.Nullable;
 import java.util.List;
@@ -75,15 +76,15 @@ public static void setNameFromClassAndMethod(String className, @Nullable String
 
     }
 
-    public static void setNameFromHttpRequestPath(String method, String path, @Nullable StringBuilder transactionName, List<WildcardMatcher> urlGroups) {
+    public static void setNameFromHttpRequestPath(String method, String path, @Nullable StringBuilder transactionName, List<? extends WildcardMatcher> urlGroups) {
         setNameFromHttpRequestPath(method, path, null, transactionName, urlGroups);
     }
 
-    public static void setNameFromHttpRequestPath(String method, String pathFirstPart, @Nullable String pathSecondPart, @Nullable StringBuilder transactionName, List<WildcardMatcher> urlGroups) {
+    public static void setNameFromHttpRequestPath(String method, String pathFirstPart, @Nullable String pathSecondPart, @Nullable StringBuilder transactionName, List<? extends WildcardMatcher> urlGroups) {
         if (transactionName == null) {
             return;
         }
-        WildcardMatcher groupMatcher = WildcardMatcher.anyMatch(urlGroups, pathFirstPart, pathSecondPart);
+        WildcardMatcher groupMatcher = WildcardMatcherUtil.anyMatch(urlGroups, pathFirstPart, pathSecondPart);
         if (groupMatcher != null) {
             transactionName.append(method).append(' ').append(groupMatcher);
         } else {