From e7b828ef94098b3add1efaa62cd4b65966d724be Mon Sep 17 00:00:00 2001 From: Jason Plumb Date: Tue, 14 Jan 2025 12:56:54 -0800 Subject: [PATCH 1/5] add CLA note in CONTRIBUTING.md --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b52aa701..8e4826f86 100644 --- 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 From 3bc7783c427a4e6859ca4e642f67c52def9b49be Mon Sep 17 00:00:00 2001 From: Jason Plumb Date: Tue, 14 Jan 2025 13:27:35 -0800 Subject: [PATCH 2/5] change splunk.distro.version to telemetry.distro.version --- CHANGELOG.md | 4 ++++ custom/build.gradle.kts | 2 +- .../opentelemetry/SplunkDistroVersionResourceProvider.java | 5 ++++- .../SplunkDistroVersionResourceProviderTest.java | 5 ++--- .../java/com/splunk/opentelemetry/SpringBootSmokeTest.java | 2 +- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 64f5edcfd..6542af655 100644 --- 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/custom/build.gradle.kts b/custom/build.gradle.kts index b99ca11b4..70ad0b82f 100644 --- 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 index ed1adaf21..0838ef998 100644 --- a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java +++ b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java @@ -16,6 +16,8 @@ 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; @@ -44,7 +46,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 index 28a4b51dc..0a604f390 100644 --- 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 index 14dbdfbb7..293b3df03 100644 --- 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) { From 101b58f53aff8ac5c1466df97e629ae3d0d1de51 Mon Sep 17 00:00:00 2001 From: Jason Plumb Date: Tue, 14 Jan 2025 13:28:01 -0800 Subject: [PATCH 3/5] update badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 908637ffb..522b83640 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Existing customers should consider migrating to version 2.5.0 or higher. To lear OpenTelemetry Instrumentation for Java Version - Splunk GDI specification + Splunk GDI specification GitHub release (latest SemVer) From 4b2635d0b829bc9b72e57906056748c02c554e32 Mon Sep 17 00:00:00 2001 From: Jason Plumb Date: Thu, 16 Jan 2025 09:06:39 -0800 Subject: [PATCH 4/5] remove unused --- .../opentelemetry/SplunkDistroVersionResourceProvider.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java index 0838ef998..df5e53405 100644 --- a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java +++ b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java @@ -30,8 +30,6 @@ @AutoService(ResourceProvider.class) public class SplunkDistroVersionResourceProvider implements ResourceProvider { - static final AttributeKey SPLUNK_DISTRO_VERSION = - AttributeKey.stringKey("splunk.distro.version"); private static final Resource DISTRO_VERSION_RESOURCE = initialize(); From b5255ac7c1a0d0fb30db65ba360c98f1c97eb1e0 Mon Sep 17 00:00:00 2001 From: Jason Plumb Date: Thu, 16 Jan 2025 09:17:37 -0800 Subject: [PATCH 5/5] remove unused --- .../opentelemetry/SplunkDistroVersionResourceProvider.java | 1 - 1 file changed, 1 deletion(-) diff --git a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java index df5e53405..d6e8071ee 100644 --- a/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java +++ b/custom/src/main/java/com/splunk/opentelemetry/SplunkDistroVersionResourceProvider.java @@ -19,7 +19,6 @@ 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;