Skip to content

Commit e6957ec

Browse files
committed
Merge branch '2.3.x'
Closes gh-22697
2 parents 6c67c5d + 4aa010c commit e6957ec

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

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

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -649,81 +649,95 @@ TIP: The `HealthContributorRegistry` can be used to register and unregister heal
649649

650650
[[production-ready-health-indicators]]
651651
==== Auto-configured HealthIndicators
652-
The following `HealthIndicators` are auto-configured by Spring Boot when appropriate:
652+
The following `HealthIndicators` are auto-configured by Spring Boot when appropriate.
653+
You can also enable/disable selected indicators by configuring `management.health.key.enabled`,
654+
with the `key` listed in the table below.
653655

654-
[cols="4,6"]
656+
[cols="2,4,6"]
655657
|===
656-
| Name | Description
658+
| Key | Name | Description
657659

660+
=======
661+
| `cassandra`
658662
| {spring-boot-actuator-module-code}/cassandra/CassandraHealthIndicator.java[`CassandraHealthIndicator`] or {spring-boot-actuator-module-code}/cassandra/CassandraDriverHealthIndicator.java[`CassandraDriverHealthIndicator`]
659663
| Checks that a Cassandra database is up.
660664
665+
| `couchbase`
661666
| {spring-boot-actuator-module-code}/couchbase/CouchbaseHealthIndicator.java[`CouchbaseHealthIndicator`]
662667
| Checks that a Couchbase cluster is up.
663668
669+
| `datasource`
664670
| {spring-boot-actuator-module-code}/jdbc/DataSourceHealthIndicator.java[`DataSourceHealthIndicator`]
665671
| Checks that a connection to `DataSource` can be obtained.
666672
673+
| `diskspace`
667674
| {spring-boot-actuator-module-code}/system/DiskSpaceHealthIndicator.java[`DiskSpaceHealthIndicator`]
668675
| Checks for low disk space.
669676
677+
| `elasticsearch`
670678
| {spring-boot-actuator-module-code}/elasticsearch/ElasticsearchRestHealthIndicator.java[`ElasticsearchRestHealthIndicator`]
671679
| Checks that an Elasticsearch cluster is up.
672680
681+
| `hazelcast`
673682
| {spring-boot-actuator-module-code}/hazelcast/HazelcastHealthIndicator.java[`HazelcastHealthIndicator`]
674683
| Checks that a Hazelcast server is up.
675684
685+
| `influxdb`
676686
| {spring-boot-actuator-module-code}/influx/InfluxDbHealthIndicator.java[`InfluxDbHealthIndicator`]
677687
| Checks that an InfluxDB server is up.
678688
689+
| `jms`
679690
| {spring-boot-actuator-module-code}/jms/JmsHealthIndicator.java[`JmsHealthIndicator`]
680691
| Checks that a JMS broker is up.
681692
693+
| `ldap`
682694
| {spring-boot-actuator-module-code}/ldap/LdapHealthIndicator.java[`LdapHealthIndicator`]
683695
| Checks that an LDAP server is up.
684696
685-
| {spring-boot-actuator-module-code}/availability/LivenessStateHealthIndicator.java[`LivenessStateHealthIndicator`]
686-
| Exposes the "Liveness" application availability state.
687-
697+
| `mail`
688698
| {spring-boot-actuator-module-code}/mail/MailHealthIndicator.java[`MailHealthIndicator`]
689699
| Checks that a mail server is up.
690700
701+
| `mongo`
691702
| {spring-boot-actuator-module-code}/mongo/MongoHealthIndicator.java[`MongoHealthIndicator`]
692703
| Checks that a Mongo database is up.
693704
705+
| `neo4j`
694706
| {spring-boot-actuator-module-code}/neo4j/Neo4jHealthIndicator.java[`Neo4jHealthIndicator`]
695707
| Checks that a Neo4j database is up.
696708
709+
| `ping`
697710
| {spring-boot-actuator-module-code}/health/PingHealthIndicator.java[`PingHealthIndicator`]
698711
| Always responds with `UP`.
699712
713+
| `rabbit`
700714
| {spring-boot-actuator-module-code}/amqp/RabbitHealthIndicator.java[`RabbitHealthIndicator`]
701715
| Checks that a Rabbit server is up.
702716
703-
| {spring-boot-actuator-module-code}/availability/ReadinessStateHealthIndicator.java[`ReadinessStateHealthIndicator`]
704-
| Exposes the "Readiness" application availability state.
705-
717+
| `redis`
706718
| {spring-boot-actuator-module-code}/redis/RedisHealthIndicator.java[`RedisHealthIndicator`]
707719
| Checks that a Redis server is up.
708720
721+
| `solr`
709722
| {spring-boot-actuator-module-code}/solr/SolrHealthIndicator.java[`SolrHealthIndicator`]
710723
| Checks that a Solr server is up.
711724
|===
712725
713726
TIP: You can disable them all by setting the configprop:management.health.defaults.enabled[] property.
714727
715-
Additional `HealthIndicators` are available but not enabled by default;
716-
developers can use their configuration property to activate them:
728+
Additional `HealthIndicators` are available but not enabled by default:
717729
718-
[cols="4,6"]
730+
[cols="3,4,6"]
719731
|===
720-
| Name | Description
732+
| Key | Name | Description
721733
734+
| `livenessstate`
722735
| {spring-boot-actuator-module-code}/availability/LivenessStateHealthIndicator.java[`LivenessStateHealthIndicator`]
723-
| Checks the liveness state of the application.
736+
| Exposes the "Liveness" application availability state.
724737
738+
| `readinessstate`
725739
| {spring-boot-actuator-module-code}/availability/ReadinessStateHealthIndicator.java[`ReadinessStateHealthIndicator`]
726-
| Checks the readiness state of the application.
740+
| Exposes the "Readiness" application availability state.
727741
|===
728742
729743

0 commit comments

Comments
 (0)