Merge the current Resource object with custom Resource Object. (#5619)

open-telemetry · Aug 9, 2023 · f52050b · f52050b
1 parent 88c80b1
commit f52050b
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 3 deletions.
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-logs.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-logs.txt
@@ -1,2 +1,4 @@
 Comparing source compatibility of  against 
-No changes.
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder addResource(io.opentelemetry.sdk.resources.Resource)
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-metrics.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-metrics.txt
@@ -1,2 +1,4 @@
 Comparing source compatibility of  against 
-No changes.
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder addResource(io.opentelemetry.sdk.resources.Resource)
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt
@@ -1,2 +1,4 @@
 Comparing source compatibility of  against 
-No changes.
+***  MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.sdk.trace.SdkTracerProviderBuilder  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) io.opentelemetry.sdk.trace.SdkTracerProviderBuilder addResource(io.opentelemetry.sdk.resources.Resource)
diff --git a/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilder.java b/sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilder.java
@@ -15,6 +15,7 @@
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Supplier;
 
 /**
@@ -95,4 +96,15 @@ public SdkLoggerProviderBuilder setClock(Clock clock) {
   public SdkLoggerProvider build() {
     return new SdkLoggerProvider(resource, logLimitsSupplier, logRecordProcessors, clock);
   }
+
+  /**
+   * Merge custom resource object with the current resource object.
+   *
+   * @param resource {@link Resource} object to merge with current.
+   */
+  public SdkLoggerProviderBuilder addResource(Resource resource) {
+    Objects.requireNonNull(resource, "resource");
+    this.resource = this.resource.merge(resource);
+    return this;
+  }
 }
diff --git a/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilderTest.java b/sdk/logs/src/test/java/io/opentelemetry/sdk/logs/SdkLoggerProviderBuilderTest.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.logs;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.resources.Resource;
+import org.junit.jupiter.api.Test;
+
+public class SdkLoggerProviderBuilderTest {
+
+  @Test
+  void addResource() {
+    Resource customResource =
+        Resource.create(
+            Attributes.of(
+                AttributeKey.stringKey("custom_attribute_key"), "custom_attribute_value"));
+
+    SdkLoggerProvider sdkLoggerProvider =
+        SdkLoggerProvider.builder().addResource(customResource).build();
+
+    assertThat(sdkLoggerProvider)
+        .extracting("sharedState")
+        .hasFieldOrPropertyWithValue("resource", Resource.getDefault().merge(customResource));
+  }
+}
diff --git a/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/SdkMeterProviderBuilder.java b/sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/SdkMeterProviderBuilder.java
@@ -134,4 +134,15 @@ SdkMeterProviderBuilder registerMetricReader(
   public SdkMeterProvider build() {
     return new SdkMeterProvider(registeredViews, metricReaders, clock, resource, exemplarFilter);
   }
+
+  /**
+   * Merge custom resource object with the current resource object.
+   *
+   * @param resource {@link Resource} object to merge with current.
+   */
+  public SdkMeterProviderBuilder addResource(Resource resource) {
+    Objects.requireNonNull(resource, "resource");
+    this.resource = this.resource.merge(resource);
+    return this;
+  }
 }
diff --git a/sdk/metrics/src/test/java/io/opentelemetry/sdk/metrics/SdkMeterProviderBuilderTest.java b/sdk/metrics/src/test/java/io/opentelemetry/sdk/metrics/SdkMeterProviderBuilderTest.java
@@ -7,6 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader;
 import org.junit.jupiter.api.Test;
@@ -23,4 +25,22 @@ void defaultResource() {
         .extracting("sharedState")
         .hasFieldOrPropertyWithValue("resource", Resource.getDefault());
   }
+
+  @Test
+  void addResource() {
+    Resource customResource =
+        Resource.create(
+            Attributes.of(
+                AttributeKey.stringKey("custom_attribute_key"), "custom_attribute_value"));
+
+    SdkMeterProvider sdkMeterProvider =
+        SdkMeterProvider.builder()
+            .registerMetricReader(InMemoryMetricReader.create())
+            .addResource(customResource)
+            .build();
+
+    assertThat(sdkMeterProvider)
+        .extracting("sharedState")
+        .hasFieldOrPropertyWithValue("resource", Resource.getDefault().merge(customResource));
+  }
 }
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilder.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilder.java
@@ -12,6 +12,7 @@
 import io.opentelemetry.sdk.trace.samplers.Sampler;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Supplier;
 
 /** Builder of {@link SdkTracerProvider}. */
@@ -145,4 +146,15 @@ public SdkTracerProvider build() {
   }
 
   SdkTracerProviderBuilder() {}
+
+  /**
+   * Merge custom resource object with the current resource object.
+   *
+   * @param resource {@link Resource} object to merge with current.
+   */
+  public SdkTracerProviderBuilder addResource(Resource resource) {
+    Objects.requireNonNull(resource, "resource");
+    this.resource = this.resource.merge(resource);
+    return this;
+  }
 }
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilderTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/SdkTracerProviderBuilderTest.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.trace;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.resources.Resource;
+import org.junit.jupiter.api.Test;
+
+public class SdkTracerProviderBuilderTest {
+
+  @Test
+  void addResource() {
+    Resource customResource =
+        Resource.create(
+            Attributes.of(
+                AttributeKey.stringKey("custom_attribute_key"), "custom_attribute_value"));
+
+    SdkTracerProvider sdkTracerProvider =
+        SdkTracerProvider.builder().addResource(customResource).build();
+
+    assertThat(sdkTracerProvider)
+        .extracting("sharedState")
+        .hasFieldOrPropertyWithValue("resource", Resource.getDefault().merge(customResource));
+  }
+}