Simplify prototype of SdkResource.

Author: jsuereth

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/entities/SdkResource.java

@@ -6,16 +6,28 @@
 package io.opentelemetry.sdk.extension.incubator.entities;
 
 import io.opentelemetry.api.incubator.entities.EntityBuilder;
+import io.opentelemetry.api.internal.GuardedBy;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.resources.internal.Entity;
 import io.opentelemetry.sdk.resources.internal.EntityUtil;
+import java.util.ArrayList;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.annotation.Nullable;
 
 final class SdkResource implements io.opentelemetry.api.incubator.entities.Resource {
 
+  // The currently advertised Resource to other SDK providers.
   private final AtomicReference<Resource> resource = new AtomicReference<>(Resource.empty());
   private final Object writeLock = new Object();
 
+  // Our internal storage of registered entities.
+  @GuardedBy("writeLock")
+  private final ArrayList<Entity> entities = new ArrayList<>();
+
+  private static final Logger logger = Logger.getLogger(SdkResource.class.getName());
+
   /** Returns the currently active resource. */
   public Resource getResource() {
     Resource result = resource.get();
@@ -32,11 +44,44 @@ public boolean removeEntity(String entityType) {
     throw new UnsupportedOperationException("Unimplemented method 'removeEntity'");
   }
 
+  private static boolean hasSameSchemaUrl(Entity lhs, Entity rhs) {
+    if (lhs.getSchemaUrl() != null) {
+      return lhs.getSchemaUrl().equals(rhs.getSchemaUrl());
+    }
+    return rhs.getSchemaUrl() == null;
+  }
+
   void attachEntityOnEmit(Entity e) {
     synchronized (writeLock) {
-      Resource current = getResource();
-      Resource next = EntityUtil.addEntity(Resource.builder(), e).build();
-      resource.lazySet(current.merge(next));
+      @Nullable Entity conflict = null;
+      for (Entity existing : entities) {
+        if (existing.getType().equals(e.getType())) {
+          conflict = existing;
+        }
+      }
+
+      if (conflict != null) {
+        if (hasSameSchemaUrl(conflict, e) && conflict.getId().equals(e.getId())) {
+          // We can merge descriptive attributes.
+          entities.remove(conflict);
+          io.opentelemetry.sdk.resources.internal.EntityBuilder newEntity =
+              Entity.builder(conflict.getType())
+                  .withId(conflict.getId())
+                  .withDescription(
+                      conflict.getDescription().toBuilder().putAll(e.getDescription()).build());
+          if (conflict.getSchemaUrl() != null) {
+            newEntity.setSchemaUrl(conflict.getSchemaUrl());
+          }
+          entities.add(newEntity.build());
+        } else {
+          // TODO - use ThrottlingLogger?
+          logger.log(Level.WARNING, "Ignoring new entity, conflicts with existing: ", e);
+        }
+      } else {
+        entities.add(e);
+      }
+
+      resource.lazySet(EntityUtil.createResource(entities));
     }
   }
 

sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/EntityUtil.java

@@ -40,7 +40,7 @@ private EntityUtil() {}
    * @param entities The set of entities the resource needs.
    * @return A constructed resource.
    */
-  public static final Resource createResource(Collection<Entity> entities) {
+  public static Resource createResource(Collection<Entity> entities) {
     return createResourceRaw(
         Attributes.empty(), EntityUtil.mergeResourceSchemaUrl(entities, null, null), entities);
   }
@@ -53,7 +53,7 @@ public static final Resource createResource(Collection<Entity> entities) {
    * @param entities The set of entities the resource needs.
    * @return A constructed resource.
    */
-  static final Resource createResourceRaw(
+  static Resource createResourceRaw(
       Attributes attributes, @Nullable String schemaUrl, Collection<Entity> entities) {
     try {
       Method method =
@@ -79,7 +79,7 @@ static final Resource createResourceRaw(
   }
 
   /** Appends a new entity on to the end of the list of entities. */
-  public static final ResourceBuilder addEntity(ResourceBuilder rb, Entity e) {
+  public static ResourceBuilder addEntity(ResourceBuilder rb, Entity e) {
     try {
       Method method = ResourceBuilder.class.getDeclaredMethod("add", Entity.class);
       if (method != null) {
@@ -97,7 +97,7 @@ public static final ResourceBuilder addEntity(ResourceBuilder rb, Entity e) {
   }
 
   /** Appends a new collection of entities on to the end of the list of entities. */
-  public static final ResourceBuilder addAllEntity(ResourceBuilder rb, Collection<Entity> e) {
+  public static ResourceBuilder addAllEntity(ResourceBuilder rb, Collection<Entity> e) {
     try {
       Method method = ResourceBuilder.class.getDeclaredMethod("addAll", Collection.class);
       if (method != null) {
@@ -120,7 +120,7 @@ public static final ResourceBuilder addAllEntity(ResourceBuilder rb, Collection<
    * @return a collection of entities.
    */
   @SuppressWarnings("unchecked")
-  public static final Collection<Entity> getEntities(Resource r) {
+  public static Collection<Entity> getEntities(Resource r) {
     try {
       Method method = Resource.class.getDeclaredMethod("getEntities");
       if (method != null) {
@@ -142,7 +142,7 @@ public static final Collection<Entity> getEntities(Resource r) {
    *
    * @return a map of attributes.
    */
-  public static final Attributes getRawAttributes(Resource r) {
+  public static Attributes getRawAttributes(Resource r) {
     try {
       Method method = Resource.class.getDeclaredMethod("getRawAttributes");
       if (method != null) {
@@ -160,16 +160,15 @@ public static final Attributes getRawAttributes(Resource r) {
   }
 
   /** Returns true if any entity in the collection has the attribute key, in id or description. */
-  public static final <T> boolean hasAttributeKey(
-      Collection<Entity> entities, AttributeKey<T> key) {
+  public static <T> boolean hasAttributeKey(Collection<Entity> entities, AttributeKey<T> key) {
     return entities.stream()
         .anyMatch(
             e -> e.getId().asMap().containsKey(key) || e.getDescription().asMap().containsKey(key));
   }
 
   /** Decides on a final SchemaURL for OTLP Resource based on entities chosen. */
   @Nullable
-  static final String mergeResourceSchemaUrl(
+  static String mergeResourceSchemaUrl(
       Collection<Entity> entities, @Nullable String baseUrl, @Nullable String nextUrl) {
     // Check if entities all share the same URL.
     Set<String> entitySchemas =
@@ -228,8 +227,7 @@ static final RawAttributeMergeResult mergeRawAttributes(
       additional.forEach(
           (key, value) -> {
             for (Entity e : entities) {
-              if (e.getId().asMap().keySet().contains(key)
-                  || e.getDescription().asMap().keySet().contains(key)) {
+              if (e.getId().get(key) != null || e.getDescription().get(key) != null) {
                 // Remove the entity and push all attributes as raw,
                 // we have an override.
                 conflicts.add(e);
@@ -249,7 +247,7 @@ static final RawAttributeMergeResult mergeRawAttributes(
    * @param additional Additional entities to merge with base set.
    * @return A new set of entities with no duplicate types.
    */
-  public static final Collection<Entity> mergeEntities(
+  public static Collection<Entity> mergeEntities(
       Collection<Entity> base, Collection<Entity> additional) {
     if (base.isEmpty()) {
       return additional;

sdk/common/src/main/java/io/opentelemetry/sdk/resources/internal/SdkEntity.java

@@ -26,15 +26,9 @@ abstract class SdkEntity implements Entity {
    * @param id a map of attributes that identify the entity.
    * @param description a map of attributes that describe the entity.
    * @return a {@code Entity}.
-   * @throws NullPointerException if {@code id} or {@code description} is null.
-   * @throws IllegalArgumentException if entityType string, attribute key or attribute value is not
-   *     a valid printable ASCII string or exceed {@link AttributeCheckUtil#MAX_LENGTH} characters.
    */
   static final Entity create(
       String entityType, Attributes id, Attributes description, @Nullable String schemaUrl) {
-    AttributeCheckUtil.isValid(entityType);
-    AttributeCheckUtil.checkAttributes(id);
-    AttributeCheckUtil.checkAttributes(description);
     return new AutoValue_SdkEntity(entityType, id, description, schemaUrl);
   }
 

sdk/logs/src/main/java/io/opentelemetry/sdk/logs/LoggerSharedState.java

@@ -38,8 +38,7 @@ final class LoggerSharedState {
     this.exceptionAttributeResolver = exceptionAttributeResolver;
   }
 
-  // This is used in a test, and must be public for it.
-  public Resource getResource() {
+  Resource getResource() {
     return resourceSupplier.get();
   }