mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-09-03 04:26:12 +08:00
fe7b13ec46
Closes gh-28619 Closes gh-28620 Closes gh-28621 Closes gh-28622 Closes gh-28623 Closes gh-28624 Closes gh-28625 Closes gh-28626 Closes gh-28627 Closes gh-28628 Closes gh-28629 Closes gh-28630 Closes gh-28631 Closes gh-28632 Closes gh-28633 Closes gh-28634 Closes gh-28635 Closes gh-28636 Closes gh-28638 Closes gh-28639 Closes gh-28640 Closes gh-28644 Closes gh-28645 Closes gh-28650 Closes gh-28711 Closes gh-28866 Closes gh-28867 Closes gh-28868 Closes gh-28872 See gh-28641 See gh-28642 See gh-28643 See gh-28646 See gh-28647 See gh-28648 See gh-28649 See gh-28721 See gh-28869 See gh-28871 |
||
|---|---|---|
| .. | ||
| src | ||
| build.gradle | ||
| README.adoc | ||
= Spring Boot - Actuator
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
monitor your application using HTTP or JMX endpoints. Auditing, health and metrics
gathering can be automatically applied to your application. The
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready[user guide]
covers the features in more detail.
== Enabling the Actuator
The recommended 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 project,
add the following '`Starter`' dependency:
[source,xml,indent=0]
----
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
----
For Gradle, use the following declaration:
[indent=0]
----
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-actuator'
}
----
== Features
* **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
your own. For example the `health` endpoint provides basic application health
information. Run up a basic application and look at `/actuator/health`.
* **Metrics** Spring Boot Actuator provides dimensional metrics by integrating with
https://micrometer.io[Micrometer].
* **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
authentication events by default. This can be very useful for reporting, and also to
implement a lock-out policy based on authentication failures.