Commit 2583a534 authored by Phillip Webb's avatar Phillip Webb

Document heapdump endpoint

See gh-5670
parent 9f07e944
...@@ -62,7 +62,7 @@ The way that endpoints are exposed will depend on the type of technology that yo ...@@ -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 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`. 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"] [cols="2,5,1"]
|=== |===
...@@ -86,11 +86,6 @@ HATEOAS to be on the classpath. ...@@ -86,11 +86,6 @@ HATEOAS to be on the classpath.
|Displays a collated list of all `@ConfigurationProperties`. |Displays a collated list of all `@ConfigurationProperties`.
|true |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` |`dump`
|Performs a thread dump. |Performs a thread dump.
|true |true
...@@ -104,8 +99,9 @@ endpoints. Requires `spring-boot-actuator-docs` to be on the classpath. ...@@ -104,8 +99,9 @@ endpoints. Requires `spring-boot-actuator-docs` to be on the classpath.
|true |true
|`health` |`health`
|Shows application health information (when the application is secure, a simple '`status`' when accessed over an |Shows application health information (when the application is secure, a simple '`status`'
unauthenticated connection or full message details when authenticated). when accessed over an unauthenticated connection or full message details when
authenticated).
|false |false
|`info` |`info`
...@@ -116,12 +112,6 @@ unauthenticated connection or full message details when authenticated). ...@@ -116,12 +112,6 @@ unauthenticated connection or full message details when authenticated).
|Shows any Liquibase database migrations that have been applied. |Shows any Liquibase database migrations that have been applied.
|true |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` |`metrics`
|Shows '`metrics`' information for the current application. |Shows '`metrics`' information for the current application.
|true |true
...@@ -139,6 +129,32 @@ part of the log file's content. ...@@ -139,6 +129,32 @@ part of the log file's content.
|true |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 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 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). they are accessed over HTTP (or simply disabled if web security is not enabled).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment