mirror of
https://github.com/spring-projects/spring-boot.git
synced 2026-09-27 12:39:03 +00:00
Andy Wilkinson
6d98851fb5
Previously, Couchbase's health was determined by retrieving the bucket info from the cluster info. This retrieval could take over one minute in some cases even when Couchbase is health. This latency is too large for a health check. The Couchbase team have recommended the of a Cluster#diagnostics instead. This provides a much lower latency view of the cluster's health. This commit updates CouchbaseHealthIndicator to use Cluster#diagnostics while retaining support, in a deprecated form, for the old info-based mechanism should anyone want to opt back into that in 2.0.x. Closes gh-14685
= 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 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 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 {
compile("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.