Adopt GDI spec 1.7.0 (#2160)

* add CLA note in CONTRIBUTING.md * change splunk.distro.version to telemetry.distro.version * update badge * remove unused * remove unused
signalfx · Jan 16, 2025 · 229fd1b · 229fd1b
1 parent c172819
commit 229fd1b
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ and this repository adheres to [Semantic Versioning](https://semver.org/spec/v2.
 
 ## Unreleased
 
+- Rename `splunk.distro.version` to `telemetry.distro.version`.
+- Declare compatibility with GDI spec 1.7.0 
+  [#2148](https://github.com/signalfx/splunk-otel-java/issues/2148)
+
 ## v2.11.0 - 2025-01-09
 
 ### General

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -75,6 +75,9 @@ GitHub provides additional documentation on [forking a
 repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull
 request](https://help.github.com/articles/creating-a-pull-request/).
 
+Before your contribution can be accepted, you will be asked to sign our
+[Splunk Contributor License Agreement (CLA)](https://github.com/splunk/cla-agreement/blob/main/CLA.md).
+
 ## Finding contributions to work on
 
 Looking at the existing issues is a great way to find something to contribute

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Existing customers should consider migrating to version 2.5.0 or higher. To lear
     <img alt="OpenTelemetry Instrumentation for Java Version" src="https://img.shields.io/badge/otel-2.11.0-blueviolet?style=for-the-badge">
   </a>
   <a href="https://github.com/signalfx/gdi-specification/releases/tag/v1.6.0">
-    <img alt="Splunk GDI specification" src="https://img.shields.io/badge/GDI-1.6.0-blueviolet?style=for-the-badge">
+    <img alt="Splunk GDI specification" src="https://img.shields.io/badge/GDI-1.7.0-blueviolet?style=for-the-badge">
   </a>
   <a href="https://github.com/signalfx/splunk-otel-java/releases">
     <img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/signalfx/splunk-otel-java?include_prereleases&style=for-the-badge">

diff --git a/custom/build.gradle.kts b/custom/build.gradle.kts
@@ -46,7 +46,7 @@ tasks {
     outputs.dir(propertiesDir)
 
     doLast {
-      File(propertiesDir, "splunk.properties").writeText("splunk.distro.version=${project.version}")
+      File(propertiesDir, "splunk.properties").writeText("telemetry.distro.version=${project.version}")
     }
   }
 }
diff --git a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java
@@ -16,8 +16,9 @@
 
 package com.splunk.opentelemetry;
 
+import static io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION;
+
 import com.google.auto.service.AutoService;
-import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
@@ -28,8 +29,6 @@
 
 @AutoService(ResourceProvider.class)
 public class SplunkDistroVersionResourceProvider implements ResourceProvider {
-  static final AttributeKey<String> SPLUNK_DISTRO_VERSION =
-      AttributeKey.stringKey("splunk.distro.version");
 
   private static final Resource DISTRO_VERSION_RESOURCE = initialize();
 
@@ -44,7 +43,8 @@ private static Resource initialize() {
       splunkProps.load(in);
       return Resource.create(
           Attributes.of(
-              SPLUNK_DISTRO_VERSION, splunkProps.getProperty(SPLUNK_DISTRO_VERSION.getKey())));
+              TELEMETRY_DISTRO_VERSION,
+              splunkProps.getProperty(TELEMETRY_DISTRO_VERSION.getKey())));
     } catch (IOException e) {
       return Resource.empty();
     }

diff --git a/custom/src/test/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProviderTest.java b/custom/src/test/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProviderTest.java
@@ -17,6 +17,7 @@
 package com.splunk.opentelemetry;
 
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
+import static io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION;
 
 import org.junit.jupiter.api.Test;
 
@@ -31,8 +32,6 @@ void shouldGetDistroVersionFromProperties() {
 
     // then
     assertThat(resource.getAttributes().size()).isEqualTo(1);
-    assertThat(
-            resource.getAttributes().get(SplunkDistroVersionResourceProvider.SPLUNK_DISTRO_VERSION))
-        .isNotEmpty();
+    assertThat(resource.getAttributes().get(TELEMETRY_DISTRO_VERSION)).isNotEmpty();
   }
 }
diff --git a/smoke-tests/src/test/java/com/splunk/opentelemetry/SpringBootSmokeTest.java b/smoke-tests/src/test/java/com/splunk/opentelemetry/SpringBootSmokeTest.java
@@ -89,7 +89,7 @@ protected void assertTraces(TraceInspector traces) throws IOException {
 
     // verify that correct service name is set in the resource
     assertTrue(traces.resourceExists("service.name", "smoke-test-app"));
-    assertTrue(traces.resourceExists("splunk.distro.version", v -> !v.isEmpty()));
+    assertTrue(traces.resourceExists("telemetry.distro.version", v -> !v.isEmpty()));
   }
 
   protected void assertMetrics(MetricsInspector metrics) {