Merge pull request #5 from SylvainJuge/update-readme

prepare PR to be merged

Author: SylvainJuge

jmx-scraper/README.md

@@ -1,6 +1,8 @@
 # JMX Metric Scraper
 
 This utility provides a way to query JMX metrics and export them to an OTLP endpoint.
-The JMX MBeans and their metrics mapping is defined in YAML.
+The JMX MBeans and their metrics mapping is defined in YAML and is reusing implementation from
+[jmx-metrics instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/jmx-metrics).
 
-This is currently experimental, but the end goal is to provide an alternative to the [jmx-metrics](../jmx-metrics/README.md) utility.
+This is currently a work-in-progress component not ready to be used in production.
+The end goal is to provide an alternative to the [JMX Gatherer](../jmx-metrics/README.md) utility.

jmx-scraper/build.gradle.kts

@@ -3,7 +3,9 @@ plugins {
   id("com.github.johnrengelman.shadow")
 
   id("otel.java-conventions")
-  id("otel.publish-conventions")
+
+  // publishing disabled until component is ready to be used
+  // id("otel.publish-conventions")
 }
 
 description = "JMX metrics scraper"
@@ -16,11 +18,11 @@ dependencies {
   implementation("io.opentelemetry:opentelemetry-sdk")
   implementation("io.opentelemetry:opentelemetry-sdk-metrics")
   implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
-  implementation("io.opentelemetry:opentelemetry-sdk-testing")
 
   implementation("io.opentelemetry.instrumentation:opentelemetry-jmx-metrics")
 
   testImplementation("org.junit-pioneer:junit-pioneer")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
 }
 
 testing {