wip: stabilizing disabled keys from experimental.

open-telemetry · Oct 21, 2024 · 0ff2da7 · 0ff2da7
1 parent 680c940
commit 0ff2da7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/...autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ResourceConfiguration.java b/...autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ResourceConfiguration.java
@@ -21,9 +21,11 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.function.BiFunction;
+import java.util.logging.Logger;
 
 /**
  * Auto-configuration for the OpenTelemetry {@link Resource}.
@@ -32,12 +34,16 @@
  */
 public final class ResourceConfiguration {
 
+  private static final Logger logger = Logger.getLogger(ResourceConfiguration.class.getName());
+
   private static final AttributeKey<String> SERVICE_NAME = AttributeKey.stringKey("service.name");
 
   // Visible for testing
   static final String ATTRIBUTE_PROPERTY = "otel.resource.attributes";
   static final String SERVICE_NAME_PROPERTY = "otel.service.name";
-  static final String DISABLED_ATTRIBUTE_KEYS = "otel.experimental.resource.disabled.keys";
+  static final String EXPERIMENTAL_DISABLED_ATTRIBUTE_KEYS =
+      "otel.experimental.resource.disabled.keys";
+  static final String DISABLED_ATTRIBUTE_KEYS = "otel.resource.disabled.keys";
 
   /**
    * Create a {@link Resource} from the environment. The resource contains attributes parsed from
@@ -113,7 +119,16 @@ static Resource configureResource(
 
   // visible for testing
   static Resource filterAttributes(Resource resource, ConfigProperties configProperties) {
-    Set<String> disabledKeys = new HashSet<>(configProperties.getList(DISABLED_ATTRIBUTE_KEYS));
+    List<String> disabledAttibuteKeys = configProperties.getList(DISABLED_ATTRIBUTE_KEYS);
+    // TODO: Remove this once the deprecated property is removed.
+    if (disabledAttibuteKeys.isEmpty()) {
+      disabledAttibuteKeys = configProperties.getList(EXPERIMENTAL_DISABLED_ATTRIBUTE_KEYS);
+      if (!disabledAttibuteKeys.isEmpty()) {
+        logger.warning(
+            "otel.experimental.resource.disabled.keys is deprecated. Please use otel.resource.disabled.keys instead.");
+      }
+    }
+    Set<String> disabledKeys = new HashSet<>(disabledAttibuteKeys);
 
     ResourceBuilder builder =
         resource.toBuilder().removeIf(attributeKey -> disabledKeys.contains(attributeKey.getKey()));

diff --git a/...configure/src/test/java/io/opentelemetry/sdk/autoconfigure/ResourceConfigurationTest.java b/...configure/src/test/java/io/opentelemetry/sdk/autoconfigure/ResourceConfigurationTest.java
@@ -112,7 +112,8 @@ void createEnvironmentResource_EmptyResourceAttributes() {
   @Test
   void filterAttributes() {
     ConfigProperties configProperties =
-        DefaultConfigProperties.createFromMap(ImmutableMap.of(DISABLED_ATTRIBUTE_KEYS, "foo,bar"));
+        DefaultConfigProperties.createFromMap(
+            ImmutableMap.of(DISABLED_ATTRIBUTE_KEYS, "foo,bar"));
 
     Resource resourceNoSchema =
         Resource.builder().put("foo", "val").put("bar", "val").put("baz", "val").build();