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
c7cac927
Commit
c7cac927
authored
Nov 12, 2017
by
Andy Wilkinson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Bring spring-boot-actuator's README up to date
Closes gh-10686
parent
00f41a90
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
17 deletions
+10
-17
README.adoc
spring-boot-project/spring-boot-actuator/README.adoc
+10
-17
No files found.
spring-boot-project/spring-boot-actuator/README.adoc
View file @
c7cac927
...
@@ -2,16 +2,15 @@
...
@@ -2,16 +2,15 @@
Spring Boot Actuator includes a number of additional features to help you monitor and
Spring Boot Actuator includes a number of additional features to help you monitor and
manage your application when it's pushed to production. You can choose to manage and
manage your application when it's pushed to production. You can choose to manage and
monitor your application using HTTP endpoints, with JMX or even by remote shell (SSH or
monitor your application using HTTP or JMX endpoints. Auditing, health and metrics
Telnet). Auditing, health and metrics gathering can be automatically applied to your
gathering can be automatically applied to your application. The
application. The
http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide]
http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide]
covers the features in more detail.
covers the features in more detail.
== Enabling the Actuator
== Enabling the Actuator
The simplest way to enable the features is to add a dependency to the
The simplest way to enable the features is to add a dependency to the
`spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven
based
`spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven
-based project,
project,
add the following '`Starter`' dependency:
add the following '`Starter`' dependency:
[source,xml,indent=0]
[source,xml,indent=0]
----
----
...
@@ -23,7 +22,7 @@ project, add the following '`Starter`' dependency:
...
@@ -23,7 +22,7 @@ project, add the following '`Starter`' dependency:
</dependencies>
</dependencies>
----
----
For Gradle, use the declaration:
For Gradle, use the
following
declaration:
[indent=0]
[indent=0]
----
----
...
@@ -35,17 +34,11 @@ For Gradle, use the declaration:
...
@@ -35,17 +34,11 @@ For Gradle, use the declaration:
== Features
== Features
* **Endpoints** Actuator endpoints allow you to monitor and interact with your
* **Endpoints** Actuator endpoints allow you to monitor and interact with your
application. Spring Boot includes a number of built-in endpoints and you can also add
application. Spring Boot includes a number of built-in endpoints and you can also add
your own. For example the `health` endpoint provides basic application health
your own. For example the `status` endpoint provides basic application health
information. Run up a basic application and look at `/health` (and see `/mappings` for
information. Run up a basic application and look at `/status`.
a list of other HTTP endpoints).
* **Metrics** Spring Boot Actuator provides dimensional metrics by integrating with
* **Metrics** Spring Boot Actuator includes a metrics service with "`gauge`" and
https://micrometer.io[Micrometer].
"`counter`" support. A "`gauge`" records a single value; and a "`counter`" records a
delta (an increment or decrement). Metrics for all HTTP requests are automatically
recorded, so if you hit the `metrics` endpoint should see a sensible response.
* **Audit** Spring Boot Actuator has a flexible audit framework that will publish events
* **Audit** Spring Boot Actuator has a flexible audit framework that will publish events
to an `AuditEventRepository`. Once Spring Security is in play it automatically publishes
to an `AuditEventRepository`. Once Spring Security is in play it automatically publishes
authentication events by default. This can be very useful for reporting, and also to
authentication events by default. This can be very useful for reporting, and also to
implement a lock-out policy based on authentication failures.
implement a lock-out policy based on authentication failures.
* **Process Monitoring** In Spring Boot Actuator you can find `ApplicationPidFileWriter`
\ No newline at end of file
which creates a file containing the application PID (by default in the application
directory with a file name of `application.pid`).
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