Jfr streaming version (#721)

Resolves #707. Builds on #716. Turns out this wasn't a good first issue because there was some gradle buildSrc work needed to add a file with the version that the source code could read. Lifted the source for this from [opentelemetry-java](https://github.com/open-telemetry/opentelemetry-java/blob/main/buildSrc/src/main/kotlin/otel.java-conventions.gradle.kts#L144-L165). --------- Co-authored-by: Trask Stalnaker <[email protected]>
open-telemetry · Feb 2, 2023 · 6453d87 · 6453d87
1 parent e1e718c
commit 6453d87
Show file tree

Hide file tree

Showing 70 changed files with 137 additions and 60 deletions.
diff --git a/aws-resources/build.gradle.kts b/aws-resources/build.gradle.kts
@@ -5,6 +5,7 @@ plugins {
 }
 
 description = "OpenTelemetry AWS Resources Support"
+otelJava.moduleName.set("io.opentelemetry.contrib.aws.resource")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")

diff --git a/aws-xray-propagator/build.gradle.kts b/aws-xray-propagator/build.gradle.kts
@@ -5,6 +5,7 @@ plugins {
 }
 
 description = "OpenTelemetry AWS X-Ray Propagator"
+otelJava.moduleName.set("io.opentelemetry.contrib.awsxray.propagator")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")

diff --git a/aws-xray/build.gradle.kts b/aws-xray/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "OpenTelemetry AWS X-Ray Support"
+otelJava.moduleName.set("io.opentelemetry.contrib.awsxray")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")

diff --git a/buildSrc/src/main/kotlin/io/opentelemetry/gradle/OtelJavaExtension.kt b/buildSrc/src/main/kotlin/io/opentelemetry/gradle/OtelJavaExtension.kt
@@ -0,0 +1,12 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.gradle
+
+import org.gradle.api.provider.Property
+
+abstract class OtelJavaExtension {
+    abstract val moduleName: Property<String>
+}
diff --git a/buildSrc/src/main/kotlin/otel.java-conventions.gradle.kts b/buildSrc/src/main/kotlin/otel.java-conventions.gradle.kts
@@ -1,3 +1,4 @@
+import io.opentelemetry.gradle.OtelJavaExtension
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 
 plugins {
@@ -8,6 +9,8 @@ plugins {
   id("otel.spotless-conventions")
 }
 
+val otelJava = extensions.create<OtelJavaExtension>("otelJava")
+
 group = "io.opentelemetry.contrib"
 
 base.archivesName.set("opentelemetry-${project.name}")
@@ -86,6 +89,29 @@ tasks {
   }
 }
 
+// Add version information to published artifacts.
+plugins.withId("otel.publish-conventions") {
+  tasks {
+    register("generateVersionResource") {
+      val moduleName = otelJava.moduleName
+      val propertiesDir = moduleName.map { File(buildDir, "generated/properties/${it.replace('.', '/')}") }
+
+      inputs.property("project.version", project.version.toString())
+      outputs.dir(propertiesDir)
+
+      doLast {
+        File(propertiesDir.get(), "version.properties").writeText("contrib.version=${project.version}")
+      }
+    }
+  }
+
+  sourceSets {
+    main {
+      output.dir("$buildDir/generated/properties", "builtBy" to "generateVersionResource")
+    }
+  }
+}
+
 val dependencyManagement by configurations.creating {
   isCanBeConsumed = false
   isCanBeResolved = false

diff --git a/consistent-sampling/build.gradle.kts b/consistent-sampling/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "Sampler and exporter implementations for consistent sampling"
+otelJava.moduleName.set("io.opentelemetry.contrib.sampler.consistent")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-sdk-trace")

diff --git a/.../samplers/ConsistentAlwaysOffSampler.java → ...onsistent/ConsistentAlwaysOffSampler.java b/.../samplers/ConsistentAlwaysOffSampler.java → ...onsistent/ConsistentAlwaysOffSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import javax.annotation.concurrent.Immutable;
 

diff --git a/...b/samplers/ConsistentAlwaysOnSampler.java → ...consistent/ConsistentAlwaysOnSampler.java b/...b/samplers/ConsistentAlwaysOnSampler.java → ...consistent/ConsistentAlwaysOnSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import javax.annotation.concurrent.Immutable;
 

diff --git a/...amplers/ConsistentComposedAndSampler.java → ...sistent/ConsistentComposedAndSampler.java b/...amplers/ConsistentComposedAndSampler.java → ...sistent/ConsistentComposedAndSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...samplers/ConsistentComposedOrSampler.java → ...nsistent/ConsistentComposedOrSampler.java b/...samplers/ConsistentComposedOrSampler.java → ...nsistent/ConsistentComposedOrSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...amplers/ConsistentParentBasedSampler.java → ...sistent/ConsistentParentBasedSampler.java b/...amplers/ConsistentParentBasedSampler.java → ...sistent/ConsistentParentBasedSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...rs/ConsistentProbabilityBasedSampler.java → ...nt/ConsistentProbabilityBasedSampler.java b/...rs/ConsistentProbabilityBasedSampler.java → ...nt/ConsistentProbabilityBasedSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import javax.annotation.concurrent.Immutable;
 

diff --git a/...mplers/ConsistentRateLimitingSampler.java → ...istent/ConsistentRateLimitingSampler.java b/...mplers/ConsistentRateLimitingSampler.java → ...istent/ConsistentRateLimitingSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...istentReservoirSamplingSpanProcessor.java → ...istentReservoirSamplingSpanProcessor.java b/...istentReservoirSamplingSpanProcessor.java → ...istentReservoirSamplingSpanProcessor.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static io.opentelemetry.api.internal.Utils.checkArgument;
 import static java.util.Objects.requireNonNull;

diff --git a/...y/contrib/samplers/ConsistentSampler.java → ...sampler/consistent/ConsistentSampler.java b/...y/contrib/samplers/ConsistentSampler.java → ...sampler/consistent/ConsistentSampler.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...etry/contrib/samplers/OtelTraceState.java → ...ib/sampler/consistent/OtelTraceState.java b/...etry/contrib/samplers/OtelTraceState.java → ...ib/sampler/consistent/OtelTraceState.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import java.util.ArrayList;
 import java.util.Collections;

diff --git a/...try/contrib/samplers/RValueGenerator.java → ...b/sampler/consistent/RValueGenerator.java b/...try/contrib/samplers/RValueGenerator.java → ...b/sampler/consistent/RValueGenerator.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 /**
  * A function for generating r-values.

diff --git a/...ry/contrib/samplers/RValueGenerators.java → .../sampler/consistent/RValueGenerators.java b/...ry/contrib/samplers/RValueGenerators.java → .../sampler/consistent/RValueGenerators.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 final class RValueGenerators {
 

diff --git a/...try/contrib/samplers/RandomGenerator.java → ...b/sampler/consistent/RandomGenerator.java b/...try/contrib/samplers/RandomGenerator.java → ...b/sampler/consistent/RandomGenerator.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static java.util.Objects.requireNonNull;
 

diff --git a/...onsistentProbabilityBasedSamplerTest.java → ...onsistentProbabilityBasedSamplerTest.java b/...onsistentProbabilityBasedSamplerTest.java → ...onsistentProbabilityBasedSamplerTest.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertTrue;

diff --git a/...rs/ConsistentRateLimitingSamplerTest.java → ...nt/ConsistentRateLimitingSamplerTest.java b/...rs/ConsistentRateLimitingSamplerTest.java → ...nt/ConsistentRateLimitingSamplerTest.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

diff --git a/...ntReservoirSamplingSpanProcessorTest.java → ...ntReservoirSamplingSpanProcessorTest.java b/...ntReservoirSamplingSpanProcessorTest.java → ...ntReservoirSamplingSpanProcessorTest.java
@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
-import static io.opentelemetry.contrib.samplers.ConsistentReservoirSamplingSpanProcessor.DEFAULT_EXPORT_TIMEOUT_NANOS;
-import static io.opentelemetry.contrib.util.TestUtil.verifyObservedPvaluesUsingGtest;
+import static io.opentelemetry.contrib.sampler.consistent.ConsistentReservoirSamplingSpanProcessor.DEFAULT_EXPORT_TIMEOUT_NANOS;
+import static io.opentelemetry.contrib.sampler.consistent.TestUtil.verifyObservedPvaluesUsingGtest;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThatCode;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;

diff --git a/...ntrib/samplers/ConsistentSamplerTest.java → ...ler/consistent/ConsistentSamplerTest.java b/...ntrib/samplers/ConsistentSamplerTest.java → ...ler/consistent/ConsistentSamplerTest.java
@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
-import static io.opentelemetry.contrib.samplers.OtelTraceState.getInvalidP;
-import static io.opentelemetry.contrib.samplers.OtelTraceState.getInvalidR;
+import static io.opentelemetry.contrib.sampler.consistent.OtelTraceState.getInvalidP;
+import static io.opentelemetry.contrib.sampler.consistent.OtelTraceState.getInvalidR;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;

diff --git a/.../contrib/samplers/OtelTraceStateTest.java → ...ampler/consistent/OtelTraceStateTest.java b/.../contrib/samplers/OtelTraceStateTest.java → ...ampler/consistent/OtelTraceStateTest.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 

diff --git a/...contrib/samplers/RandomGeneratorTest.java → ...mpler/consistent/RandomGeneratorTest.java b/...contrib/samplers/RandomGeneratorTest.java → ...mpler/consistent/RandomGeneratorTest.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.samplers;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.fail;

diff --git a/.../opentelemetry/contrib/util/TestUtil.java → .../contrib/sampler/consistent/TestUtil.java b/.../opentelemetry/contrib/util/TestUtil.java → .../contrib/sampler/consistent/TestUtil.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.contrib.util;
+package io.opentelemetry.contrib.sampler.consistent;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

diff --git a/jfr-events/build.gradle.kts b/jfr-events/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "OpenTelemetry JFR Events"
+otelJava.moduleName.set("io.opentelemetry.contrib.jfrevent")
 
 dependencies {
   implementation("io.opentelemetry:opentelemetry-sdk")

diff --git a/jfr-streaming/build.gradle.kts b/jfr-streaming/build.gradle.kts
@@ -5,6 +5,9 @@ plugins {
   id("otel.publish-conventions")
 }
 
+description = "OpenTelemetry JFR Streaming"
+otelJava.moduleName.set("io.opentelemetry.contrib.jfr.streaming")
+
 // Disable publishing test fixtures
 val javaComponent = components["java"] as AdhocComponentWithVariants
 javaComponent.withVariantsFromConfiguration(configurations["testFixturesApiElements"]) { skip() }

diff --git a/jfr-streaming/src/main/java/io/opentelemetry/contrib/jfr/streaming/HandlerRegistry.java b/jfr-streaming/src/main/java/io/opentelemetry/contrib/jfr/streaming/HandlerRegistry.java
@@ -32,12 +32,12 @@
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Properties;
 import java.util.function.Predicate;
 
 final class HandlerRegistry {
-  private static final String SCOPE_NAME = "io.opentelemetry.contrib.jfr";
-  // TODO(jack-berg): read from version.properties
-  private static final String SCOPE_VERSION = "1.22.0-SNAPSHOT";
+  private static final String SCOPE_NAME = "io.opentelemetry.contrib.jfr.streaming";
+  private static final String SCOPE_VERSION = readVersion();
 
   private HandlerRegistry() {}
 
@@ -113,4 +113,15 @@ static List<RecordedEventHandler> getHandlers(
 
     return handlers;
   }
+
+  private static String readVersion() {
+    Properties properties = new Properties();
+    try {
+      properties.load(HandlerRegistry.class.getResourceAsStream("version.properties"));
+    } catch (Exception e) {
+      // we left the attribute empty
+      return "unknown";
+    }
+    return properties.getProperty("contrib.version", "unknown");
+  }
 }
diff --git a/jfr-streaming/src/test/java/io/opentelemetry/contrib/jfr/streaming/JfrTelemetryTest.java b/jfr-streaming/src/test/java/io/opentelemetry/contrib/jfr/streaming/JfrTelemetryTest.java
@@ -5,8 +5,7 @@
 
 package io.opentelemetry.contrib.jfr.streaming;
 
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.awaitility.Awaitility.await;
+import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
 
 import io.github.netmikey.logunit.api.LogCapturer;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
@@ -45,7 +44,16 @@ void create_Default() {
       assertThat(logs.getEvents()).hasSize(1);
       logs.assertContains("Starting JfrTelemetry");
 
-      await().untilAsserted(() -> assertThat(reader.collectAllMetrics()).isNotEmpty());
+      assertThat(reader.collectAllMetrics())
+          .isNotEmpty()
+          .allSatisfy(
+              metric -> {
+                assertThat(metric.getInstrumentationScopeInfo().getName())
+                    .isEqualTo("io.opentelemetry.contrib.jfr.streaming");
+                assertThat(metric.getInstrumentationScopeInfo().getVersion())
+                    .matches("1\\..*-alpha.*");
+              });
+      ;
     }
   }
 

diff --git a/jmx-metrics/build.gradle.kts b/jmx-metrics/build.gradle.kts
@@ -7,6 +7,7 @@ plugins {
 }
 
 description = "JMX metrics gathering Groovy script runner"
+otelJava.moduleName.set("io.opentelemetry.contrib.jmxmetrics")
 
 application.mainClass.set("io.opentelemetry.contrib.jmxmetrics.JmxMetrics")
 

diff --git a/maven-extension/build.gradle.kts b/maven-extension/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
 // equivalent to the Maven plugin `plexus-component-metadata:generate-metadata`
 
 description = "Maven extension to observe Maven builds with distributed traces using OpenTelemetry SDK"
+otelJava.moduleName.set("io.opentelemetry.maven")
 
 dependencies {
   implementation("org.codehaus.plexus:plexus-component-annotations:2.1.1")

diff --git a/micrometer-meter-provider/build.gradle.kts b/micrometer-meter-provider/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "OpenTelemetry Micrometer MeterProvider"
+otelJava.moduleName.set("io.opentelemetry.contrib.metrics.micrometer")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")

diff --git a/noop-api/build.gradle.kts b/noop-api/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "OpenTelemetry Noop API"
+otelJava.moduleName.set("io.opentelemetry.contrib.noopapi")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")

diff --git a/prometheus-client-bridge/build.gradle.kts b/prometheus-client-bridge/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
 }
 
 description = "Prometheus client bridge"
+otelJava.moduleName.set("io.opentelemetry.contrib.metrics.prometheus.clientbridge")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-sdk-metrics")
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ plugins { @@
     }
     description = "JMX metrics gathering Groovy script runner"
+    otelJava.moduleName.set("io.opentelemetry.contrib.jmxmetrics")
     application.mainClass.set("io.opentelemetry.contrib.jmxmetrics.JmxMetrics")
@@ Expand Down @@