Skip to content

remove deprecated jmx gatherer - #3206

Merged
breedx-splk merged 8 commits into
open-telemetry:mainfrom
SylvainJuge:remove-jmx-gatherer
Nov 18, 2026
Merged

breedx-splk merged 8 commits into
open-telemetry:mainfrom
SylvainJuge:remove-jmx-gatherer

Conversation

@SylvainJuge

@SylvainJuge SylvainJuge commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

JMX gatherer has been deprecated for more than a year.

Fixes #2095

This also closes related issues that are no longer relevant.

Fixes #1236
Fixes #1266
Fixes #351

@SylvainJuge
SylvainJuge marked this pull request as ready for review November 6, 2026 08:56
@SylvainJuge
SylvainJuge requested a review from a team as a code owner November 6, 2026 08:56
Copilot AI balanced review requested due to automatic review settings November 6, 2026 08:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The removal lacks the required Unreleased migration note explaining that opentelemetry-jmx-metrics is no longer published, linking the migration guide, and documenting the last Gatherer version and legacy metric option.

No open issues 🎉

What changed in this PR

Removes the deprecated JMX Gatherer from OpenTelemetry Java Contrib, implementing the removal stage described in #2095 while retaining JMX Scraper as its replacement.

Changes:

  • Removes Gatherer implementation, metric definitions, tests, fixtures, and documentation.
  • Stops including Gatherer in the Gradle build and release artifacts.
  • Updates component listings, issue templates, ownership metadata, and Scraper documentation.
File Description
settings.gradle.kts Removes Gatherer from the build.
README.md Removes Gatherer from the component list.
jmx-scraper/​README.md Updates references to the former Gatherer.
jmx-metrics/​src/​test/​resources/​jmxremote.password Deletes authentication test fixture.
jmx-metrics/​src/​test/​resources/​all.properties Deletes configuration test fixture.
jmx-metrics/​src/​test/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​OtelHelperJmxTest.java Deletes JMX helper tests.
jmx-metrics/​src/​test/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​MBeanHelperTest.java Deletes MBean helper tests.
jmx-metrics/​src/​test/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​JmxConfigTest.java Deletes configuration tests.
jmx-metrics/​src/​test/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​GroovyRunnerTest.java Deletes script runner tests.
jmx-metrics/​src/​main/​resources/​target-systems/​wildfly.groovy Deletes WildFly metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​tomcat.groovy Deletes Tomcat metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​solr.groovy Deletes Solr metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​kafka.groovy Deletes Kafka broker metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​kafka-producer.groovy Deletes Kafka producer metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​kafka-consumer.groovy Deletes Kafka consumer metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​jvm.groovy Deletes JVM metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​jetty.groovy Deletes Jetty metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​hadoop.groovy Deletes Hadoop metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​cassandra.groovy Deletes Cassandra metric definitions.
jmx-metrics/​src/​main/​resources/​target-systems/​activemq.groovy Deletes ActiveMQ metric definitions.
jmx-metrics/​src/​main/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​InstrumentDescriptor.java Deletes instrument metadata class.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​OtelHelper.groovy Deletes metric scripting helper.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​MBeanHelper.groovy Deletes MBean access helper.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​JmxMetrics.java Deletes Gatherer entry point and scheduler.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​JmxConnectorHelper.java Deletes JMX connection helper.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​JmxConfig.java Deletes Gatherer configuration handling.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​JmxClient.java Deletes Gatherer JMX client.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​InstrumentHelper.groovy Deletes metric recording helper.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​GroovyRunner.java Deletes Groovy script execution.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​ConfigurationException.java Deletes configuration exception class.
jmx-metrics/​src/​main/​groovy/​io/​opentelemetry/​contrib/​jmxmetrics/​ClientCallbackHandler.java Deletes authentication callback handler.
jmx-metrics/​src/​integrationTest/​resources/​wildfly/​start.sh Deletes WildFly test startup script.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​wildfly.properties Deletes WildFly test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​tomcat.properties Deletes Tomcat test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​solr.properties Deletes Solr test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​kafka.properties Deletes Kafka test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​kafka-producer.sh Deletes Kafka test producer script.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​kafka-producer.properties Deletes producer test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​kafka-consumer.properties Deletes consumer test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​jvm.properties Deletes JVM test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​jvm-and-kafka.properties Deletes combined-target test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​jetty.properties Deletes Jetty test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​hbase.properties Deletes HBase test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​hadoop.properties Deletes Hadoop test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​cassandra.properties Deletes Cassandra test configuration.
jmx-metrics/​src/​integrationTest/​resources/​target-systems/​activemq.properties Deletes ActiveMQ test configuration.
jmx-metrics/​src/​integrationTest/​resources/​script.groovy Deletes custom metric test script.
jmx-metrics/​src/​integrationTest/​resources/​otlp_config.properties Deletes OTLP test configuration.
jmx-metrics/​src/​integrationTest/​resources/​hbase/​hbase-env.sh Deletes HBase test environment setup.
jmx-metrics/​src/​integrationTest/​resources/​hadoop/​yarn-site.xml Deletes Hadoop test resource settings.
jmx-metrics/​src/​integrationTest/​resources/​hadoop/​hadoop-env.sh Deletes Hadoop test environment setup.
jmx-metrics/​src/​integrationTest/​resources/​cassandra/​jmxremote.password Deletes Cassandra authentication fixture.
jmx-metrics/​src/​integrationTest/​resources/​activemq/​Dockerfile Deletes ActiveMQ test image definition.
jmx-metrics/​src/​integrationTest/​resources/​activemq/​config/​env Deletes ActiveMQ test environment setup.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​WildflyIntegrationTest.java Deletes WildFly integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​TomcatIntegrationTest.java Deletes Tomcat integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​SolrIntegrationTest.java Deletes Solr integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​JvmTargetSystemIntegrationTest.java Deletes JVM integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​JettyIntegrationTest.java Deletes Jetty integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​HbaseIntegrationTest.java Deletes HBase integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​HadoopIntegrationTest.java Deletes Hadoop integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​CassandraIntegrationTest.java Deletes Cassandra integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​target_systems/​ActivemqIntegrationTest.java Deletes ActiveMQ integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​OtlpIntegrationTest.java Deletes OTLP export integration tests.
jmx-metrics/​src/​integrationTest/​java/​io/​opentelemetry/​contrib/​jmxmetrics/​AbstractIntegrationTest.java Deletes shared integration test infrastructure.
jmx-metrics/​docs/​target-systems/​wildfly.md Deletes Gatherer WildFly metric reference.
jmx-metrics/​docs/​target-systems/​tomcat.md Deletes Gatherer Tomcat metric reference.
jmx-metrics/​docs/​target-systems/​solr.md Deletes Gatherer Solr metric reference.
jmx-metrics/​docs/​target-systems/​kafka.md Deletes Gatherer Kafka metric reference.
jmx-metrics/​docs/​target-systems/​kafka-producer.md Deletes Gatherer producer metric reference.
jmx-metrics/​docs/​target-systems/​kafka-consumer.md Deletes Gatherer consumer metric reference.
jmx-metrics/​docs/​target-systems/​jvm.md Deletes Gatherer JVM metric reference.
jmx-metrics/​docs/​target-systems/​jetty.md Deletes Gatherer Jetty metric reference.
jmx-metrics/​docs/​target-systems/​hbase.md Deletes Gatherer HBase metric reference.
jmx-metrics/​docs/​target-systems/​hadoop.md Deletes Gatherer Hadoop metric reference.
jmx-metrics/​docs/​target-systems/​cassandra.md Deletes Gatherer Cassandra metric reference.
jmx-metrics/​docs/​target-systems/​activemq.md Deletes Gatherer ActiveMQ metric reference.
jmx-metrics/​build.gradle.kts Deletes Gatherer build and publishing configuration.
.github/​workflows/​release.yml Removes Gatherer release artifact handling.
.github/​scripts/​draft-change-log-entries.sh Removes Gatherer changelog component mapping.
.github/​ISSUE_TEMPLATE/​feature_request.yml Removes Gatherer from feature request options.
.github/​ISSUE_TEMPLATE/​bug_report.yml Removes Gatherer from bug report options.
.github/​component_owners.yml Removes Gatherer ownership entry.

Review effort: Balanced

@SylvainJuge SylvainJuge self-assigned this Nov 9, 2026

@robsunday robsunday left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup. Giving approval with one small comment

Comment thread jmx-scraper/README.md Resolved

@breedx-splk breedx-splk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hell yeah we're really doing this! Thanks for all the work getting us here y'all!

@breedx-splk
breedx-splk added this pull request to the merge queue Nov 18, 2026
Merged via the queue into open-telemetry:main with commit 1f49e92 Nov 18, 2026
26 checks passed
@SylvainJuge
SylvainJuge deleted the remove-jmx-gatherer branch November 19, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

7 participants