initial prototype of EntityProvider

Author: breedx-splk

api/incubator/src/test/java/io/opentelemetry/api/incubator/trace/ExtendedTraceApiUsageTest.java

@@ -20,7 +20,7 @@
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.context.propagation.TextMapPropagator;
-import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;
 import io.opentelemetry.sdk.trace.IdGenerator;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
@@ -44,7 +44,7 @@ void tracerEnabled() {
     SdkTracerProviderBuilder tracerProviderBuilder =
         SdkTracerProvider.builder()
             // Default resource used for demonstration purposes
-            .setResource(Resource.getDefault())
+            .setEntityProvider(SdkEntityProvider.getDefault())
             // In-memory exporter used for demonstration purposes
             .addSpanProcessor(SimpleSpanProcessor.create(exporter));
     // Disable tracerB
@@ -99,7 +99,7 @@ void setParentFrom() {
     SdkTracerProvider tracerProvider =
         SdkTracerProvider.builder()
             // Default resource used for demonstration purposes
-            .setResource(Resource.getDefault())
+            .setEntityProvider(SdkEntityProvider.getDefault())
             // SimpleSpanProcessor with InMemorySpanExporter used for demonstration purposes
             .addSpanProcessor(SimpleSpanProcessor.create(spanExporter))
             .build();
@@ -159,7 +159,7 @@ void startAndCallOrRun() {
     SdkTracerProvider tracerProvider =
         SdkTracerProvider.builder()
             // Default resource used for demonstration purposes
-            .setResource(Resource.getDefault())
+            .setEntityProvider(SdkEntityProvider.getDefault())
             // SimpleSpanProcessor with InMemorySpanExporter used for demonstration purposes
             .addSpanProcessor(SimpleSpanProcessor.create(spanExporter))
             .build();

exporters/otlp/all/src/testSpanPipeline/java/io/opentelemetry/exporter/otlp/trace/SpanPipelineOtlpBenchmark.java

@@ -5,6 +5,8 @@
 
 package io.opentelemetry.exporter.otlp.trace;
 
+import static java.util.Collections.singletonList;
+
 import com.linecorp.armeria.server.ServerBuilder;
 import com.linecorp.armeria.server.ServiceRequestContext;
 import com.linecorp.armeria.server.grpc.protocol.AbstractUnaryGrpcService;
@@ -15,6 +17,9 @@
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.proto.collector.trace.v1.ExportTraceServiceResponse;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;
@@ -75,9 +80,10 @@ protected CompletionStage<byte[]> handleMessage(
 
   @BeforeEach
   public void setUp() {
+    EntityProvider entityProvider = new SdkEntityProvider(singletonList(Entity.create(RESOURCE)));
     tracerProvider =
         SdkTracerProvider.builder()
-            .setResource(RESOURCE)
+            .setEntityProvider(entityProvider)
             .addSpanProcessor(
                 BatchSpanProcessor.builder(
                         OtlpGrpcSpanExporter.builder()

integration-tests/otlp/src/main/java/io/opentelemetry/integrationtest/OtlpExporterIntegrationTest.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.integrationtest;
 
 import static io.opentelemetry.api.common.Value.of;
+import static java.util.Collections.singletonList;
 import static java.util.concurrent.CompletableFuture.completedFuture;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Awaitility.await;
@@ -62,6 +63,9 @@
 import io.opentelemetry.proto.trace.v1.ScopeSpans;
 import io.opentelemetry.proto.trace.v1.Span.Link;
 import io.opentelemetry.sdk.common.export.MemoryMode;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.export.BatchLogRecordProcessor;
 import io.opentelemetry.sdk.logs.export.LogRecordExporter;
@@ -80,7 +84,6 @@
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.CompletionStage;
 import java.util.concurrent.TimeUnit;
@@ -291,10 +294,12 @@ void testOtlpHttpTraceExport_mtls() throws Exception {
   }
 
   private static void testTraceExport(SpanExporter spanExporter) {
+
+    EntityProvider entityProvider = new SdkEntityProvider(singletonList(Entity.create(RESOURCE)));
     SdkTracerProvider tracerProvider =
         SdkTracerProvider.builder()
             .addSpanProcessor(SimpleSpanProcessor.create(spanExporter))
-            .setResource(RESOURCE)
+            .setEntityProvider(entityProvider)
             .build();
 
     SpanContext linkContext =
@@ -344,7 +349,7 @@ private static void testTraceExport(SpanExporter spanExporter) {
     assertThat(protoSpan.getName()).isEqualTo("my span name");
     assertThat(protoSpan.getAttributesList())
         .isEqualTo(
-            Collections.singletonList(
+            singletonList(
                 io.opentelemetry.proto.common.v1.KeyValue.newBuilder()
                     .setKey("key")
                     .setValue(AnyValue.newBuilder().setStringValue("value").build())
@@ -515,7 +520,7 @@ private static void testMetricExport(MetricExporter metricExporter) {
     assertThat(dataPoint.getAsInt()).isEqualTo(100);
     assertThat(dataPoint.getAttributesList())
         .isEqualTo(
-            Collections.singletonList(
+            singletonList(
                 io.opentelemetry.proto.common.v1.KeyValue.newBuilder()
                     .setKey("key")
                     .setValue(AnyValue.newBuilder().setStringValue("value").build())
@@ -792,7 +797,7 @@ private static void testLogRecordExporter(LogRecordExporter logRecordExporter) {
                 .build());
     assertThat(protoLog1.getAttributesList())
         .isEqualTo(
-            Collections.singletonList(
+            singletonList(
                 io.opentelemetry.proto.common.v1.KeyValue.newBuilder()
                     .setKey("key")
                     .setValue(AnyValue.newBuilder().setStringValue("value").build())

sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkBuilder.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.sdk.autoconfigure;
 
+import static java.util.Collections.singletonList;
 import static java.util.Objects.requireNonNull;
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
@@ -20,6 +21,9 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.AutoConfigureListener;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.logs.LogRecordProcessor;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
@@ -512,7 +516,8 @@ void configureSdk(
     closeables.add(meterProvider);
 
     SdkTracerProviderBuilder tracerProviderBuilder = SdkTracerProvider.builder();
-    tracerProviderBuilder.setResource(resource);
+    EntityProvider entityProvider = new SdkEntityProvider(singletonList(Entity.create(resource)));
+    tracerProviderBuilder.setEntityProvider(entityProvider);
     TracerProviderConfiguration.configureTracerProvider(
         tracerProviderBuilder,
         config,

sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/AutoConfiguredOpenTelemetrySdkTest.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.autoconfigure;
 
 import static io.opentelemetry.api.common.AttributeKey.stringKey;
+import static java.util.Collections.singletonList;
 import static java.util.Collections.singletonMap;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatCode;
@@ -43,6 +44,8 @@
 import io.opentelemetry.sdk.autoconfigure.spi.internal.AutoConfigureListener;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.logs.LogRecordProcessor;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
@@ -504,7 +507,9 @@ void tracerProviderCustomizer() {
         AutoConfiguredOpenTelemetrySdk.builder()
             .addTracerProviderCustomizer(
                 (tracerProviderBuilder, config) -> {
-                  tracerProviderBuilder.setResource(Resource.builder().put("cat", "meow").build());
+                  Entity entity = Entity.create(Resource.builder().put("cat", "meow").build());
+                  tracerProviderBuilder.setEntityProvider(
+                      new SdkEntityProvider(singletonList(entity)));
                   return tracerProviderBuilder.addSpanProcessor(
                       SimpleSpanProcessor.create(spanExporter));
                 })

sdk-extensions/autoconfigure/src/testIncubating/java/io/opentelemetry/sdk/autoconfigure/DeclarativeConfigurationTest.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.sdk.autoconfigure;
 
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
+import static java.util.Collections.singletonList;
 import static java.util.Collections.singletonMap;
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
@@ -31,6 +32,8 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
@@ -120,8 +123,13 @@ void configFile_Valid() {
         OpenTelemetrySdk.builder()
             .setTracerProvider(
                 SdkTracerProvider.builder()
-                    .setResource(
-                        Resource.getDefault().toBuilder().put("service.name", "test").build())
+                    .setEntityProvider(
+                        new SdkEntityProvider(
+                            singletonList(
+                                Entity.create(
+                                    Resource.getDefault().toBuilder()
+                                        .put("service.name", "test")
+                                        .build()))))
                     .addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
                     .build())
             .build();

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

@@ -5,9 +5,14 @@
 
 package io.opentelemetry.sdk.extension.incubator.fileconfig;
 
+import static java.util.Collections.singletonList;
+
 import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.OpenTelemetrySdkBuilder;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.Objects;
@@ -62,14 +67,15 @@ public OpenTelemetrySdk create(
     }
 
     if (model.getTracerProvider() != null) {
+      EntityProvider entityProvider = new SdkEntityProvider(singletonList(Entity.create(resource)));
       builder.setTracerProvider(
           context.addCloseable(
               TracerProviderFactory.getInstance()
                   .create(
                       TracerProviderAndAttributeLimits.create(
                           model.getAttributeLimits(), model.getTracerProvider()),
                       context)
-                  .setResource(resource)
+                  .setEntityProvider(entityProvider)
                   .build()));
     }
 

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java

@@ -23,6 +23,9 @@
 import io.opentelemetry.internal.testing.CleanupExtension;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AlwaysOnSamplerModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AttributeNameValueModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchLogRecordProcessorModel;
@@ -149,6 +152,8 @@ void create_Configured() {
             .put("shape", "square")
             .put("order", "second")
             .build();
+    EntityProvider entityProvider =
+        new SdkEntityProvider(Collections.singletonList(Entity.create(expectedResource)));
     OpenTelemetrySdk expectedSdk =
         OpenTelemetrySdk.builder()
             .setPropagators(
@@ -176,7 +181,7 @@ void create_Configured() {
                     .build())
             .setTracerProvider(
                 SdkTracerProvider.builder()
-                    .setResource(expectedResource)
+                    .setEntityProvider(entityProvider)
                     .setSpanLimits(
                         SpanLimits.builder()
                             .setMaxNumberOfAttributes(1)

sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java

@@ -22,6 +22,9 @@
 import io.opentelemetry.context.propagation.TextMapPropagator;
 import io.opentelemetry.sdk.common.Clock;
 import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.entities.Entity;
+import io.opentelemetry.sdk.entities.EntityProvider;
+import io.opentelemetry.sdk.entities.SdkEntityProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.export.LogRecordExporter;
 import io.opentelemetry.sdk.logs.export.SimpleLogRecordProcessor;
@@ -40,6 +43,8 @@
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import io.opentelemetry.sdk.trace.samplers.Sampler;
 import java.time.Duration;
+import java.util.Collections;
+import java.util.List;
 import java.util.concurrent.TimeUnit;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
@@ -269,7 +274,7 @@ void fullOpenTelemetrySdkConfigurationDemo() {
                 .addSpanProcessor(SimpleSpanProcessor.create(mock(SpanExporter.class)))
                 .setClock(mock(Clock.class))
                 .setIdGenerator(mock(IdGenerator.class))
-                .setResource(Resource.empty())
+                .setEntityProvider(SdkEntityProvider.empty())
                 .setSpanLimits(SpanLimits.builder().setMaxNumberOfAttributes(512).build())
                 .build())
         .setPropagators(ContextPropagators.create(mock(TextMapPropagator.class)))
@@ -379,11 +384,13 @@ void stringRepresentation() {
     when(propagator.toString()).thenReturn("MockTextMapPropagator{}");
     Resource resource =
         Resource.builder().put(AttributeKey.stringKey("service.name"), "otel-test").build();
+    List<Entity> entities = Collections.singletonList(Entity.create(resource));
+    EntityProvider entityProvider = new SdkEntityProvider(entities);
     OpenTelemetrySdk sdk =
         OpenTelemetrySdk.builder()
             .setTracerProvider(
                 SdkTracerProvider.builder()
-                    .setResource(resource)
+                    .setEntityProvider(entityProvider)
                     .addSpanProcessor(
                         SimpleSpanProcessor.create(
                             SpanExporter.composite(spanExporter, spanExporter)))

sdk/common/src/main/java/io/opentelemetry/sdk/entities/Entity.java

@@ -1,17 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 package io.opentelemetry.sdk.entities;
 
 import com.google.auto.value.AutoValue;
 import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.resources.Resource;
 import javax.annotation.concurrent.Immutable;
 
 @Immutable
 @AutoValue
-abstract public class Entity {
+public abstract class Entity {
 
   public static Entity create(String id, String name, Attributes attributes) {
     return new AutoValue_Entity(id, name, attributes);
   }
 
+  public static Entity create(Resource resource) {
+    // TODO: We didn't have an id/name, so we just use the hashCode() and this feels hacky
+    return create(
+        String.valueOf(resource.hashCode()),
+        String.valueOf(resource.hashCode()),
+        resource.getAttributes());
+  }
+
   public abstract String getId();
 
   public abstract String getName();
@@ -21,5 +35,4 @@ public static Entity create(String id, String name, Attributes attributes) {
   public Entity withAttributes(Attributes newAttributes) {
     return new AutoValue_Entity(getId(), getName(), newAttributes);
   }
-
 }