Fixes from review.

jsuereth · jsuereth · commit f9dcb5273f28 · 2025-07-10T12:00:05.000-04:00
- Hide more methods (no incubating methods in public APIs that are not internal)
- Update builder API to use attributes directly
- Use static instances in Noop API
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java
@@ -3,9 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.api.incubator.entities;
+package io.opentelemetry.api.incubator;
 
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.entities.Resource;
+import io.opentelemetry.api.incubator.entities.ResourceProvider;
 
 /** Extension to {@link OpenTelemetry} that adds {@link ResourceProvider}. */
 public interface ExtendedOpenTelemetry extends OpenTelemetry {
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/EntityBuilder.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/EntityBuilder.java
@@ -6,8 +6,6 @@
 package io.opentelemetry.api.incubator.entities;
 
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.common.AttributesBuilder;
-import java.util.function.Consumer;
 
 /**
  * A builder of an Entity that allows to add identifying or descriptive {@link Attributes}, as well
@@ -37,18 +35,18 @@ public interface EntityBuilder {
   /**
    * Modify the descriptive attributes of this Entity.
    *
-   * @param f A {@link Consumer} which builds the descriptive attributes.
+   * @param description The {@link Attributes} which describe this Entity.
    * @return this
    */
-  EntityBuilder withDescription(Consumer<AttributesBuilder> f);
+  EntityBuilder withDescription(Attributes description);
 
   /**
    * Modify the identifying attributes of this Entity.
    *
-   * @param f A {@link Consumer} which builds the identifying attributes.
+   * @param id The {@link Attributes} which identify this Entity.
    * @return this
    */
-  EntityBuilder withId(Consumer<AttributesBuilder> f);
+  EntityBuilder withId(Attributes id);
 
   /** Emits the current entity. */
   void emit();
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopEntityBuilder.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopEntityBuilder.java
@@ -5,22 +5,24 @@
 
 package io.opentelemetry.api.incubator.entities;
 
-import io.opentelemetry.api.common.AttributesBuilder;
-import java.util.function.Consumer;
+import io.opentelemetry.api.common.Attributes;
 
 final class NoopEntityBuilder implements EntityBuilder {
+
+  static final EntityBuilder INSTANCE = new NoopEntityBuilder();
+
   @Override
   public EntityBuilder setSchemaUrl(String schemaUrl) {
     return this;
   }
 
   @Override
-  public EntityBuilder withDescription(Consumer<AttributesBuilder> f) {
+  public EntityBuilder withDescription(Attributes description) {
     return this;
   }
 
   @Override
-  public EntityBuilder withId(Consumer<AttributesBuilder> f) {
+  public EntityBuilder withId(Attributes id) {
     return this;
   }
 
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResource.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResource.java
@@ -7,13 +7,15 @@
 
 final class NoopResource implements Resource {
 
+  static final Resource INSTANCE = new NoopResource();
+
   @Override
   public boolean removeEntity(String entityType) {
     return false;
   }
 
   @Override
   public EntityBuilder attachEntity(String entityType) {
-    return new NoopEntityBuilder();
+    return NoopEntityBuilder.INSTANCE;
   }
 }
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResourceProvider.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResourceProvider.java
@@ -7,8 +7,10 @@
 
 final class NoopResourceProvider implements ResourceProvider {
 
+  static final ResourceProvider INSTANCE = new NoopResourceProvider();
+
   @Override
   public Resource getResource() {
-    return new NoopResource();
+    return NoopResource.INSTANCE;
   }
 }
diff --git a/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/ResourceProvider.java b/api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/ResourceProvider.java
@@ -17,7 +17,7 @@ public interface ResourceProvider {
    * not record nor are emitted.
    */
   static ResourceProvider noop() {
-    return new NoopResourceProvider();
+    return NoopResourceProvider.INSTANCE;
   }
 
   /** Returns the active {@link Resource} for which Telemetry is reported. */
diff --git a/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/EntityRefMarshaler.java b/exporters/otlp/common/src/main/java/io/opentelemetry/exporter/internal/otlp/EntityRefMarshaler.java
@@ -21,7 +21,7 @@
  * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
  * at any time.
  */
-public final class EntityRefMarshaler extends MarshalerWithSize {
+final class EntityRefMarshaler extends MarshalerWithSize {
   @Nullable private final byte[] schemaUrlUtf8;
   private final byte[] typeUtf8;
   private final byte[][] idKeysUtf8;
@@ -38,7 +38,7 @@ protected void writeTo(Serializer output) throws IOException {
   }
 
   /** Consttructs an entity reference marshaler from a full entity. */
-  public static EntityRefMarshaler createForEntity(Entity e) {
+  static EntityRefMarshaler createForEntity(Entity e) {
     byte[] schemaUrlUtf8 = null;
     if (!StringUtils.isNullOrEmpty(e.getSchemaUrl())) {
       schemaUrlUtf8 = e.getSchemaUrl().getBytes(StandardCharsets.UTF_8);
diff --git a/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/EntityRefMarshalerTest.java b/exporters/otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/EntityRefMarshalerTest.java
@@ -10,6 +10,7 @@
 import com.google.protobuf.InvalidProtocolBufferException;
 import com.google.protobuf.Message;
 import com.google.protobuf.util.JsonFormat;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.exporter.internal.marshal.Marshaler;
 import io.opentelemetry.proto.common.v1.EntityRef;
 import io.opentelemetry.sdk.resources.internal.Entity;
@@ -25,8 +26,8 @@ void toEntityRefs() {
     Entity e =
         Entity.builder("test")
             .setSchemaUrl("test-url")
-            .withDescription(attr -> attr.put("desc.key", "desc.value"))
-            .withId(attr -> attr.put("id.key", "id.value"))
+            .withDescription(Attributes.builder().put("desc.key", "desc.value").build())
+            .withId(Attributes.builder().put("id.key", "id.value").build())
             .build();
     EntityRef proto = parse(EntityRef.getDefaultInstance(), EntityRefMarshaler.createForEntity(e));
     assertThat(proto.getType()).isEqualTo("test");
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdk.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdk.java
@@ -5,7 +5,7 @@
 
 package io.opentelemetry.sdk.extension.incubator;
 
-import io.opentelemetry.api.incubator.entities.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
 import io.opentelemetry.api.incubator.entities.ResourceProvider;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/SdkEntityBuilder.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/SdkEntityBuilder.java
@@ -5,7 +5,7 @@
 
 package io.opentelemetry.sdk.extension.incubator.entities;
 
-import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.incubator.entities.EntityBuilder;
 import io.opentelemetry.sdk.resources.internal.Entity;
 import java.util.function.Consumer;
@@ -26,14 +26,14 @@ public EntityBuilder setSchemaUrl(String schemaUrl) {
   }
 
   @Override
-  public EntityBuilder withDescription(Consumer<AttributesBuilder> f) {
-    builder.withDescription(f);
+  public EntityBuilder withDescription(Attributes description) {
+    builder.withDescription(description);
     return this;
   }
 
   @Override
-  public EntityBuilder withId(Consumer<AttributesBuilder> f) {
-    builder.withId(f);
+  public EntityBuilder withId(Attributes id) {
+    builder.withId(id);
     return this;
   }
 
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/detectors/ServiceDetector.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/detectors/ServiceDetector.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.extension.incubator.entities.detectors;
 
 import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.incubator.entities.Resource;
 import io.opentelemetry.sdk.extension.incubator.entities.ResourceDetector;
 import java.util.UUID;
@@ -40,18 +41,12 @@ public void configure(Resource resource) {
         .attachEntity(ENTITY_TYPE)
         .setSchemaUrl(SCHEMA_URL)
         .withId(
-            id -> {
-              // Note: Identifying attributes MUST be provided together.
-              id.put(SERVICE_NAME, getServiceName())
-                  .put(SERVICE_INSTANCE_ID, getServiceInstanceId());
-            })
-        // No specified way to take these in.
-        // .withDescriptive(
-        //     builder -> {
-        //       if (!StringUtils.isNullOrEmpty(getVersion())) {
-        //         builder.put(SERVICE_VERSION, getVersion());
-        //       }
-        //     })
+            // Note: Identifying attributes MUST be provided together.
+            Attributes.builder()
+                .put(SERVICE_NAME, getServiceName())
+                .put(SERVICE_INSTANCE_ID, getServiceInstanceId())
+                .build())
+        // TODO - Need to figure out version
         .emit();
   }
 }
diff --git a/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/detectors/TelemetrySdkDetector.java b/sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/detectors/TelemetrySdkDetector.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.extension.incubator.entities.detectors;
 
 import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.incubator.entities.Resource;
 import io.opentelemetry.sdk.common.internal.OtelVersion;
 import io.opentelemetry.sdk.extension.incubator.entities.ResourceDetector;
@@ -33,10 +34,12 @@ public void configure(Resource resource) {
         .attachEntity(ENTITY_TYPE)
         .setSchemaUrl(SCHEMA_URL)
         .withId(
-            id -> {
-              id.put(TELEMETRY_SDK_NAME, "opentelemetry").put(TELEMETRY_SDK_LANGUAGE, "java");
-            })
-        .withDescription(desc -> desc.put(TELEMETRY_SDK_VERSION, OtelVersion.VERSION))
+            Attributes.builder()
+                .put(TELEMETRY_SDK_NAME, "opentelemetry")
+                .put(TELEMETRY_SDK_LANGUAGE, "java")
+                .build())
+        .withDescription(
+            Attributes.builder().put(TELEMETRY_SDK_VERSION, OtelVersion.VERSION).build())
         .emit();
   }
 }
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/TestExtendedOpenTelemetrySdk.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/TestExtendedOpenTelemetrySdk.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.extension.incubator;
 
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.LongCounter;
@@ -26,7 +27,7 @@ void endToEnd() {
     otel.getResourceProvider()
         .getResource()
         .attachEntity("test")
-        .withId(id -> id.put("test.id", 1))
+        .withId(Attributes.builder().put("test.id", 1).build())
         .emit();
     // Write a metric.
     Meter meter = otel.getMeterProvider().get("test.scope");
@@ -48,7 +49,7 @@ void endToEnd() {
     otel.getResourceProvider()
         .getResource()
         .attachEntity("test2")
-        .withId(id -> id.put("test2.id", 1))
+        .withId(Attributes.builder().put("test2.id", 1).build())
         .emit();
     // Verify we see the new entity and the metric.
     assertThat(sdkMeterReader.collectAllMetrics())
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/Resource.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/Resource.java
@@ -115,7 +115,7 @@ public static Resource create(Attributes attributes, @Nullable String schemaUrl)
    * @throws IllegalArgumentException if attribute key or attribute value is not a valid printable
    *     ASCII string or exceed {@link AttributeCheckUtil#MAX_LENGTH} characters.
    */
-  public static Resource create(
+  static Resource create(
       Attributes attributes, @Nullable String schemaUrl, Collection<Entity> entities) {
     AttributeCheckUtil.checkAttributes(Objects.requireNonNull(attributes, "attributes"));
     return new AutoValue_Resource(schemaUrl, attributes, entities);
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/EntityBuilder.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/EntityBuilder.java
@@ -6,8 +6,6 @@
 package io.opentelemetry.sdk.resources.internal;
 
 import io.opentelemetry.api.common.Attributes;
-import io.opentelemetry.api.common.AttributesBuilder;
-import java.util.function.Consumer;
 
 /**
  * A builder of {@link Entity} that allows to add identifying or descriptive {@link Attributes}, as
@@ -28,18 +26,18 @@ public interface EntityBuilder {
   /**
    * Modify the descriptive attributes of this Entity.
    *
-   * @param f A thunk which manipulates descriptive attributes.
+   * @param description The attributes that describe the Entity.
    * @return this
    */
-  EntityBuilder withDescription(Consumer<AttributesBuilder> f);
+  EntityBuilder withDescription(Attributes description);
 
   /**
    * Modify the identifying attributes of this Entity.
    *
-   * @param f A thunk which manipulates identifying attributes.
+   * @param id The identifying attributes.
    * @return this
    */
-  EntityBuilder withId(Consumer<AttributesBuilder> f);
+  EntityBuilder withId(Attributes id);
 
   /** Create the {@link Entity} from this. */
   Entity build();
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/EntityUtil.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/EntityUtil.java
@@ -34,6 +34,50 @@ public final class EntityUtil {
 
   private EntityUtil() {}
 
+  /**
+   * Constructs a new {@link Resource} with Entity support.
+   *
+   * @param entities The set of entities the resource needs.
+   * @return A constructed resource.
+   */
+  public static final Resource createResource(Collection<Entity> entities) {
+    return createResourceRaw(
+        Attributes.empty(), EntityUtil.mergeResourceSchemaUrl(entities, null, null), entities);
+  }
+
+  /**
+   * Constructs a new {@link Resource} with Entity support.
+   *
+   * @param attributes The raw attributes for the resource.
+   * @param schemaUrl The schema url for the resource.
+   * @param entities The set of entities the resource needs.
+   * @return A constructed resource.
+   */
+  static final Resource createResourceRaw(
+      Attributes attributes, @Nullable String schemaUrl, Collection<Entity> entities) {
+    try {
+      Method method =
+          Resource.class.getDeclaredMethod(
+              "create", Attributes.class, String.class, Collection.class);
+      if (method != null) {
+        method.setAccessible(true);
+        Object result = method.invoke(null, attributes, schemaUrl, entities);
+        if (result instanceof Resource) {
+          return (Resource) result;
+        }
+      }
+    } catch (NoSuchMethodException nme) {
+      logger.log(Level.WARNING, "Attempting to use entities with unsupported resource", nme);
+    } catch (IllegalAccessException iae) {
+      logger.log(Level.WARNING, "Attempting to use entities with unsupported resource", iae);
+    } catch (InvocationTargetException ite) {
+      logger.log(Level.WARNING, "Attempting to use entities with unsupported resource", ite);
+    }
+    // Fall back to non-entity behavior?
+    logger.log(Level.WARNING, "Attempting to use entities with unsupported resource");
+    return Resource.empty();
+  }
+
   /** Appends a new entity on to the end of the list of entities. */
   public static final ResourceBuilder addEntity(ResourceBuilder rb, Entity e) {
     try {
@@ -250,15 +294,10 @@ public static final Collection<Entity> mergeEntities(
           Entity next =
               old.toBuilder()
                   .withDescription(
-                      builder -> {
-                        // Clean existing attributes.
-                        builder.removeIf(ignore -> true);
-                        // For attributes, last one wins.
-                        // To ensure the previous attributes override,
-                        // we write them second.
-                        builder.putAll(e.getDescription());
-                        builder.putAll(old.getDescription());
-                      })
+                      Attributes.builder()
+                          .putAll(e.getDescription())
+                          .putAll(old.getDescription())
+                          .build())
                   .build();
           entities.put(next.getType(), next);
         }
@@ -290,6 +329,6 @@ public static Resource merge(Resource base, @Nullable Resource next) {
     // Now figure out schema url for overall resource.
     String schemaUrl =
         EntityUtil.mergeResourceSchemaUrl(entities, base.getSchemaUrl(), next.getSchemaUrl());
-    return Resource.create(attributeResult.getAttributes(), schemaUrl, entities);
+    return createResourceRaw(attributeResult.getAttributes(), schemaUrl, entities);
   }
 }
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/SdkEntityBuilder.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/SdkEntityBuilder.java
diff --git a/sdk/common/src/test/java/io/opentelemetry/sdk/resources/ResourceTest.java b/sdk/common/src/test/java/io/opentelemetry/sdk/resources/ResourceTest.java
diff --git a/sdk/common/src/test/java/io/opentelemetry/sdk/resources/internal/EntityUtilTest.java b/sdk/common/src/test/java/io/opentelemetry/sdk/resources/internal/EntityUtilTest.java

Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,15 @@`
`7`	`7`
`8`	`8`	`final class NoopResource implements Resource {`
`9`	`9`
	`10`	`+ static final Resource INSTANCE = new NoopResource();`
	`11`	`+`
`10`	`12`	`@Override`
`11`	`13`	`public boolean removeEntity(String entityType) {`
`12`	`14`	`return false;`
`13`	`15`	`}`
`14`	`16`
`15`	`17`	`@Override`
`16`	`18`	`public EntityBuilder attachEntity(String entityType) {`
`17`		`- return new NoopEntityBuilder();`
	`19`	`+ return NoopEntityBuilder.INSTANCE;`
`18`	`20`	`}`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,10 @@`
`7`	`7`
`8`	`8`	`final class NoopResourceProvider implements ResourceProvider {`
`9`	`9`
	`10`	`+ static final ResourceProvider INSTANCE = new NoopResourceProvider();`
	`11`	`+`
`10`	`12`	`@Override`
`11`	`13`	`public Resource getResource() {`
`12`		`- return new NoopResource();`
	`14`	`+ return NoopResource.INSTANCE;`
`13`	`15`	`}`
`14`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public interface ResourceProvider {`
`17`	`17`	`* not record nor are emitted.`
`18`	`18`	`*/`
`19`	`19`	`static ResourceProvider noop() {`
`20`		`- return new NoopResourceProvider();`
	`20`	`+ return NoopResourceProvider.INSTANCE;`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/** Returns the active {@link Resource} for which Telemetry is reported. */`