Skip to content

Commit 13564b4

Browse files
committed
Merge pull request #20716 from norio-io
* gh-20716: Polish "Clarify loss of defaults when adding custom mapping" Clarify loss of defaults when adding custom mapping Closes gh-20716
2 parents 4a0e821 + 2de906c commit 13564b4

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -751,13 +751,19 @@ To configure the severity order, add the following property to your application
751751
management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up
752752
----
753753

754-
The HTTP status code in the response reflects the overall health status (for example, `UP` maps to 200, while `OUT_OF_SERVICE` and `DOWN` map to 503).
754+
The HTTP status code in the response reflects the overall health status.
755+
By default, `OUT_OF_SERVICE` and `DOWN` map to 503.
756+
Any unmapped health statuses, including `UP`, map to 200.
755757
You might also want to register custom status mappings if you access the health endpoint over HTTP.
756-
For example, the following property maps `FATAL` to 503 (service unavailable):
758+
Configuring a custom mapping disables the defaults mappings for `DOWN` and `OUT_OF_SERVICE`.
759+
If you want to retain the default mappings they must be configured explicitly alongside any custom mappings.
760+
For example, the following property maps `FATAL` to 503 (service unavailable) and retains the default mappings for `DOWN` and `OUT_OF_SERVICE`:
757761

758762
[source,properties,indent=0,configprops]
759763
----
764+
management.endpoint.health.status.http-mapping.down=503
760765
management.endpoint.health.status.http-mapping.fatal=503
766+
management.endpoint.health.status.http-mapping.out-of-service=503
761767
----
762768

763769
TIP: If you need more control, you can define your own `HttpCodeStatusMapper` bean.
@@ -861,7 +867,7 @@ It's also possible to override the `show-details` and `roles` properties if requ
861867
management.endpoint.health.group.custom.roles=admin
862868
management.endpoint.health.group.custom.status.order=fatal,up
863869
management.endpoint.health.group.custom.status.http-mapping.fatal=500
864-
870+
management.endpoint.health.group.custom.status.http-mapping.out-of-service=500
865871
----
866872

867873
TIP: You can use `@Qualifier("groupname")` if you need to register custom `StatusAggregator` or `HttpCodeStatusMapper` beans for use with the group.

0 commit comments

Comments
 (0)