Rename prototype to more closely match OTEP 4316.

Author: jsuereth

api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java

@@ -6,12 +6,12 @@
 package io.opentelemetry.api.incubator;
 
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.api.incubator.entities.ResourceProvider;
+import io.opentelemetry.api.incubator.entities.EntityProvider;
 
-/** Extension to {@link OpenTelemetry} that adds {@link ResourceProvider}. */
+/** Extension to {@link OpenTelemetry} that adds {@link EntityProvider}. */
 public interface ExtendedOpenTelemetry extends OpenTelemetry {
-  /** Returns the {@link ResourceProvider} for this {@link OpenTelemetry}. */
-  default ResourceProvider getResourceProvider() {
-    return ResourceProvider.noop();
+  /** Returns the {@link EntityProvider} for this {@link OpenTelemetry}. */
+  default EntityProvider getEntityProvider() {
+    return EntityProvider.noop();
   }
 }

api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/EntityProvider.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.incubator.entities;
+
+/**
+ * A registry for interacting with {@link Resource}s. The name <i>Provider</i> is for consistency
+ * with other languages and it is <b>NOT</b> loaded using reflection.
+ *
+ * @see Resource
+ */
+public interface EntityProvider {
+  /**
+   * Returns a no-op {@link EntityProvider} which only creates no-op {@link Resource}s which do not
+   * record nor are emitted.
+   */
+  static EntityProvider noop() {
+    return NoopEntityProvider.INSTANCE;
+  }
+
+  /**
+   * Removes an entity from this resource.
+   *
+   * @param entityType the type of entity to remove.
+   * @return true if entity was found and removed.
+   */
+  boolean removeEntity(String entityType);
+
+  /**
+   * Attaches an entity to the current {@code Resource}.
+   *
+   * <p>This will only add new entities or update description of existing entities.
+   *
+   * @param entityType The type of the entity.
+   * @return A builder that can construct an entity.
+   */
+  EntityBuilder attachOrUpdateEntity(String entityType);
+}

…api/incubator/entities/NoopResource.java …cubator/entities/NoopEntityProvider.javaapi/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResource.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopEntityProvider.java api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResource.java renamed to api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopEntityProvider.java

@@ -5,17 +5,17 @@
 
 package io.opentelemetry.api.incubator.entities;
 
-final class NoopResource implements Resource {
+final class NoopEntityProvider implements EntityProvider {
 
-  static final Resource INSTANCE = new NoopResource();
+  static final EntityProvider INSTANCE = new NoopEntityProvider();
 
   @Override
   public boolean removeEntity(String entityType) {
     return false;
   }
 
   @Override
-  public EntityBuilder attachEntity(String entityType) {
+  public EntityBuilder attachOrUpdateEntity(String entityType) {
     return NoopEntityBuilder.INSTANCE;
   }
 }

api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/NoopResourceProvider.java

@@ -6,14 +6,14 @@
 package io.opentelemetry.sdk.extension.incubator;
 
 import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
-import io.opentelemetry.api.incubator.entities.ResourceProvider;
+import io.opentelemetry.api.incubator.entities.EntityProvider;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import java.io.Closeable;
 
-/** A new interface for creating OpenTelemetrySdk that supports {@link ResourceProvider}. */
+/** A new interface for creating OpenTelemetrySdk that supports {@link EntityProvider}. */
 public interface ExtendedOpenTelemetrySdk extends ExtendedOpenTelemetry, Closeable {
   /**
    * Shutdown the SDK. Calls {@link SdkTracerProvider#shutdown()}, {@link

api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/Resource.java

@@ -6,12 +6,12 @@
 package io.opentelemetry.sdk.extension.incubator;
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.api.incubator.entities.ResourceProvider;
+import io.opentelemetry.api.incubator.entities.EntityProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.OpenTelemetrySdkBuilder;
-import io.opentelemetry.sdk.extension.incubator.entities.SdkResourceProvider;
-import io.opentelemetry.sdk.extension.incubator.entities.SdkResourceProviderBuilder;
+import io.opentelemetry.sdk.extension.incubator.entities.SdkEntityProvider;
+import io.opentelemetry.sdk.extension.incubator.entities.SdkEntityProviderBuilder;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
 import io.opentelemetry.sdk.logs.internal.SdkLoggerProviderUtil;
@@ -23,13 +23,13 @@
 import io.opentelemetry.sdk.trace.internal.SdkTracerProviderUtil;
 import java.util.function.Consumer;
 
-/** A new interface for creating OpenTelemetrySdk that supports {@link ResourceProvider}. */
+/** A new interface for creating OpenTelemetrySdk that supports {@link EntityProvider}. */
 public final class ExtendedOpenTelemetrySdkBuilder {
   private ContextPropagators propagators = ContextPropagators.noop();
   private final SdkTracerProviderBuilder tracerProviderBuilder = SdkTracerProvider.builder();
   private final SdkMeterProviderBuilder meterProviderBuilder = SdkMeterProvider.builder();
   private final SdkLoggerProviderBuilder loggerProviderBuilder = SdkLoggerProvider.builder();
-  private final SdkResourceProviderBuilder resourceProviderBuilder = SdkResourceProvider.builder();
+  private final SdkEntityProviderBuilder resourceProviderBuilder = SdkEntityProvider.builder();
 
   /** Sets the {@link ContextPropagators} to use. */
   public ExtendedOpenTelemetrySdkBuilder setPropagators(ContextPropagators propagators) {
@@ -83,18 +83,18 @@ public ExtendedOpenTelemetrySdkBuilder withLoggerProvider(
    * @see GlobalOpenTelemetry
    */
   public ExtendedOpenTelemetrySdk build() {
-    SdkResourceProvider resourceProvider = resourceProviderBuilder.build();
+    SdkEntityProvider resourceProvider = resourceProviderBuilder.build();
     SdkTracerProvider tracerProvider =
         SdkTracerProviderUtil.setResourceSupplier(
-                tracerProviderBuilder, resourceProvider::getSdkResource)
+                tracerProviderBuilder, resourceProvider::getResource)
             .build();
     SdkMeterProvider meterProvider =
         SdkMeterProviderUtil.setResourceSupplier(
-                meterProviderBuilder, resourceProvider::getSdkResource)
+                meterProviderBuilder, resourceProvider::getResource)
             .build();
     SdkLoggerProvider loggerProvider =
         SdkLoggerProviderUtil.setResourceSupplier(
-                loggerProviderBuilder, resourceProvider::getSdkResource)
+                loggerProviderBuilder, resourceProvider::getResource)
             .build();
     return new ObfuscatedExtendedOpenTelemerySdk(
         resourceProvider, tracerProvider, meterProvider, loggerProvider, propagators);

api/incubator/src/main/java/io/opentelemetry/api/incubator/entities/ResourceProvider.java

@@ -5,8 +5,8 @@
 
 package io.opentelemetry.sdk.extension.incubator;
 
-import io.opentelemetry.api.incubator.entities.Resource;
-import io.opentelemetry.api.incubator.entities.ResourceProvider;
+import io.opentelemetry.api.incubator.entities.EntityBuilder;
+import io.opentelemetry.api.incubator.entities.EntityProvider;
 import io.opentelemetry.api.logs.LoggerBuilder;
 import io.opentelemetry.api.logs.LoggerProvider;
 import io.opentelemetry.api.metrics.MeterBuilder;
@@ -16,7 +16,7 @@
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.sdk.common.CompletableResultCode;
-import io.opentelemetry.sdk.extension.incubator.entities.SdkResourceProvider;
+import io.opentelemetry.sdk.extension.incubator.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
@@ -36,16 +36,16 @@ final class ObfuscatedExtendedOpenTelemerySdk implements ExtendedOpenTelemetrySd
   private final ObfuscatedTracerProvider tracerProvider;
   private final ObfuscatedMeterProvider meterProvider;
   private final ObfuscatedLoggerProvider loggerProvider;
-  private final ObfuscatedResourceProvider resourceProvider;
+  private final ObfuscatedEntityProvider entityProvider;
   private final ContextPropagators propagators;
 
   ObfuscatedExtendedOpenTelemerySdk(
-      SdkResourceProvider resourceProvider,
+      SdkEntityProvider entityProvider,
       SdkTracerProvider tracerProvider,
       SdkMeterProvider meterProvider,
       SdkLoggerProvider loggerProvider,
       ContextPropagators propagators) {
-    this.resourceProvider = new ObfuscatedResourceProvider(resourceProvider);
+    this.entityProvider = new ObfuscatedEntityProvider(entityProvider);
     this.tracerProvider = new ObfuscatedTracerProvider(tracerProvider);
     this.meterProvider = new ObfuscatedMeterProvider(meterProvider);
     this.loggerProvider = new ObfuscatedLoggerProvider(loggerProvider);
@@ -86,8 +86,8 @@ public LoggerProvider getLogsBridge() {
   }
 
   @Override
-  public ResourceProvider getResourceProvider() {
-    return resourceProvider;
+  public EntityProvider getEntityProvider() {
+    return entityProvider;
   }
 
   @Override
@@ -98,8 +98,8 @@ public ContextPropagators getPropagators() {
   @Override
   public String toString() {
     return "ExtendedOpenTelemetrySdk{"
-        + "resourceProivder="
-        + resourceProvider.unobfuscate()
+        + "entityProvider="
+        + entityProvider.unobfuscate()
         + ", tracerProvider="
         + tracerProvider.unobfuscate()
         + ", meterProvider="
@@ -211,21 +211,26 @@ public SdkLoggerProvider unobfuscate() {
    */
   @ThreadSafe
   // Visible for testing
-  static class ObfuscatedResourceProvider implements ResourceProvider {
+  static class ObfuscatedEntityProvider implements EntityProvider {
 
-    private final SdkResourceProvider delegate;
+    private final SdkEntityProvider delegate;
 
-    ObfuscatedResourceProvider(SdkResourceProvider delegate) {
+    ObfuscatedEntityProvider(SdkEntityProvider delegate) {
       this.delegate = delegate;
     }
 
+    public SdkEntityProvider unobfuscate() {
+      return delegate;
+    }
+
     @Override
-    public Resource getResource() {
-      return delegate.getResource();
+    public boolean removeEntity(String entityType) {
+      return delegate.removeEntity(entityType);
     }
 
-    public SdkResourceProvider unobfuscate() {
-      return delegate;
+    @Override
+    public EntityBuilder attachOrUpdateEntity(String entityType) {
+      return delegate.attachOrUpdateEntity(entityType);
     }
   }
 }

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

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator.entities;
+
+import io.opentelemetry.sdk.resources.Resource;
+
+/** A listener for changes in the EntityState of this SDK. */
+public interface EntityListener {
+  /**
+   * Called when an entity has been added or its state has changed.
+   *
+   * @param state The current state of the entity.
+   * @param resource The current state of the Resource.
+   */
+  public void onEntityState(EntityState state, Resource resource);
+
+  /**
+   * Called when an entity has been removed.
+   *
+   * @param state The current state of the removed entity.
+   * @param resource The current state of the Resource.
+   */
+  public void onEntityDelete(EntityState state, Resource resource);
+}