Fix comments from code review.

open-telemetry · Nov 27, 2024 · 8b4f48f · 8b4f48f
1 parent 0ed5fe2
commit 8b4f48f
Show file tree

Hide file tree

Showing 8 changed files with 83 additions and 47 deletions.
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-common.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-common.txt
@@ -1,2 +1,63 @@
 Comparing source compatibility of opentelemetry-sdk-common-1.45.0-SNAPSHOT.jar against opentelemetry-sdk-common-1.44.1.jar
-No changes.
++++  NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.detectors.ServiceDetector  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW INTERFACE: io.opentelemetry.sdk.resources.EntityDetector
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) io.opentelemetry.sdk.resources.EntityDetector INSTANCE
+	+++  NEW METHOD: PUBLIC(+) java.util.List<io.opentelemetry.sdk.resources.Entity> detectEntities()
++++  NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.detectors.ServiceInstanceDetector  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW INTERFACE: io.opentelemetry.sdk.resources.EntityDetector
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) io.opentelemetry.sdk.resources.EntityDetector INSTANCE
+	+++  NEW METHOD: PUBLIC(+) java.util.List<io.opentelemetry.sdk.resources.Entity> detectEntities()
++++  NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.detectors.TelemetrySdkDetector  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW INTERFACE: io.opentelemetry.sdk.resources.EntityDetector
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) io.opentelemetry.sdk.resources.detectors.TelemetrySdkDetector INSTANCE
+	+++  NEW METHOD: PUBLIC(+) java.util.List<io.opentelemetry.sdk.resources.Entity> detectEntities()
++++  NEW CLASS: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.resources.Entity  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW CONSTRUCTOR: PUBLIC(+) Entity()
+	+++  NEW METHOD: PUBLIC(+) STATIC(+) FINAL(+) io.opentelemetry.sdk.resources.EntityBuilder builder(java.lang.String)
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.api.common.Attributes getAttributes()
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.api.common.Attributes getIdentifyingAttributes()
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) java.lang.String getSchemaUrl()
+		+++  NEW ANNOTATION: javax.annotation.Nullable
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) java.lang.String getType()
+	+++  NEW METHOD: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.EntityBuilder toBuilder()
++++  NEW CLASS: PUBLIC(+) io.opentelemetry.sdk.resources.EntityBuilder  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.Entity build()
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.EntityBuilder setSchemaUrl(java.lang.String)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.EntityBuilder withDescriptive(java.util.function.Consumer<io.opentelemetry.api.common.AttributesBuilder>)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.EntityBuilder withIdentifying(java.util.function.Consumer<io.opentelemetry.api.common.AttributesBuilder>)
++++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.resources.EntityDetector  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) java.util.List<io.opentelemetry.sdk.resources.Entity> detectEntities()
+**** MODIFIED CLASS: PUBLIC ABSTRACT io.opentelemetry.sdk.resources.Resource  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.resources.Resource create(io.opentelemetry.api.common.Attributes, java.lang.String, java.util.Collection<io.opentelemetry.sdk.resources.Entity>)
+	***  MODIFIED METHOD: PUBLIC NON_ABSTRACT (<- ABSTRACT) io.opentelemetry.api.common.Attributes getAttributes()
+	+++* NEW METHOD: PUBLIC(+) ABSTRACT(+) java.util.Collection<io.opentelemetry.sdk.resources.Entity> getEntities()
+***  MODIFIED CLASS: PUBLIC io.opentelemetry.sdk.resources.ResourceBuilder  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.ResourceBuilder add(io.opentelemetry.sdk.resources.Entity)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.ResourceBuilder addAll(java.util.Collection<io.opentelemetry.sdk.resources.Entity>)
++++  NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.ResourceProvider  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.resources.ResourceProviderBuilder builder()
+	+++  NEW METHOD: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.Resource getResource()
++++  NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.sdk.resources.ResourceProviderBuilder  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW CONSTRUCTOR: PUBLIC(+) ResourceProviderBuilder()
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.ResourceProviderBuilder addDetectedResource(io.opentelemetry.sdk.resources.Resource)
+		+++  NEW ANNOTATION: java.lang.Deprecated
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.ResourceProviderBuilder addEntityDetector(io.opentelemetry.sdk.resources.EntityDetector)
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.resources.ResourceProvider build()
diff --git a/...otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/ResourceEntityTest.java b/...otlp/common/src/test/java/io/opentelemetry/exporter/internal/otlp/ResourceEntityTest.java
@@ -19,9 +19,8 @@ void toJsonResourceWithEntity() throws Exception {
     Resource resource =
         Resource.builder()
             .add(
-                Entity.builder()
+                Entity.builder("test")
                     .setSchemaUrl("http://example.com/1.0")
-                    .setEntityType("test")
                     .withIdentifying(attr -> attr.put("test.id", 1))
                     .withDescriptive(attr -> attr.put("test.name", "one"))
                     .build())

diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/Entity.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/Entity.java
@@ -48,7 +48,8 @@ public abstract class Entity {
   public abstract Attributes getAttributes();
 
   /**
-   * Returns the URL of the OpenTelemetry schema used by this resource. May be null.
+   * Returns the URL of the OpenTelemetry schema used by this resource. May be null if this entity
+   * does not abide by schema conventions (i.e. is custom).
    *
    * @return An OpenTelemetry schema URL.
    * @since 1.4.0
@@ -68,7 +69,7 @@ public final EntityBuilder toBuilder() {
     return new EntityBuilder(this);
   }
 
-  public static final EntityBuilder builder() {
-    return new EntityBuilder();
+  public static final EntityBuilder builder(String entityType) {
+    return new EntityBuilder(entityType);
   }
 }
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/EntityBuilder.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/EntityBuilder.java
@@ -7,7 +7,6 @@
 
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
-import java.util.Objects;
 import java.util.function.Consumer;
 import javax.annotation.Nullable;
 
@@ -16,12 +15,13 @@
  * well as type and schema_url.
  */
 public class EntityBuilder {
-  @Nullable private String entityType;
+  private final String entityType;
   private final AttributesBuilder attributesBuilder;
   private final AttributesBuilder identifyingBuilder;
   @Nullable private String schemaUrl;
 
-  EntityBuilder() {
+  EntityBuilder(String entityType) {
+    this.entityType = entityType;
     this.attributesBuilder = Attributes.builder();
     this.identifyingBuilder = Attributes.builder();
   }
@@ -44,17 +44,6 @@ public EntityBuilder setSchemaUrl(String schemaUrl) {
     return this;
   }
 
-  /**
-   * Assign an Entity type to the resulting Entity.
-   *
-   * @param entityType The type name of the entity.
-   * @return this
-   */
-  public EntityBuilder setEntityType(String entityType) {
-    this.entityType = entityType;
-    return this;
-  }
-
   /**
    * Modify the descriptive attributes of this Entity.
    *
@@ -80,7 +69,6 @@ public EntityBuilder withIdentifying(Consumer<AttributesBuilder> f) {
   /** Create the {@link Entity} from this. */
   public Entity build() {
     // TODO - Better Checks.
-    Objects.requireNonNull(this.entityType);
     return Entity.create(
         entityType, identifyingBuilder.build(), attributesBuilder.build(), schemaUrl);
   }

diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/detectors/ServiceDetector.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/detectors/ServiceDetector.java
@@ -44,8 +44,7 @@ private static String getServiceName() {
   @Override
   public List<Entity> detectEntities() {
     return Collections.singletonList(
-        Entity.builder()
-            .setEntityType(ENTITY_TYPE)
+        Entity.builder(ENTITY_TYPE)
             .setSchemaUrl(SCHEMA_URL)
             .withIdentifying(
                 builder -> {

diff --git a/...ommon/src/main/java/io/opentelemetry/sdk/resources/detectors/ServiceInstanceDetector.java b/...ommon/src/main/java/io/opentelemetry/sdk/resources/detectors/ServiceInstanceDetector.java
@@ -28,8 +28,7 @@ private static String getInstanceId() {
   @Override
   public List<Entity> detectEntities() {
     return Collections.singletonList(
-        Entity.builder()
-            .setEntityType(ENTITY_TYPE)
+        Entity.builder(ENTITY_TYPE)
             .setSchemaUrl(SCHEMA_URL)
             .withIdentifying(
                 builder -> {

diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/resources/detectors/TelemetrySdkDetector.java b/sdk/common/src/main/java/io/opentelemetry/sdk/resources/detectors/TelemetrySdkDetector.java
@@ -26,8 +26,7 @@ public final class TelemetrySdkDetector implements EntityDetector {
 
   static {
     TELEMETRY_SDK =
-        Entity.builder()
-            .setEntityType(ENTITY_TYPE)
+        Entity.builder(ENTITY_TYPE)
             .setSchemaUrl(SCHEMA_URL)
             .withIdentifying(
                 attributes -> {

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
@@ -241,8 +241,7 @@ void testMergeResources_entities_separate_types() {
     Resource resource1 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -253,8 +252,7 @@ void testMergeResources_entities_separate_types() {
     Resource resource2 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("b")
+                Entity.builder("b")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -274,8 +272,7 @@ void testMergeResources_entities_separate_types_and_schema() {
     Resource resource1 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -286,8 +283,7 @@ void testMergeResources_entities_separate_types_and_schema() {
     Resource resource2 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("b")
+                Entity.builder("b")
                     .setSchemaUrl("two")
                     .withIdentifying(
                         builder -> {
@@ -307,8 +303,7 @@ void testMergeResources_entities_same_types_and_id() {
     Resource resource1 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -323,8 +318,7 @@ void testMergeResources_entities_same_types_and_id() {
     Resource resource2 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -349,8 +343,7 @@ void testMergeResources_entity_vs_raw_attribute() {
     Resource resource1 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -376,8 +369,7 @@ void testMergeResources_entities_same_types_different_id() {
     Resource resource1 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -392,8 +384,7 @@ void testMergeResources_entities_same_types_different_id() {
     Resource resource2 =
         Resource.builder()
             .add(
-                Entity.builder()
-                    .setEntityType("a")
+                Entity.builder("a")
                     .setSchemaUrl("one")
                     .withIdentifying(
                         builder -> {
@@ -514,9 +505,8 @@ public void build_withEntities() {
     Resource resource =
         Resource.builder()
             .add(
-                Entity.builder()
+                Entity.builder("a")
                     .setSchemaUrl("http://example.com")
-                    .setEntityType("a")
                     .withIdentifying(id -> id.put("a", "b"))
                     .build())
             .build();