Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
2de906ca
Commit
2de906ca
authored
Jun 08, 2020
by
Andy Wilkinson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Polish "Clarify loss of defaults when adding custom mapping"
See gh-20716
parent
9f009e44
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
6 deletions
+9
-6
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+9
-6
No files found.
spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
2de906ca
...
@@ -751,18 +751,21 @@ To configure the severity order, add the following property to your application
...
@@ -751,18 +751,21 @@ To configure the severity order, add the following property to your application
management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up
management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up
----
----
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).
The HTTP status code in the response reflects the overall health status.
By default, `OUT_OF_SERVICE` and `DOWN` map to 503.
Any unmapped health statuses, including `UP`, map to 200.
You might also want to register custom status mappings if you access the health endpoint over HTTP.
You might also want to register custom status mappings if you access the health endpoint over HTTP.
For example, the following property maps `FATAL` to 503 (service unavailable):
Configuring a custom mapping disables the defaults mappings for `DOWN` and `OUT_OF_SERVICE`.
If you want to retain the default mappings they must be configured explicitly alongside any custom mappings.
For example, the following property maps `FATAL` to 503 (service unavailable) and retains the default mappings for `DOWN` and `OUT_OF_SERVICE`:
[source,properties,indent=0,configprops]
[source,properties,indent=0,configprops]
----
----
management.endpoint.health.status.http-mapping.down=503
management.endpoint.health.status.http-mapping.fatal=503
management.endpoint.health.status.http-mapping.fatal=503
management.endpoint.health.status.http-mapping.out-of-service=503
----
----
WARNING: A custom status mapping replaces whole of the default status mappings.
That means the above example has only one mapping to `FATAL` and any other statuses will return the http status 200 as `UNKNOWN` health status.
TIP: If you need more control, you can define your own `HttpCodeStatusMapper` bean.
TIP: If you need more control, you can define your own `HttpCodeStatusMapper` bean.
The following table shows the default status mappings for the built-in statuses:
The following table shows the default status mappings for the built-in statuses:
...
@@ -864,7 +867,7 @@ It's also possible to override the `show-details` and `roles` properties if requ
...
@@ -864,7 +867,7 @@ It's also possible to override the `show-details` and `roles` properties if requ
management.endpoint.health.group.custom.roles=admin
management.endpoint.health.group.custom.roles=admin
management.endpoint.health.group.custom.status.order=fatal,up
management.endpoint.health.group.custom.status.order=fatal,up
management.endpoint.health.group.custom.status.http-mapping.fatal=500
management.endpoint.health.group.custom.status.http-mapping.fatal=500
management.endpoint.health.group.custom.status.http-mapping.out-of-service=500
----
----
TIP: You can use `@Qualifier("groupname")` if you need to register custom `StatusAggregator` or `HttpCodeStatusMapper` beans for use with the group.
TIP: You can use `@Qualifier("groupname")` if you need to register custom `StatusAggregator` or `HttpCodeStatusMapper` beans for use with the group.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment