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
d8d36255
Commit
d8d36255
authored
Apr 10, 2017
by
Stephane Nicoll
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch '1.4.x' into 1.5.x
parents
a9b5e7c1
caf30e3d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
62 additions
and
5 deletions
+62
-5
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+62
-5
No files found.
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
d8d36255
...
@@ -390,9 +390,15 @@ to your application properties:
...
@@ -390,9 +390,15 @@ to your application properties:
management
.
health
.
status
.
order
=
DOWN
,
OUT_OF_SERVICE
,
UNKNOWN
,
UP
management
.
health
.
status
.
order
=
DOWN
,
OUT_OF_SERVICE
,
UNKNOWN
,
UP
----
----
You
might
also
want
to
register
custom
status
mappings
with
the
`
HealthMvcEndpoint
`
The
HTTP
status
code
in
the
response
reflects
the
overall
health
status
(
e
.
g
.
`
UP
`
if
you
access
the
health
endpoint
over
HTTP
.
For
example
you
could
map
`
FATAL
`
to
maps
to
200
,
`
OUT_OF_SERVICE
`
or
`
DOWN
`
to
503
).
You
might
also
want
to
register
custom
`
HttpStatus
.
SERVICE_UNAVAILABLE
`.
status
mappings
with
the
`
HealthMvcEndpoint
`
if
you
access
the
health
endpoint
over
HTTP
.
For
example
,
the
following
maps
`
FATAL
`
to
`
HttpStatus
.
SERVICE_UNAVAILABLE
`:
[
source
,
properties
,
indent
=
0
]
----
endpoints
.
health
.
mappings
.
FATAL
=
503
----
...
@@ -705,9 +711,8 @@ If you don't want to expose endpoints over HTTP you can set the management port
...
@@ -705,9 +711,8 @@ If you don't want to expose endpoints over HTTP you can set the management port
----
----
[[production-ready-health-access-restrictions]]
[[production-ready-health-access-restrictions]]
=== HTTP health endpoint access restrictions
=== HTTP health endpoint
format and
access restrictions
The information exposed by the health endpoint varies depending on whether or not it'
s
The information exposed by the health endpoint varies depending on whether or not it'
s
accessed
anonymously
,
and
whether
or
not
the
enclosing
application
is
secure
.
accessed
anonymously
,
and
whether
or
not
the
enclosing
application
is
secure
.
By
default
,
when
accessed
anonymously
in
a
secure
application
,
any
details
about
the
By
default
,
when
accessed
anonymously
in
a
secure
application
,
any
details
about
the
...
@@ -717,6 +722,58 @@ endpoint being used in a denial of service attack. The `endpoints.health.time-to
...
@@ -717,6 +722,58 @@ endpoint being used in a denial of service attack. The `endpoints.health.time-to
property is used to configure the caching period in milliseconds. It defaults to 1000,
property is used to configure the caching period in milliseconds. It defaults to 1000,
i.e. one second.
i.e. one second.
Sample summarized HTTP response (default for anonymous request):
[source,indent=0]
----
$ curl -i localhost:8080/health
HTTP/1.1 200
X-Application-Context: application
Content-Type: application/vnd.spring-boot.actuator.v1+json;charset=UTF-8
Content-Length: 15
{"status":"UP"}
----
Sample summarized HTTP response for status "DOWN" (notice the 503 status code):
[source,indent=0]
----
$ curl -i localhost:8080/health
HTTP/1.1 503
X-Application-Context: application
Content-Type: application/vnd.spring-boot.actuator.v1+json;charset=UTF-8
Content-Length: 17
{"status":"DOWN"}
----
Sample detailed HTTP response:
[source,indent=0]
----
$ curl -i localhost:8080/health
HTTP/1.1 200 OK
X-Application-Context: application
Content-Type: application/vnd.spring-boot.actuator.v1+json;charset=UTF-8
Content-Length: 221
{
"status" : "UP",
"diskSpace" : {
"status" : "UP",
"total" : 63251804160,
"free" : 31316164608,
"threshold" : 10485760
},
"db" : {
"status" : "UP",
"database" : "H2",
"hello" : 1
}
}
----
The above-described restrictions can be enhanced, thereby allowing only authenticated
The above-described restrictions can be enhanced, thereby allowing only authenticated
users full access to the health endpoint in a secure application. To do so, set
users full access to the health endpoint in a secure application. To do so, set
`endpoints.health.sensitive` to `true`. Here'
s
a
summary
of
behavior
(
with
default
`endpoints.health.sensitive` to `true`. Here'
s
a
summary
of
behavior
(
with
default
...
...
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