buffer errors

Author: zeitlinger

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

@@ -11,6 +11,7 @@
 import io.opentelemetry.javaagent.bootstrap.AgentStarter;
 import io.opentelemetry.javaagent.extension.instrumentation.internal.AsmApi;
 import io.opentelemetry.javaagent.tooling.config.EarlyInitAgentConfig;
+import io.opentelemetry.javaagent.tooling.config.ErrorBuffer;
 import java.io.File;
 import java.lang.instrument.ClassFileTransformer;
 import java.lang.instrument.Instrumentation;
@@ -96,7 +97,7 @@ public void start() {
     Throwable startupError = null;
     try {
       loggingCustomizer.init(earlyConfig);
-      earlyConfig.logEarlyConfigErrorsIfAny();
+      ErrorBuffer.logErrorIfAny();
 
       AgentInstaller.installBytebuddyAgent(instrumentation, extensionClassLoader, earlyConfig);
       WeakConcurrentMapCleaner.start();

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.tooling.config;
+
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import javax.annotation.Nullable;
+
+public final class BrokenEarlyInitAgentConfig implements EarlyInitAgentConfig {
+
+  BrokenEarlyInitAgentConfig() {}
+
+  @Override
+  public boolean isAgentEnabled() {
+    return false;
+  }
+
+  @Nullable
+  @Override
+  public String getString(String propertyName) {
+    return null;
+  }
+
+  @Override
+  public boolean getBoolean(String propertyName, boolean defaultValue) {
+    return defaultValue;
+  }
+
+  @Override
+  public int getInt(String propertyName, int defaultValue) {
+    return defaultValue;
+  }
+
+  @Override
+  public AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(ClassLoader extensionClassLoader) {
+    throw new IllegalStateException("agent is not enabled, cannot install OpenTelemetry SDK");
+  }
+}

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

@@ -5,8 +5,8 @@
 
 package io.opentelemetry.javaagent.tooling.config;
 
+import static io.opentelemetry.javaagent.tooling.config.ErrorBuffer.setErrorMessage;
 import static java.util.Collections.emptyMap;
-import static java.util.logging.Level.SEVERE;
 
 import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
 import java.io.File;
@@ -17,7 +17,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.Properties;
-import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
@@ -59,7 +58,7 @@ static Map<String, String> loadConfigFile() {
     // Configuration properties file is optional
     File configurationFile = new File(configurationFilePath);
     if (!configurationFile.exists()) {
-      fileLoadErrorMessage = "Configuration file \"" + configurationFilePath + "\" not found.";
+      setErrorMessage("Configuration file \"" + configurationFilePath + "\" not found.");
       return emptyMap();
     }
 
@@ -68,24 +67,17 @@ static Map<String, String> loadConfigFile() {
         new InputStreamReader(new FileInputStream(configurationFile), StandardCharsets.UTF_8)) {
       properties.load(reader);
     } catch (FileNotFoundException fnf) {
-      fileLoadErrorMessage = "Configuration file \"" + configurationFilePath + "\" not found.";
+      setErrorMessage("Configuration file \"" + configurationFilePath + "\" not found.");
     } catch (IOException ioe) {
-      fileLoadErrorMessage =
+      setErrorMessage(
           "Configuration file \""
               + configurationFilePath
-              + "\" cannot be accessed or correctly parsed.";
+              + "\" cannot be accessed or correctly parsed.");
     }
 
     return properties.entrySet().stream()
         .collect(Collectors.toMap(e -> e.getKey().toString(), e -> e.getValue().toString()));
   }
 
-  static void logErrorIfAny() {
-    if (fileLoadErrorMessage != null) {
-      Logger.getLogger(ConfigurationPropertiesSupplier.class.getName())
-          .log(SEVERE, fileLoadErrorMessage);
-    }
-  }
-
   private ConfigurationFile() {}
 }

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

@@ -6,7 +6,6 @@
 package io.opentelemetry.javaagent.tooling.config;
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.api.incubator.config.GlobalConfigProvider;
 import io.opentelemetry.javaagent.bootstrap.OpenTelemetrySdkAccess;
 import io.opentelemetry.javaagent.extension.DeclarativeConfigPropertiesBridge;
@@ -26,6 +25,7 @@
 import java.util.Arrays;
 import java.util.Objects;
 import javax.annotation.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Agent config class that is only supposed to be used before the SDK (and {@link
@@ -36,14 +36,25 @@ public final class DeclarativeConfigEarlyInitAgentConfig implements EarlyInitAge
   private final ConfigProperties declarativeConfigProperties;
   private final SdkConfigProvider configProvider;
 
-  DeclarativeConfigEarlyInitAgentConfig(String configurationFile) {
-    this.configurationModel = loadConfigurationModel(configurationFile);
+  DeclarativeConfigEarlyInitAgentConfig(OpenTelemetryConfigurationModel model) {
+    this.configurationModel = model;
     configProvider = SdkConfigProvider.create(configurationModel);
     this.declarativeConfigProperties =
         new DeclarativeConfigPropertiesBridge(
             configProvider, this.configurationModel.getLogLevel());
   }
 
+  @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);
@@ -65,14 +76,14 @@ public int getInt(String propertyName, int defaultValue) {
     return declarativeConfigProperties.getInt(propertyName, defaultValue);
   }
 
-  @Override
-  public void logEarlyConfigErrorsIfAny() {}
-
+  @Nullable
   private static OpenTelemetryConfigurationModel loadConfigurationModel(String configurationFile) {
     try (FileInputStream fis = new FileInputStream(configurationFile)) {
       return DeclarativeConfiguration.parse(fis);
     } catch (IOException e) {
-      throw new DeclarativeConfigException("unable to read " + configurationFile, e);
+      ErrorBuffer.setErrorMessage(
+          "Error reading configuration file: " + configurationFile + ". " + e.getMessage());
+      return null;
     }
   }
 

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

@@ -21,8 +21,6 @@ public interface EarlyInitAgentConfig {
 
   int getInt(String propertyName, int defaultValue);
 
-  void logEarlyConfigErrorsIfAny();
-
   /**
    * Install the {@link OpenTelemetrySdk} using autoconfigure, and return the {@link
    * AutoConfiguredOpenTelemetrySdk}.
@@ -37,7 +35,7 @@ static EarlyInitAgentConfig create() {
             .getString("otel.experimental.config.file");
 
     return configurationFile != null
-        ? new DeclarativeConfigEarlyInitAgentConfig(configurationFile)
+        ? DeclarativeConfigEarlyInitAgentConfig.create(configurationFile)
         : new LegacyConfigFileEarlyInitAgentConfig();
   }
 }

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.tooling.config;
+
+import static java.util.logging.Level.SEVERE;
+
+import java.util.logging.Logger;
+import javax.annotation.Nullable;
+
+/**
+ * This class is used to buffer error messages that occur during early initialization of the agent.
+ * It allows for logging these errors later, once the logging subsystem is fully initialized.
+ */
+public final class ErrorBuffer {
+
+  // this class is used early, and must not use logging in most of its methods
+  // in case any file loading/parsing error occurs, we save the error message and log it later, when
+  // the logging subsystem is initialized
+  @Nullable private static String errorMessage;
+
+  static void setErrorMessage(String errorMessage) {
+    if (ErrorBuffer.errorMessage == null) {
+      ErrorBuffer.errorMessage = errorMessage;
+    } else {
+      ErrorBuffer.errorMessage += "\n" + errorMessage;
+    }
+  }
+
+  public static void logErrorIfAny() {
+    if (errorMessage != null) {
+      Logger.getLogger(ConfigurationPropertiesSupplier.class.getName()).log(SEVERE, errorMessage);
+    }
+  }
+}

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

@@ -60,11 +60,6 @@ public int getInt(String propertyName, int defaultValue) {
     }
   }
 
-  @Override
-  public void logEarlyConfigErrorsIfAny() {
-    ConfigurationFile.logErrorIfAny();
-  }
-
   @Override
   public AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(ClassLoader extensionClassLoader) {
     AutoConfiguredOpenTelemetrySdk autoConfiguredSdk =