Fix Spring Boot null resource attributes for Open Telemetry (#177)

* Fix Sonar issue on Spring Boot property * Fix Sonar issue on Spring Boot property * Fix Sonar issue on Spring Boot property
michelin · Mar 6, 2024 · 04b6d57 · 04b6d57
1 parent 0e04810
commit 04b6d57
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/...pring-boot/src/main/java/com/michelin/kstreamplify/opentelemetry/OpenTelemetryConfig.java b/...pring-boot/src/main/java/com/michelin/kstreamplify/opentelemetry/OpenTelemetryConfig.java
@@ -29,7 +29,7 @@ public class OpenTelemetryConfig {
     /**
      * The OpenTelemetry resource attributes.
      */
-    @Value("${otel.resource.attributes:}")
+    @Value("${otel.resource.attributes:#{null}}")
     private String otelResourceAttributes;
 
     /**

diff --git a/...g-boot/src/test/java/com/michelin/kstreamplify/opentelemetry/OpenTelemetryConfigTest.java b/...g-boot/src/test/java/com/michelin/kstreamplify/opentelemetry/OpenTelemetryConfigTest.java
@@ -1,5 +1,6 @@
 package com.michelin.kstreamplify.opentelemetry;
 
+import static org.apache.commons.lang3.StringUtils.EMPTY;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -18,6 +19,32 @@
 class OpenTelemetryConfigTest {
     private final OpenTelemetryConfig openTelemetryConfig = new OpenTelemetryConfig();
 
+    @Test
+    void shouldNotAddTagsToMetricsWhenNull() {
+        openTelemetryConfig.setOtelResourceAttributes(null);
+        MeterRegistryCustomizer<MeterRegistry> customizer = openTelemetryConfig.addTagsOnMetrics();
+
+        MeterRegistry meterRegistry = new OpenTelemetryMeterRegistry();
+        customizer.customize(meterRegistry);
+        meterRegistry.counter("fakeCounterMetric");
+
+        assertEquals("fakeCounterMetric", meterRegistry.getMeters().get(0).getId().getName());
+        assertTrue(meterRegistry.getMeters().get(0).getId().getTags().isEmpty());
+    }
+
+    @Test
+    void shouldNotAddTagsToMetricsWhenEmpty() {
+        openTelemetryConfig.setOtelResourceAttributes(EMPTY);
+        MeterRegistryCustomizer<MeterRegistry> customizer = openTelemetryConfig.addTagsOnMetrics();
+
+        MeterRegistry meterRegistry = new OpenTelemetryMeterRegistry();
+        customizer.customize(meterRegistry);
+        meterRegistry.counter("fakeCounterMetric");
+
+        assertEquals("fakeCounterMetric", meterRegistry.getMeters().get(0).getId().getName());
+        assertTrue(meterRegistry.getMeters().get(0).getId().getTags().isEmpty());
+    }
+
     @Test
     void shouldAddTagsToMetricsWhenOpenTelemetryRegistry() {
         openTelemetryConfig.setOtelResourceAttributes("tagName=tagValue,tagName2=tagValue2");