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
e0ee7c7f
Commit
e0ee7c7f
authored
Jul 20, 2015
by
izeye
Committed by
Andy Wilkinson
Aug 04, 2015
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Polish documentation for actuator-docs
Closes gh-3564
parent
bf0b8573
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
25 additions
and
25 deletions
+25
-25
autoconfig.adoc
spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc
+3
-3
beans.adoc
spring-boot-actuator-docs/src/main/asciidoc/beans.adoc
+1
-1
dump.adoc
spring-boot-actuator-docs/src/main/asciidoc/dump.adoc
+2
-2
index.adoc
spring-boot-actuator-docs/src/main/asciidoc/index.adoc
+5
-5
trace.adoc
spring-boot-actuator-docs/src/main/asciidoc/trace.adoc
+1
-1
appendix-application-properties.adoc
...cs/src/main/asciidoc/appendix-application-properties.adoc
+13
-13
No files found.
spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc
View file @
e0ee7c7f
...
...
@@ -3,14 +3,14 @@ This endpoint is a report on the Spring Boot auto-configuration process that hap
your application started up. It lists all the `@Conditional` annotations that were
evaluated as the context started and in each case it gives an indication of if (and why)
the condition matched. A positive match results in a bean being included in the context,
and a negative result means the opposite (the bean
s
's class may not even be loaded).
and a negative result means the opposite (the bean's class may not even be loaded).
The report is split into 2 parts, positive matches first, and then negative. If the
context is a hierarchy, there is also a separate report on the parent context with the
same format (and recursively up to the top of the hierarchy).
NOTE:
t
he report is actually about `@Conditional` evaluation not auto-configuration
per se, but most autoconfiguration features use `@Conditional` heavily, so there is a lot
NOTE:
T
he report is actually about `@Conditional` evaluation not auto-configuration
per se, but most auto
-
configuration features use `@Conditional` heavily, so there is a lot
of overlap.
Example curl request:
...
...
spring-boot-actuator-docs/src/main/asciidoc/beans.adoc
View file @
e0ee7c7f
...
...
@@ -2,7 +2,7 @@
This endpoint is a report on the Spring Boot `ApplicationContext`. It lists the beans in
the context and their dependencies, detailing the names and concrete classes of each bean.
NOTE:
s
ome beans are pure configuration (any class that is annotated `@Configuration`).
NOTE:
S
ome beans are pure configuration (any class that is annotated `@Configuration`).
Example curl request:
include::{generated}/beans/curl-request.adoc[]
...
...
spring-boot-actuator-docs/src/main/asciidoc/dump.adoc
View file @
e0ee7c7f
=== Link: dump
This endpoint is a thread dump: the result is a list of threads each with their name,
monitor state and stack. It is the same information as you would get from `kill -3` of a
running Java process.
C
an be very useful for detecting issues at runtime, especially
running Java process.
It c
an be very useful for detecting issues at runtime, especially
sluggish behaviour caused by threads blocked by slow or unavailable I/O (e.g. if a
connection pool is exhausted).
NOTE:
s
ome `SecurityManager` implementations might prevent this endpoint from working.
NOTE:
S
ome `SecurityManager` implementations might prevent this endpoint from working.
Example curl request:
include::{generated}/dump/curl-request.adoc[]
...
...
spring-boot-actuator-docs/src/main/asciidoc/index.adoc
View file @
e0ee7c7f
...
...
@@ -100,7 +100,7 @@ For example in Maven:
----
or in Gradle
or in Gradle
:
[source,groovy,indent=0]
----
...
...
@@ -111,7 +111,7 @@ or in Gradle
}
----
NOTE:
i
f you are using Spring Data REST, then a dependency on the
NOTE:
I
f you are using Spring Data REST, then a dependency on the
`spring-data-rest-hal-browser` will have an equivalent effect.
If you do that then a new endpoint will appear at `/` or `/hal` (relative to the
...
...
@@ -139,17 +139,17 @@ For example in Maven:
----
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-
hypermedia
-docs</artifactId>
<artifactId>spring-boot-
actuator
-docs</artifactId>
</dependency>
----
or in Gradle
or in Gradle
:
[source,groovy,indent=0]
----
dependencies {
...
compile('org.springframework.boot:spring-boot-
hypermedia
-docs')
compile('org.springframework.boot:spring-boot-
actuator
-docs')
...
}
----
...
...
spring-boot-actuator-docs/src/main/asciidoc/trace.adoc
View file @
e0ee7c7f
=== Link: trace
This endpoint lists contents of the `TraceRepository` (which users can override by
providing a bean of that type, or by injecting that bean and adding stuff to it). By
default it
i
s the last 100 HTTP requests, including all headers in the request and
default it
store
s the last 100 HTTP requests, including all headers in the request and
response, and the path and HTTP status.
Example curl request:
...
...
spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc
View file @
e0ee7c7f
...
...
@@ -692,19 +692,19 @@ content into your application; rather pick only the properties that you need.
endpoints.docs.curies.enabled=false
endpoints.docs.enabled=true
endpoints.docs.path=/docs
endpoints.docs.sensitive=false
endpoints.flyway.enabled=true
endpoints.flyway.id=flyway
endpoints.flyway.sensitive=true
endpoints.hal.enabled=true
endpoints.hal.path= # Redirects root HTML traffic to the HAL browser
endpoints.hal.sensitive=false
endpoints.links.enabled=true
endpoints.links.path= # / if not already used, /links instead
endpoints.links.sensitive=false
endpoints.liquibase.enabled=true
endpoints.liquibase.id=liquibase
endpoints.liquibase.sensitive=false
endpoints.docs.sensitive=false
endpoints.flyway.enabled=true
endpoints.flyway.id=flyway
endpoints.flyway.sensitive=true
endpoints.hal.enabled=true
endpoints.hal.path= # Redirects root HTML traffic to the HAL browser
endpoints.hal.sensitive=false
endpoints.links.enabled=true
endpoints.links.path= # / if not already used, /links instead
endpoints.links.sensitive=false
endpoints.liquibase.enabled=true
endpoints.liquibase.id=liquibase
endpoints.liquibase.sensitive=false
# ENDPOINTS CORS CONFIGURATION ({sc-spring-boot-actuator}/autoconfigure/MvcEndpointCorsProperties.{sc-ext}[MvcEndpointCorsProperties])
endpoints.cors.allow-credentials= # set whether user credentials are support. When not set, credentials are not supported.
...
...
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