Commit fc61f2e8 authored by Stephane Nicoll's avatar Stephane Nicoll

Improve documentation for JMX related keys

Closes gh-2747
parent 51e6eda8
...@@ -17,6 +17,12 @@ ...@@ -17,6 +17,12 @@
"sourceType": "org.springframework.boot.actuate.endpoint.EnvironmentEndpoint", "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." "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", "name": "info",
"type": "java.util.Map<java.lang.String,java.lang.Object>", "type": "java.util.Map<java.lang.String,java.lang.Object>",
......
...@@ -75,12 +75,23 @@ ...@@ -75,12 +75,23 @@
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enable gzip filter support." "description": "Enable gzip filter support."
}, },
{
"name": "spring.jmx.default-domain",
"type": "java.lang.String",
"description": "JMX domain name."
},
{ {
"name": "spring.jmx.enabled", "name": "spring.jmx.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Expose management beans to the JMX domain.", "description": "Expose management beans to the JMX domain.",
"defaultValue": true "defaultValue": true
}, },
{
"name": "spring.jmx.mbean-server",
"type": "java.lang.String",
"description": "MBeanServer bean name.",
"defaultValue": "mBeanServer"
},
{ {
"name": "spring.jpa.open-in-view", "name": "spring.jpa.open-in-view",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
......
...@@ -425,7 +425,9 @@ content into your application; rather pick only the properties that you need. ...@@ -425,7 +425,9 @@ content into your application; rather pick only the properties that you need.
liquibase.password= # password for liquibase.url liquibase.password= # password for liquibase.url
# JMX # JMX
spring.jmx.default-domain= # JMX domain name
spring.jmx.enabled=true # Expose MBeans from Spring 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]) # RABBIT ({sc-spring-boot-autoconfigure}/amqp/RabbitProperties.{sc-ext}[RabbitProperties])
spring.rabbitmq.addresses= # connection addresses (e.g. myhost:9999,otherhost:1111) 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. ...@@ -577,6 +579,7 @@ content into your application; rather pick only the properties that you need.
endpoints.info.id=info endpoints.info.id=info
endpoints.info.sensitive=false endpoints.info.sensitive=false
endpoints.info.enabled=true endpoints.info.enabled=true
endpoints.jmx.enabled=true # enable JMX export of all endpoints
endpoints.mappings.enabled=true endpoints.mappings.enabled=true
endpoints.mappings.id=mappings endpoints.mappings.id=mappings
endpoints.mappings.sensitive=true endpoints.mappings.sensitive=true
......
...@@ -544,12 +544,12 @@ example `application.properties`: ...@@ -544,12 +544,12 @@ example `application.properties`:
[[production-ready-disable-jmx-endpoints]] [[production-ready-disable-jmx-endpoints]]
=== Disabling 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`: property to `false`:
[source,properties,indent=0] [source,properties,indent=0]
---- ----
spring.jmx.enabled=false endpoints.jmx.enabled=false
---- ----
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment