mirror of
https://github.com/spring-projects/spring-boot.git
synced 2026-09-21 16:19:42 +00:00
Andy Wilkinson
764e34b9db
Prior to this commit, EndpointWebMvcAutoConfiguration would start a child context if the management port was different to the server port and the application context was a web application context. This caused two problems: If a user built an executable war and configured the management port so that it was different to the server port, their application would run successfully when launched with java -jar, but it would fail when deployed to Tomcat as an attempt would be made to start embedded Tomcat. Secondly, if a user ran a test annotated with @WebAppConfiguration the main embedded Tomcat instance would not be started, but the child context would trigger the creation of a Tomcat instance listening on the configured management port. This is unexpected as @WebIntegrationTest or @IntegrationTest and @WebAppConfiguration should be required to have the test trigger full startup of the application and listen on the configured ports. This commit updates EndpointWebMvcAutoConfiguration so that it will only start a child context when the management port is different to the server port and the EmbeddedWebApplicationContext has an embedded servlet container. This resolves the two problems described above as there will be no embedded servlet container when deployed to a standalone container or when a test is run without @IntegrationTest. Fixes gh-2798
= 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 endpoints, with JMX or even by remote shell (SSH or
Telnet). Auditing, health and metrics gathering can be automatically applied to your
application. The
http://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 POM''. 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 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 `/health` (and see `/mappings` for
a list of other HTTP endpoints).
* **Metrics** Spring Boot Actuator includes a metrics service with ``gauge'' and
``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
to an `AuditService`. 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.
* **Process Monitoring** In Spring Boot Actuator you can find `ApplicationPidListener`
which creates a file containing the application PID (by default in the application
directory with a file name of `application.pid`).