init migration

mhlidd · mhlidd · commit 3ad209bb1845 · 2025-09-25T15:42:49.000-07:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -9,6 +9,7 @@ plugins {
   id("de.thetaphi.forbiddenapis") version "3.8"
 
   id("tracer-version")
+  id("config-inversion-linter")
   id("io.github.gradle-nexus.publish-plugin") version "2.0.0"
 
   id("com.gradleup.shadow") version "8.3.6" apply false
diff --git a/buildSrc/src/main/kotlin/datadog/gradle/plugin/config/ConfigInversionLinter.kt b/buildSrc/src/main/kotlin/datadog/gradle/plugin/config/ConfigInversionLinter.kt
@@ -99,9 +99,9 @@ private fun registerCheckEnvironmentVariablesUsage(project: Project) {
       val javaFiles = project.fileTree(project.projectDir) {
         include("**/src/main/java/**/*.java")
         exclude("**/build/**")
-        exclude("internal-api/src/main/java/datadog/trace/api/ConfigHelper.java")
+        exclude("utils/config-utils/src/main/java/datadog/trace/config/inversion/ConfigHelper.java")
         exclude("dd-java-agent/agent-bootstrap/**")
-        exclude("dd-java-agent/src/main/java/datadog/trace/bootstrap/BootstrapInitializationTelemetry.java")
+        exclude("dd-java-agent/src/main/java/datadog/trace/bootstrap/**")
       }
 
       val pattern = Regex("""EnvironmentVariables\.get\s*\(""")
diff --git a/components/environment/src/main/java/datadog/environment/EnvironmentVariables.java b/components/environment/src/main/java/datadog/environment/EnvironmentVariables.java
@@ -3,6 +3,7 @@
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.unmodifiableMap;
 
+import de.thetaphi.forbiddenapis.SuppressForbidden;
 import java.util.HashMap;
 import java.util.Map;
 import javax.annotation.Nullable;
@@ -17,10 +18,13 @@ public final class EnvironmentVariables {
   private EnvironmentVariables() {}
 
   public static class EnvironmentVariablesProvider {
+
+    @SuppressForbidden
     public String get(String name) {
       return System.getenv(name);
     }
 
+    @SuppressForbidden
     public Map<String, String> getAll() {
       return System.getenv();
     }
diff --git a/dd-java-agent/agent-logging/src/main/java/datadog/trace/logging/ddlogger/DDLoggerFactory.java b/dd-java-agent/agent-logging/src/main/java/datadog/trace/logging/ddlogger/DDLoggerFactory.java
@@ -1,8 +1,8 @@
 package datadog.trace.logging.ddlogger;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
 import datadog.trace.api.Platform;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.trace.logging.LogLevel;
 import datadog.trace.logging.LogLevelSwitcher;
 import datadog.trace.logging.LoggerHelper;
@@ -108,7 +108,7 @@ private static boolean isFlagEnabled(
     if ("false".equalsIgnoreCase(value)) {
       return false;
     }
-    value = EnvironmentVariables.get(envVar);
+    value = ConfigHelper.get().getEnvironmentVariable(envVar);
     if ("true".equalsIgnoreCase(value)) {
       return true;
     }
diff --git a/dd-java-agent/instrumentation/aws-java/aws-java-lambda-handler-1.2/src/main/java/datadog/trace/instrumentation/aws/v1/lambda/LambdaHandlerInstrumentation.java b/dd-java-agent/instrumentation/aws-java/aws-java-lambda-handler-1.2/src/main/java/datadog/trace/instrumentation/aws/v1/lambda/LambdaHandlerInstrumentation.java
@@ -16,14 +16,14 @@
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import com.google.auto.service.AutoService;
-import datadog.environment.EnvironmentVariables;
 import datadog.trace.agent.tooling.Instrumenter;
 import datadog.trace.agent.tooling.InstrumenterModule;
 import datadog.trace.bootstrap.CallDepthThreadLocalMap;
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
+import datadog.trace.config.inversion.ConfigHelper;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
@@ -61,7 +61,7 @@ public String[] helperClassNames() {
 
   @Override
   protected boolean defaultEnabled() {
-    return EnvironmentVariables.get(HANDLER_ENV_NAME) != null;
+    return ConfigHelper.get().getEnvironmentVariable(HANDLER_ENV_NAME) != null;
   }
 
   @Override
diff --git a/dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenUtils.java b/dd-java-agent/instrumentation/maven-3.2.1/src/main/java/datadog/trace/instrumentation/maven3/MavenUtils.java
@@ -1,7 +1,7 @@
 package datadog.trace.instrumentation.maven3;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.trace.api.civisibility.domain.JavaAgent;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.trace.util.MethodHandles;
 import datadog.trace.util.Strings;
 import de.thetaphi.forbiddenapis.SuppressForbidden;
@@ -66,7 +66,8 @@ public abstract class MavenUtils {
    * of the request object
    */
   public static String getCommandLine(MavenSession session) {
-    String mavenCmdLineArgsEnvVar = EnvironmentVariables.get(MAVEN_CMD_LINE_ARGS_ENVIRONMENT_VAR);
+    String mavenCmdLineArgsEnvVar =
+        ConfigHelper.get().getEnvironmentVariable(MAVEN_CMD_LINE_ARGS_ENVIRONMENT_VAR);
     if (mavenCmdLineArgsEnvVar != null) {
       return MVN_CMD_LINE_INVOCATION + mavenCmdLineArgsEnvVar;
     }
diff --git a/dd-java-agent/src/main/java6/datadog/trace/bootstrap/AgentPreCheck.java b/dd-java-agent/src/main/java6/datadog/trace/bootstrap/AgentPreCheck.java
@@ -90,6 +90,7 @@ private static boolean compatible() {
   }
 
   // Reachable for testing
+  @SuppressForbidden
   static boolean compatible(String javaVersion, String javaHome, PrintStream output) {
     int majorJavaVersion = parseJavaMajorVersion(javaVersion);
 
diff --git a/gradle/forbiddenApiFilters/main.txt b/gradle/forbiddenApiFilters/main.txt
@@ -29,6 +29,11 @@ net.bytebuddy.matcher.ElementMatchers#isAbstract()
 java.lang.System#out
 java.lang.System#err
 
+# avoid using System.getenv() or System.getenv(String) in code outside of ConfigHelper.java
+@defaultMessage Avoid using System.getenv() or System.getenv(String) in code outside of ConfigHelper.java
+java.lang.System#getenv()
+java.lang.System#getenv(java.lang.String)
+
 #Use jdk LongAdder
 @defaultMessage use LongAdder instead of the legacy jctools FixedSizeStripedLongCounter
 org.jctools.counters.FixedSizeStripedLongCounter
diff --git a/internal-api/src/main/java/datadog/trace/api/Config.java b/internal-api/src/main/java/datadog/trace/api/Config.java
@@ -638,7 +638,6 @@
 import static datadog.trace.util.CollectionUtils.tryMakeImmutableSet;
 import static datadog.trace.util.ConfigStrings.propertyNameToEnvironmentVariableName;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.JavaVirtualMachine;
 import datadog.environment.OperatingSystem;
 import datadog.environment.SystemProperties;
@@ -662,6 +661,7 @@
 import datadog.trace.bootstrap.config.provider.ConfigProvider;
 import datadog.trace.bootstrap.config.provider.SystemPropertiesConfigSource;
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.trace.context.TraceScope;
 import datadog.trace.util.ConfigStrings;
 import datadog.trace.util.PidHelper;
@@ -5303,7 +5303,7 @@ private static boolean isWindowsOS() {
   }
 
   private static String getEnv(String name) {
-    String value = EnvironmentVariables.get(name);
+    String value = ConfigHelper.get().getEnvironmentVariable(name);
     if (value != null) {
       // Report non-default sequence id for consistency
       ConfigCollector.get().put(name, value, ConfigOrigin.ENV, NON_DEFAULT_SEQ_ID);
diff --git a/internal-api/src/main/java/datadog/trace/util/PidHelper.java b/internal-api/src/main/java/datadog/trace/util/PidHelper.java
@@ -1,9 +1,9 @@
 package datadog.trace.util;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.JavaVirtualMachine;
 import datadog.environment.OperatingSystem;
 import datadog.environment.SystemProperties;
+import datadog.trace.config.inversion.ConfigHelper;
 import de.thetaphi.forbiddenapis.SuppressForbidden;
 import java.io.IOException;
 import java.lang.management.ManagementFactory;
@@ -80,13 +80,13 @@ private static String getTempDir() {
         return "/tmp";
       } else if (OperatingSystem.isWindows()) {
         return Stream.of("TMP", "TEMP", "USERPROFILE")
-            .map(EnvironmentVariables::get)
+            .map(ConfigHelper.get()::getEnvironmentVariable)
             .filter(Objects::nonNull)
             .filter(((Predicate<String>) String::isEmpty).negate())
             .findFirst()
             .orElse("C:\\Windows");
       } else if (OperatingSystem.isMacOs()) {
-        return EnvironmentVariables.get("TMPDIR");
+        return ConfigHelper.get().getEnvironmentVariable("TMPDIR");
       } else {
         return SystemProperties.get("java.io.tmpdir");
       }
diff --git a/internal-api/src/main/java/datadog/trace/util/TempLocationManager.java b/internal-api/src/main/java/datadog/trace/util/TempLocationManager.java
@@ -1,10 +1,10 @@
 package datadog.trace.util;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
 import datadog.trace.api.config.ProfilingConfig;
 import datadog.trace.api.profiling.ProfilerFlareLogger;
 import datadog.trace.bootstrap.config.provider.ConfigProvider;
+import datadog.trace.config.inversion.ConfigHelper;
 import java.io.IOException;
 import java.nio.file.FileSystems;
 import java.nio.file.FileVisitResult;
@@ -300,7 +300,7 @@ private TempLocationManager() {
   static String getBaseTempDirName() {
     String userName = SystemProperties.get("user.name");
     // unlikely, but fall-back to system env based user name
-    userName = userName == null ? EnvironmentVariables.get("USER") : userName;
+    userName = userName == null ? ConfigHelper.get().getEnvironmentVariable("USER") : userName;
     // make sure we do not have any illegal characters in the user name
     userName =
         userName != null ? userName.replace('.', '_').replace('/', '_').replace(' ', '_') : null;
diff --git a/telemetry/src/main/java/datadog/telemetry/TelemetryRequest.java b/telemetry/src/main/java/datadog/telemetry/TelemetryRequest.java
@@ -2,7 +2,6 @@
 
 import datadog.common.container.ContainerInfo;
 import datadog.communication.ddagent.TracerVersion;
-import datadog.environment.EnvironmentVariables;
 import datadog.telemetry.api.DistributionSeries;
 import datadog.telemetry.api.Integration;
 import datadog.telemetry.api.LogMessage;
@@ -17,6 +16,7 @@
 import datadog.trace.api.telemetry.Endpoint;
 import datadog.trace.api.telemetry.ProductChange;
 import datadog.trace.api.telemetry.ProductChange.ProductType;
+import datadog.trace.config.inversion.ConfigHelper;
 import java.io.IOException;
 import java.util.EnumMap;
 import java.util.Map;
@@ -112,9 +112,11 @@ public void writeProducts() {
   }
 
   public void writeInstallSignature() {
-    String installId = EnvironmentVariables.get("DD_INSTRUMENTATION_INSTALL_ID");
-    String installType = EnvironmentVariables.get("DD_INSTRUMENTATION_INSTALL_TYPE");
-    String installTime = EnvironmentVariables.get("DD_INSTRUMENTATION_INSTALL_TIME");
+    String installId = ConfigHelper.get().getEnvironmentVariable("DD_INSTRUMENTATION_INSTALL_ID");
+    String installType =
+        ConfigHelper.get().getEnvironmentVariable("DD_INSTRUMENTATION_INSTALL_TYPE");
+    String installTime =
+        ConfigHelper.get().getEnvironmentVariable("DD_INSTRUMENTATION_INSTALL_TIME");
 
     try {
       requestBody.writeInstallSignature(installId, installType, installTime);
diff --git a/utils/config-utils/src/main/java/datadog/trace/api/env/CapturedEnvironment.java b/utils/config-utils/src/main/java/datadog/trace/api/env/CapturedEnvironment.java
@@ -1,8 +1,8 @@
 package datadog.trace.api.env;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.JavaVirtualMachine;
 import datadog.trace.api.config.GeneralConfig;
+import datadog.trace.config.inversion.ConfigHelper;
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
@@ -75,8 +75,8 @@ static void useFixedProcessInfo(final ProcessInfo processInfo) {
    * autodetection will return either the JAR filename or the java main class.
    */
   private String autodetectServiceName() {
-    String inAas = EnvironmentVariables.get("DD_AZURE_APP_SERVICES");
-    String siteName = EnvironmentVariables.get("WEBSITE_SITE_NAME");
+    String inAas = ConfigHelper.get().getEnvironmentVariable("DD_AZURE_APP_SERVICES");
+    String siteName = ConfigHelper.get().getEnvironmentVariable("WEBSITE_SITE_NAME");
 
     if (("true".equalsIgnoreCase(inAas) || "1".equals(inAas)) && siteName != null) {
       return siteName;
diff --git a/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/AgentArgsInjector.java b/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/AgentArgsInjector.java
@@ -2,8 +2,8 @@
 
 import static datadog.trace.util.ConfigStrings.toEnvVar;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
+import datadog.trace.config.inversion.ConfigHelper;
 import java.util.Map;
 
 public class AgentArgsInjector {
@@ -31,7 +31,7 @@ public static void injectAgentArgsConfig(Map<String, String> args) {
       }
 
       String envVarName = toEnvVar(propertyName);
-      String envVarValue = EnvironmentVariables.get(envVarName);
+      String envVarValue = ConfigHelper.get().getEnvironmentVariable(envVarName);
       if (envVarValue != null) {
         // env variables should have higher priority than agent arguments
         continue;
diff --git a/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/EnvironmentConfigSource.java b/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/EnvironmentConfigSource.java
@@ -3,13 +3,13 @@
 import static datadog.trace.api.ConfigOrigin.ENV;
 import static datadog.trace.util.ConfigStrings.propertyNameToEnvironmentVariableName;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.trace.api.ConfigOrigin;
+import datadog.trace.config.inversion.ConfigHelper;
 
 final class EnvironmentConfigSource extends ConfigProvider.Source {
   @Override
   protected String get(String key) {
-    return EnvironmentVariables.get(propertyNameToEnvironmentVariableName(key));
+    return ConfigHelper.get().getEnvironmentVariable(propertyNameToEnvironmentVariableName(key));
   }
 
   @Override
diff --git a/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/OtelEnvironmentConfigSource.java b/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/OtelEnvironmentConfigSource.java
@@ -17,11 +17,11 @@
 import static datadog.trace.util.ConfigStrings.toEnvVar;
 import static datadog.trace.util.ConfigStrings.toEnvVarLowerCase;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
 import datadog.trace.api.ConfigOrigin;
 import datadog.trace.api.TracePropagationStyle;
 import datadog.trace.api.telemetry.OtelEnvMetricCollectorProvider;
+import datadog.trace.config.inversion.ConfigHelper;
 import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -185,7 +185,7 @@ private String getDatadogProperty(String sysProp) {
   private static String getProperty(String sysProp) {
     String value = SystemProperties.get(sysProp);
     if (null == value) {
-      value = EnvironmentVariables.get(toEnvVar(sysProp));
+      value = ConfigHelper.get().getEnvironmentVariable(toEnvVar(sysProp));
     }
     return value;
   }
diff --git a/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/StableConfigParser.java b/utils/config-utils/src/main/java/datadog/trace/bootstrap/config/provider/StableConfigParser.java
@@ -1,10 +1,10 @@
 package datadog.trace.bootstrap.config.provider;
 
-import datadog.environment.EnvironmentVariables;
 import datadog.environment.SystemProperties;
 import datadog.trace.bootstrap.config.provider.stableconfig.Rule;
 import datadog.trace.bootstrap.config.provider.stableconfig.Selector;
 import datadog.trace.bootstrap.config.provider.stableconfig.StableConfig;
+import datadog.trace.config.inversion.ConfigHelper;
 import datadog.yaml.YamlParser;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -166,7 +166,7 @@ static boolean selectorMatch(String origin, List<String> matches, String operato
         if (key == null) {
           return false;
         }
-        String envValue = EnvironmentVariables.get(key.toUpperCase(Locale.ROOT));
+        String envValue = ConfigHelper.get().getEnvironmentVariable(key.toUpperCase(Locale.ROOT));
         return matchOperator(envValue, operator, matches);
       case "process_arguments":
         if (key == null) {
@@ -242,7 +242,7 @@ private static String processTemplateVar(String templateVar) throws IOException
       if (envVar.isEmpty()) {
         throw new IOException("Empty environment variable name in template");
       }
-      String value = EnvironmentVariables.get(envVar.toUpperCase(Locale.ROOT));
+      String value = ConfigHelper.get().getEnvironmentVariable(envVar.toUpperCase(Locale.ROOT));
       if (value == null || value.isEmpty()) {
         return UNDEFINED_VALUE;
       }
diff --git a/utils/container-utils/build.gradle.kts b/utils/container-utils/build.gradle.kts
@@ -6,6 +6,7 @@ apply(from = "$rootDir/gradle/java.gradle")
 
 dependencies {
   implementation(project(":components:environment"))
+  implementation(project(":utils:config-utils"))
   implementation(libs.slf4j)
 
   testImplementation(project(":utils:test-utils"))
diff --git a/utils/container-utils/src/main/java/datadog/common/container/ServerlessInfo.java b/utils/container-utils/src/main/java/datadog/common/container/ServerlessInfo.java
@@ -1,6 +1,6 @@
 package datadog.common.container;
 
-import datadog.environment.EnvironmentVariables;
+import datadog.trace.config.inversion.ConfigHelper;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.File;
 
@@ -13,7 +13,7 @@ public class ServerlessInfo {
   private final boolean hasExtension;
 
   private ServerlessInfo(final String extensionPath) {
-    this.functionName = EnvironmentVariables.get(AWS_FUNCTION_VARIABLE);
+    this.functionName = ConfigHelper.get().getEnvironmentVariable(AWS_FUNCTION_VARIABLE);
     if (null == extensionPath) {
       this.hasExtension = false;
     } else {

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@ private static boolean compatible() {`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`// Reachable for testing`
	`93`	`+ @SuppressForbidden`
`93`	`94`	`static boolean compatible(String javaVersion, String javaHome, PrintStream output) {`
`94`	`95`	`int majorJavaVersion = parseJavaMajorVersion(javaVersion);`
`95`	`96`