Skip to content

Commit fc61f2e

Browse files
committed
Improve documentation for JMX related keys
Closes gh-2747
1 parent 51e6eda commit fc61f2e

File tree

4 files changed

+22
-2
lines changed

4 files changed

+22
-2
lines changed

spring-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@
1717
"sourceType": "org.springframework.boot.actuate.endpoint.EnvironmentEndpoint",
1818
"description": "Keys that should be sanitized. Keys can be simple strings that the property ends with or regex expressions."
1919
},
20+
{
21+
"name": "endpoints.jmx.enabled",
22+
"type": "java.lang.Boolean",
23+
"description": "Enable JMX export of all endpoints.",
24+
"defaultValue": true
25+
},
2026
{
2127
"name": "info",
2228
"type": "java.util.Map<java.lang.String,java.lang.Object>",

spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,23 @@
7575
"type": "java.lang.Boolean",
7676
"description": "Enable gzip filter support."
7777
},
78+
{
79+
"name": "spring.jmx.default-domain",
80+
"type": "java.lang.String",
81+
"description": "JMX domain name."
82+
},
7883
{
7984
"name": "spring.jmx.enabled",
8085
"type": "java.lang.Boolean",
8186
"description": "Expose management beans to the JMX domain.",
8287
"defaultValue": true
8388
},
89+
{
90+
"name": "spring.jmx.mbean-server",
91+
"type": "java.lang.String",
92+
"description": "MBeanServer bean name.",
93+
"defaultValue": "mBeanServer"
94+
},
8495
{
8596
"name": "spring.jpa.open-in-view",
8697
"type": "java.lang.Boolean",

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,9 @@ content into your application; rather pick only the properties that you need.
425425
liquibase.password= # password for liquibase.url
426426
427427
# JMX
428+
spring.jmx.default-domain= # JMX domain name
428429
spring.jmx.enabled=true # Expose MBeans from Spring
430+
spring.jmx.mbean-server=mBeanServer # MBeanServer bean name
429431
430432
# RABBIT ({sc-spring-boot-autoconfigure}/amqp/RabbitProperties.{sc-ext}[RabbitProperties])
431433
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.
577579
endpoints.info.id=info
578580
endpoints.info.sensitive=false
579581
endpoints.info.enabled=true
582+
endpoints.jmx.enabled=true # enable JMX export of all endpoints
580583
endpoints.mappings.enabled=true
581584
endpoints.mappings.id=mappings
582585
endpoints.mappings.sensitive=true

spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -544,12 +544,12 @@ example `application.properties`:
544544

545545
[[production-ready-disable-jmx-endpoints]]
546546
=== Disabling JMX endpoints
547-
If you don't want to expose endpoints over JMX you can set the `spring.jmx.enabled`
547+
If you don't want to expose endpoints over JMX you can set the `endpoints.jmx.enabled`
548548
property to `false`:
549549

550550
[source,properties,indent=0]
551551
----
552-
spring.jmx.enabled=false
552+
endpoints.jmx.enabled=false
553553
----
554554

555555

0 commit comments

Comments
 (0)