Improve documentation for JMX related keys

Closes spring-projectsgh-2747
Eviradnus · May 27, 2015 · fc61f2e · fc61f2e
1 parent 51e6eda
commit fc61f2e
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/...g-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...g-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -17,6 +17,12 @@
     "sourceType": "org.springframework.boot.actuate.endpoint.EnvironmentEndpoint",
     "description": "Keys that should be sanitized. Keys can be simple strings that the property ends with or regex expressions."
   },
+  {
+    "name": "endpoints.jmx.enabled",
+    "type": "java.lang.Boolean",
+    "description": "Enable JMX export of all endpoints.",
+    "defaultValue": true
+  },
   {
     "name": "info",
     "type": "java.util.Map<java.lang.String,java.lang.Object>",

diff --git a/...t-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...t-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -75,12 +75,23 @@
   	"type": "java.lang.Boolean",
   	"description": "Enable gzip filter support."
   },
+  {
+    "name": "spring.jmx.default-domain",
+    "type": "java.lang.String",
+    "description": "JMX domain name."
+  },
   {
     "name": "spring.jmx.enabled",
     "type": "java.lang.Boolean",
     "description": "Expose management beans to the JMX domain.",
     "defaultValue": true
   },
+  {
+    "name": "spring.jmx.mbean-server",
+    "type": "java.lang.String",
+    "description": "MBeanServer bean name.",
+    "defaultValue": "mBeanServer"
+  },
   {
     "name": "spring.jpa.open-in-view",
     "type": "java.lang.Boolean",

diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
@@ -425,7 +425,9 @@ content into your application; rather pick only the properties that you need.
 	liquibase.password= # password for liquibase.url
 
 	# JMX
+	spring.jmx.default-domain= # JMX domain name
 	spring.jmx.enabled=true # Expose MBeans from Spring
+	spring.jmx.mbean-server=mBeanServer # MBeanServer bean name
 
 	# RABBIT ({sc-spring-boot-autoconfigure}/amqp/RabbitProperties.{sc-ext}[RabbitProperties])
 	spring.rabbitmq.addresses= # connection addresses (e.g. myhost:9999,otherhost:1111)
@@ -577,6 +579,7 @@ content into your application; rather pick only the properties that you need.
 	endpoints.info.id=info
 	endpoints.info.sensitive=false
 	endpoints.info.enabled=true
+	endpoints.jmx.enabled=true # enable JMX export of all endpoints
 	endpoints.mappings.enabled=true
 	endpoints.mappings.id=mappings
 	endpoints.mappings.sensitive=true

diff --git a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
@@ -544,12 +544,12 @@ example `application.properties`:
 
 [[production-ready-disable-jmx-endpoints]]
 === Disabling JMX endpoints
-If you don't want to expose endpoints over JMX you can set the `spring.jmx.enabled`
+If you don't want to expose endpoints over JMX you can set the `endpoints.jmx.enabled`
 property to `false`:
 
 [source,properties,indent=0]
 ----
-	spring.jmx.enabled=false
+	endpoints.jmx.enabled=false
 ----