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.
The way that endpoints are exposed will depend on the type of technology that you choose.
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
.
The following endpoints are available:
ID | Description | Sensitive |
---|---|---|
| Displays an auto-configuration report showing all auto-configuration candidates and the reason why they “were” or “were not” applied. | true |
| Displays a complete list of all the Spring Beans in your application. | true |
| Displays a collated list of all | true |
| Performs a thread dump. | true |
| Exposes properties from Spring’s | true |
| Shows application health information (defaulting to a simple “OK” message). | false |
| Displays arbitrary application info. | false |
| Shows “metrics” information for the current application. | true |
| Displays a collated list of all | true |
| Allows the application to be gracefully shutdown (not enabled by default). | true |
| Displays trace information (by default the last few HTTP requests). | true |
Note | |
---|---|
Depending on how an endpoint is exposed, the |
Endpoints can be customized using Spring properties. You can change if an endpoint is
enabled
, if it is considered sensitive
and even its id
.
For example, here is an application.properties
that changes the sensitivity and id
of the beans
endpoint and also enables shutdown
.
endpoints.beans.id=springbeans endpoints.beans.sensitive=false endpoints.shutdown.enabled=true
Note | |
---|---|
The prefix " |
The default information exposed by the health
endpoint is a simple “OK” message. It
is often useful to perform some additional health checks, for example you might check
that a database connection works, or that a remote REST endpoint is functioning.
To provide custom health information you can register a Spring bean that implements the
HealthIndicator
interface.
import org.springframework.boot.actuate.health.HealthIndicator; import org.springframework.stereotype.Component; @Component public class MyHealth implements HealthIndicator { @Override public Health health() { // perform some specific health check return ... } }
Spring Boot provides a
SimpleDatabaseHealthIndicator
implementation that attempts a simple database test as well as implementations for
Redis, MongoDB and RabbitMQ.
Spring Boot adds the HealthIndicator
instances automatically if beans of type DataSource
,
MongoTemplate
, RedisConnectionFactory
, RabbitTemplate
are present in the ApplicationContext
.
Besides implementing custom HealthIndicator`s and using out-of-box {sc-spring-boot-actuator}/health/Status.{sc-ext}[`Status
]
types, it is also possible to introduce custom Status
types for different or more complex system
states. In that case a custom implementation of the HealthAggregator
interface needs to be provided or the default implementation has to be configured using the
health.status.order
configuration property.
Assuming a new Status
with code FATAL
is being used in one of your HealthIndicator
implementations. To configure the severity or order add the following to your application properties:
health.status.order: FATAL, DOWN, UNKNOWN, UP
.
You can customize the data exposed by the info
endpoint by setting info.*
Spring
properties. All Environment
properties under the info key will be automatically
exposed. For example, you could add the following to your application.properties
:
info.app.name=MyService info.app.description=My awesome service info.app.version=1.0.0
If you are using Maven, you can automatically expand info properties from the Maven
project using resource filtering. In your pom.xml
you have (inside the <build/>
element):
<resources> <resource> <directory>src/main/resources</directory> <filtering>true</filtering> </resource> </resources>
You can then refer to your Maven “project properties” via placeholders, e.g.
project.artifactId=myproject project.name=Demo project.version=X.X.X.X project.description=Demo project for info endpoint info.build.artifact=${project.artifactId} info.build.name=${project.name} info.build.description=${project.description} info.build.version=${project.version}
Note | |
---|---|
In the above example we used |
Another useful feature of the info
endpoint is its ability to publish information
about the state of your git
source code repository when the project was built. If a
git.properties
file is contained in your jar the git.branch
and git.commit
properties will be loaded.
For Maven users the spring-boot-starter-parent
POM includes a pre-configured plugin to
generate a git.properties
file. Simply add the following declaration to your POM:
<build> <plugins> <plugin> <groupId>pl.project13.maven</groupId> <artifactId>git-commit-id-plugin</artifactId> </plugin> </plugins> </build>
A similar gradle-git
plugin is also available
for Gradle users, although a little more work is required to generate the properties file.