revert to using system props for early init with declarative config to avoid classloading issues

Author: zeitlinger

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/DeclarativeConfigPropertiesBridge.java

@@ -91,8 +91,6 @@ public final class DeclarativeConfigPropertiesBridge implements ConfigProperties
         "http.server.response_captured_headers");
   }
 
-  private final String logLevel;
-
   private static Map<String, String> getPeerServiceMapping(
       DeclarativeConfigPropertiesBridge bridge) {
     List<DeclarativeConfigProperties> configProperties =
@@ -107,8 +105,7 @@ private static Map<String, String> getPeerServiceMapping(
                 e -> Objects.requireNonNull(e.getString("service"), "service must not be null")));
   }
 
-  public DeclarativeConfigPropertiesBridge(ConfigProvider configProvider, String logLevel) {
-    this.logLevel = logLevel;
+  public DeclarativeConfigPropertiesBridge(ConfigProvider configProvider) {
     DeclarativeConfigProperties inst = configProvider.getInstrumentationConfig();
     if (inst == null) {
       inst = DeclarativeConfigProperties.empty();
@@ -130,10 +127,6 @@ public String getString(String propertyName) {
   @Nullable
   @Override
   public Boolean getBoolean(String propertyName) {
-    if ("otel.javaagent.debug".equals(propertyName)) {
-      return "DEBUG".equals(this.logLevel);
-    }
-
     return getPropertyValue(propertyName, DeclarativeConfigProperties::getBoolean);
   }
 

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/DeclarativeConfigPropertiesBridgeTest.java

@@ -38,7 +38,7 @@ void setup() {
             .withAdditionalProperty("instrumentation/development", new InstrumentationModel());
     SdkConfigProvider emptyConfigProvider = SdkConfigProvider.create(emptyModel);
     emptyBridge =
-        new DeclarativeConfigPropertiesBridge(Objects.requireNonNull(emptyConfigProvider), "DEBUG");
+        new DeclarativeConfigPropertiesBridge(Objects.requireNonNull(emptyConfigProvider));
   }
 
   private static DeclarativeConfigPropertiesBridge create(String name) {
@@ -47,7 +47,7 @@ private static DeclarativeConfigPropertiesBridge create(String name) {
             DeclarativeConfigPropertiesBridgeTest.class.getClassLoader().getResourceAsStream(name));
     SdkConfigProvider configProvider = SdkConfigProvider.create(model);
     DeclarativeConfigPropertiesBridge configPropertiesBridge =
-        new DeclarativeConfigPropertiesBridge(Objects.requireNonNull(configProvider), "DEBUG");
+        new DeclarativeConfigPropertiesBridge(Objects.requireNonNull(configProvider));
     return configPropertiesBridge;
   }
 

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/AgentInstaller.java

@@ -78,6 +78,8 @@ public class AgentInstaller {
 
   private static final Logger logger = Logger.getLogger(AgentInstaller.class.getName());
 
+  static final String JAVAAGENT_ENABLED_CONFIG = "otel.javaagent.enabled";
+
   // This property may be set to force synchronous AgentListener#afterAgent() execution: the
   // condition for delaying the AgentListener initialization is pretty broad and in case it covers
   // too much javaagent users can file a bug, force sync execution by setting this property to true
@@ -103,7 +105,7 @@ public static void installBytebuddyAgent(
     }
 
     logVersionInfo();
-    if (earlyConfig.isAgentEnabled()) {
+    if (earlyConfig.getBoolean(JAVAAGENT_ENABLED_CONFIG, true)) {
       setupUnsafe(inst);
       List<AgentListener> agentListeners = loadOrdered(AgentListener.class, extensionClassLoader);
       installBytebuddyAgent(inst, extensionClassLoader, agentListeners, earlyConfig);
@@ -160,6 +162,7 @@ private static void installBytebuddyAgent(
 
     AutoConfiguredOpenTelemetrySdk autoConfiguredSdk =
         earlyConfig.installOpenTelemetrySdk(extensionClassLoader);
+    EarlyInitAgentConfig.setForceFlush(autoConfiguredSdk.getOpenTelemetrySdk());
 
     ConfigProperties sdkConfig = AutoConfigureUtil.getConfig(autoConfiguredSdk);
     AgentInstrumentationConfig.internalInitializeConfig(

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/BrokenEarlyInitAgentConfig.java

@@ -7,22 +7,18 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.incubator.config.GlobalConfigProvider;
-import io.opentelemetry.javaagent.bootstrap.OpenTelemetrySdkAccess;
+import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
 import io.opentelemetry.javaagent.extension.DeclarativeConfigPropertiesBridge;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.SdkAutoconfigureAccess;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
-import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.resources.Resource;
 import java.io.FileInputStream;
 import java.io.IOException;
-import java.util.Arrays;
-import java.util.Objects;
 import javax.annotation.Nullable;
 import org.jetbrains.annotations.NotNull;
 
@@ -31,48 +27,31 @@
  * io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties}) is initialized.
  */
 public final class DeclarativeConfigEarlyInitAgentConfig implements EarlyInitAgentConfig {
-  private final OpenTelemetryConfigurationModel configurationModel;
-  private final ConfigProperties declarativeConfigProperties;
-  private final SdkConfigProvider configProvider;
+  private final String configurationFile;
 
-  DeclarativeConfigEarlyInitAgentConfig(OpenTelemetryConfigurationModel model) {
-    this.configurationModel = model;
-    configProvider = SdkConfigProvider.create(configurationModel);
-    this.declarativeConfigProperties =
-        new DeclarativeConfigPropertiesBridge(
-            configProvider, this.configurationModel.getLogLevel());
+  DeclarativeConfigEarlyInitAgentConfig(String configurationFile) {
+    this.configurationFile = configurationFile;
   }
 
   @NotNull
   public static EarlyInitAgentConfig create(String configurationFile) {
-    OpenTelemetryConfigurationModel model = loadConfigurationModel(configurationFile);
-    if (model == null) {
-      // broken configuration file, return a broken config, error is logged later
-      return new BrokenEarlyInitAgentConfig();
-    }
-
-    return new DeclarativeConfigEarlyInitAgentConfig(model);
-  }
-
-  @Override
-  public boolean isAgentEnabled() {
-    return !Objects.equals(configurationModel.getDisabled(), true);
+    return new DeclarativeConfigEarlyInitAgentConfig(configurationFile);
   }
 
   @Nullable
   @Override
   public String getString(String propertyName) {
-    return declarativeConfigProperties.getString(propertyName);
+    return ConfigPropertiesUtil.getString(propertyName);
   }
 
   @Override
   public boolean getBoolean(String propertyName, boolean defaultValue) {
-    return declarativeConfigProperties.getBoolean(propertyName, defaultValue);
+    return ConfigPropertiesUtil.getBoolean(propertyName, defaultValue);
   }
 
   @Override
   public int getInt(String propertyName, int defaultValue) {
-    return declarativeConfigProperties.getInt(propertyName, defaultValue);
+    return ConfigPropertiesUtil.getInt(propertyName, defaultValue);
   }
 
   @Nullable
@@ -88,27 +67,19 @@ private static OpenTelemetryConfigurationModel loadConfigurationModel(String con
 
   @Override
   public AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(ClassLoader extensionClassLoader) {
+    OpenTelemetryConfigurationModel model = loadConfigurationModel(configurationFile);
+    SdkConfigProvider configProvider = SdkConfigProvider.create(model);
+    DeclarativeConfigPropertiesBridge configProperties =
+        new DeclarativeConfigPropertiesBridge(configProvider);
     OpenTelemetrySdk sdk =
         DeclarativeConfiguration.create(
-            this.configurationModel, SpiHelper.serviceComponentLoader(extensionClassLoader));
+            model, SpiHelper.serviceComponentLoader(extensionClassLoader));
     Runtime.getRuntime().addShutdownHook(new Thread(sdk::close));
     GlobalOpenTelemetry.set(sdk);
-    GlobalConfigProvider.set(this.configProvider);
-
-    setForceFlush(sdk);
+    GlobalConfigProvider.set(configProvider);
 
     return SdkAutoconfigureAccess.create(
-        sdk, Resource.getDefault(), this.declarativeConfigProperties, this.configProvider);
+        sdk, Resource.getDefault(), configProperties, configProvider);
   }
 
-  static void setForceFlush(OpenTelemetrySdk sdk) {
-    OpenTelemetrySdkAccess.internalSetForceFlush(
-        (timeout, unit) -> {
-          CompletableResultCode traceResult = sdk.getSdkTracerProvider().forceFlush();
-          CompletableResultCode metricsResult = sdk.getSdkMeterProvider().forceFlush();
-          CompletableResultCode logsResult = sdk.getSdkLoggerProvider().forceFlush();
-          CompletableResultCode.ofAll(Arrays.asList(traceResult, metricsResult, logsResult))
-              .join(timeout, unit);
-        });
-  }
 }

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/DeclarativeConfigEarlyInitAgentConfig.java

@@ -5,14 +5,17 @@
 
 package io.opentelemetry.javaagent.tooling.config;
 
+import static java.util.Arrays.asList;
+
+import io.opentelemetry.javaagent.bootstrap.OpenTelemetrySdkAccess;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.util.Collections;
 import javax.annotation.Nullable;
 
 public interface EarlyInitAgentConfig {
-  boolean isAgentEnabled();
 
   @Nullable
   String getString(String propertyName);
@@ -38,4 +41,15 @@ static EarlyInitAgentConfig create() {
         ? DeclarativeConfigEarlyInitAgentConfig.create(configurationFile)
         : new LegacyConfigFileEarlyInitAgentConfig();
   }
+
+  static void setForceFlush(OpenTelemetrySdk sdk) {
+    OpenTelemetrySdkAccess.internalSetForceFlush(
+        (timeout, unit) -> {
+          CompletableResultCode traceResult = sdk.getSdkTracerProvider().forceFlush();
+          CompletableResultCode metricsResult = sdk.getSdkMeterProvider().forceFlush();
+          CompletableResultCode logsResult = sdk.getSdkLoggerProvider().forceFlush();
+          CompletableResultCode.ofAll(asList(traceResult, metricsResult, logsResult))
+              .join(timeout, unit);
+        });
+  }
 }

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/EarlyInitAgentConfig.java

@@ -6,7 +6,6 @@
 package io.opentelemetry.javaagent.tooling.config;
 
 import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
-import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import java.util.Map;
 import javax.annotation.Nullable;
@@ -25,11 +24,6 @@ public final class LegacyConfigFileEarlyInitAgentConfig implements EarlyInitAgen
     this.configFileContents = ConfigurationFile.getProperties();
   }
 
-  @Override
-  public boolean isAgentEnabled() {
-    return getBoolean(JAVAAGENT_ENABLED_CONFIG, true);
-  }
-
   @Nullable
   @Override
   public String getString(String propertyName) {
@@ -62,13 +56,9 @@ public int getInt(String propertyName, int defaultValue) {
 
   @Override
   public AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(ClassLoader extensionClassLoader) {
-    AutoConfiguredOpenTelemetrySdk autoConfiguredSdk =
-        AutoConfiguredOpenTelemetrySdk.builder()
-            .setResultAsGlobal()
-            .setServiceClassLoader(extensionClassLoader)
-            .build();
-    OpenTelemetrySdk sdk = autoConfiguredSdk.getOpenTelemetrySdk();
-    DeclarativeConfigEarlyInitAgentConfig.setForceFlush(sdk);
-    return autoConfiguredSdk;
+    return AutoConfiguredOpenTelemetrySdk.builder()
+        .setResultAsGlobal()
+        .setServiceClassLoader(extensionClassLoader)
+        .build();
   }
 }