Deprecate JMX support.

christophstrobl · mp911de · commit 0054952230be · 2025-04-09T11:04:57.000+02:00
Original pull request: #4936 Closes #4927
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoJmxParser.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoJmxParser.java
@@ -32,7 +32,9 @@
  * @author John Brisbin
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 public class MongoJmxParser implements BeanDefinitionParser {
 
 	public BeanDefinition parse(Element element, ParserContext parserContext) {
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAdmin.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAdmin.java
@@ -30,7 +30,9 @@
  * @author Thomas Darimont
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Mongo Admin Operations")
 public class MongoAdmin implements MongoAdminOperations {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAdminOperations.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAdminOperations.java
@@ -21,6 +21,7 @@
  * @author Mark Pollack
  * @author Oliver Gierke
  */
+@Deprecated(since = "4.5", forRemoval = true)
 public interface MongoAdminOperations {
 
 	@ManagedOperation
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/AbstractMonitor.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/AbstractMonitor.java
@@ -31,7 +31,9 @@
  * @author Mark Pollack
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 public abstract class AbstractMonitor {
 
 	private final MongoClient mongoClient;
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/AssertMetrics.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/AssertMetrics.java
@@ -26,7 +26,9 @@
  * JMX Metrics for assertions
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Assertion Metrics")
 public class AssertMetrics extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/BackgroundFlushingMetrics.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/BackgroundFlushingMetrics.java
@@ -28,7 +28,9 @@
  * JMX Metrics for Background Flushing
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Background Flushing Metrics")
 public class BackgroundFlushingMetrics extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/BtreeIndexCounters.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/BtreeIndexCounters.java
@@ -26,7 +26,9 @@
  * JMX Metrics for B-tree index counters
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Btree Metrics")
 public class BtreeIndexCounters extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/ConnectionMetrics.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/ConnectionMetrics.java
@@ -26,7 +26,9 @@
  * JMX Metrics for Connections
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Connection metrics")
 public class ConnectionMetrics extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/GlobalLockMetrics.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/GlobalLockMetrics.java
@@ -27,7 +27,9 @@
  * JMX Metrics for Global Locks
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Global Lock Metrics")
 public class GlobalLockMetrics extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/MemoryMetrics.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/MemoryMetrics.java
@@ -26,7 +26,9 @@
  * JMX Metrics for Memory
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Memory Metrics")
 public class MemoryMetrics extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/OperationCounters.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/OperationCounters.java
@@ -27,7 +27,9 @@
  * JMX Metrics for Operation counters
  *
  * @author Mark Pollack
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Operation Counters")
 public class OperationCounters extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/ServerInfo.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/ServerInfo.java
@@ -31,7 +31,9 @@
  * @author Mark Pollack
  * @author Thomas Darimont
  * @author Christoph Strobl
+ * @deprecated since 4.5
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @ManagedResource(description = "Server Information")
 public class ServerInfo extends AbstractMonitor {
 
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/package-info.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/monitor/package-info.java
@@ -1,6 +1,7 @@
 /**
  * MongoDB specific JMX monitoring support.
  */
+@Deprecated(since = "4.5", forRemoval = true)
 @org.springframework.lang.NonNullApi
 package org.springframework.data.mongodb.monitor;
 
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/JmxServer.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/JmxServer.java
@@ -22,7 +22,9 @@
  *
  * @author Mark Pollack
  * @author Oliver Gierke
+ * @deprecated since 4.5.
  */
+@Deprecated(since = "4.5", forRemoval = true)
 public class JmxServer {
 
 	public static void main(String[] args) {
diff --git a/src/main/antora/modules/ROOT/pages/mongodb/jmx.adoc b/src/main/antora/modules/ROOT/pages/mongodb/jmx.adoc
@@ -1,6 +1,12 @@
 [[mongo.jmx]]
 = JMX support
 
+[NOTE]
+====
+JMX support has been deprecated in 4.5 and will be removed in 5.0. +
+We recommend switching to Spring Boot https://docs.spring.io/spring-boot/reference/actuator/endpoints.html[Actuator Endpoints] and expose those over JMX if needed.
+====
+
 The JMX support for MongoDB exposes the results of running the 'serverStatus' command on the admin database for a single MongoDB server instance. It also exposes an administrative MBean, `MongoAdmin`, that lets you perform administrative operations, such as dropping or creating a database. The JMX features build upon the JMX feature set available in the Spring Framework. See link:{springDocsUrl}/integration.html#jmx[here] for more details.
 
 [[mongodb:jmx-configuration]]

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,9 @@`
`26`	`26`	`* JMX Metrics for assertions`
`27`	`27`	`*`
`28`	`28`	`* @author Mark Pollack`
	`29`	`+ * @deprecated since 4.5`
`29`	`30`	`*/`
	`31`	`+@Deprecated(since = "4.5", forRemoval = true)`
`30`	`32`	`@ManagedResource(description = "Assertion Metrics")`
`31`	`33`	`public class AssertMetrics extends AbstractMonitor {`
`32`	`34`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@`
`28`	`28`	`* JMX Metrics for Background Flushing`
`29`	`29`	`*`
`30`	`30`	`* @author Mark Pollack`
	`31`	`+ * @deprecated since 4.5`
`31`	`32`	`*/`
	`33`	`+@Deprecated(since = "4.5", forRemoval = true)`
`32`	`34`	`@ManagedResource(description = "Background Flushing Metrics")`
`33`	`35`	`public class BackgroundFlushingMetrics extends AbstractMonitor {`
`34`	`36`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,9 @@`
`27`	`27`	`* JMX Metrics for Global Locks`
`28`	`28`	`*`
`29`	`29`	`* @author Mark Pollack`
	`30`	`+ * @deprecated since 4.5`
`30`	`31`	`*/`
	`32`	`+@Deprecated(since = "4.5", forRemoval = true)`
`31`	`33`	`@ManagedResource(description = "Global Lock Metrics")`
`32`	`34`	`public class GlobalLockMetrics extends AbstractMonitor {`
`33`	`35`