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
2583a534
Commit
2583a534
authored
Jul 02, 2016
by
Phillip Webb
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Document heapdump endpoint
See gh-5670
parent
9f07e944
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
14 deletions
+30
-14
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+30
-14
No files found.
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
2583a534
...
...
@@ -62,7 +62,7 @@ The way that endpoints are exposed will depend on the type of technology that yo
Most
applications
choose
HTTP
monitoring
,
where
the
ID
of
the
endpoint
is
mapped
to
a
URL
.
For
example
,
by
default
,
the
`
health
`
endpoint
will
be
mapped
to
`/
health
`.
The
following
endpoints
are
available
:
The
following
technology
agnostic
endpoints
are
available
:
[
cols
=
"2,5,1"
]
|===
...
...
@@ -86,11 +86,6 @@ HATEOAS to be on the classpath.
|
Displays
a
collated
list
of
all
`@
ConfigurationProperties
`.
|
true
|`
docs
`
|
Displays
documentation
,
including
example
requests
and
responses
,
for
the
Actuator
's
endpoints. Requires `spring-boot-actuator-docs` to be on the classpath.
|false
|`
dump
`
|
Performs
a
thread
dump
.
|
true
...
...
@@ -104,8 +99,9 @@ endpoints. Requires `spring-boot-actuator-docs` to be on the classpath.
|true
|`health`
|
Shows
application
health
information
(
when
the
application
is
secure
,
a
simple
'`status`'
when
accessed
over
an
unauthenticated
connection
or
full
message
details
when
authenticated
).
|Shows application health information (when the application is secure, a simple '
`
status
`
'
when accessed over an unauthenticated connection or full message details when
authenticated).
|false
|`info`
...
...
@@ -116,12 +112,6 @@ unauthenticated connection or full message details when authenticated).
|Shows any Liquibase database migrations that have been applied.
|true
|`
logfile
`
|
Returns
the
contents
of
the
logfile
(
if
`
logging
.
file
`
or
`
logging
.
path
`
properties
have
been
set
).
Only
available
via
MVC
.
Supports
the
use
of
the
HTTP
`
Range
`
header
to
retrieve
part
of
the
log
file
's content.
|true
|`metrics`
|Shows '
`
metrics
`
' information for the current application.
|true
...
...
@@ -139,6 +129,32 @@ part of the log file's content.
|true
|===
If you are using Spring MVC, the following additional endpoints can also be used:
[cols="2,5,1"]
|===
| ID | Description | Sensitive Default
|`docs`
|Displays documentation, including example requests and responses, for the Actuator'
s
endpoints
.
Requires
`
spring
-
boot
-
actuator
-
docs
`
to
be
on
the
classpath
.
|
false
|`
heapdump
`
|
Returns
a
GZip
compressed
`
hprof
`
heap
dump
file
.
|
true
|`
jolokia
`
|
Exposes
JMX
beans
over
HTTP
(
when
Jolokia
is
on
the
classpath
).
|
true
|`
logfile
`
|
Returns
the
contents
of
the
logfile
(
if
`
logging
.
file
`
or
`
logging
.
path
`
properties
have
been
set
).
Supports
the
use
of
the
HTTP
`
Range
`
header
to
retrieve
part
of
the
log
file
's
content.
|true
|===
NOTE: Depending on how an endpoint is exposed, the `sensitive` property may be used as
a security hint. For example, sensitive endpoints will require a username/password when
they are accessed over HTTP (or simply disabled if web security is not enabled).
...
...
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