spring-boot

History

Andy Wilkinson 6ec0b4ca81 Only consider letters when checking if a name is upper-case Previously, for a string to be considered upper-case, EmbeddedServerPortFileWriter required every character in the string to be upper-case. This meant that strings containing numbers were considered lower-case even if every letter in the string was upper-case. OS X’s case-preserving, case-insensitive file system masked this problem as the tests were still able to find the created file, even though the case of its name was not as expected. This commit updates EmbeddedServerPortFileWriter to only require characters that are letters (as defined by Character.isLetter()) to be upper-case. It also updates the tests to verify that the case of the created file’s name is correct in such a way that it will fail, even on OS X, when it is not. Fixes gh-1676		2014-10-09 14:17:18 +01:00
..
src	Only consider letters when checking if a name is upper-case	2014-10-09 14:17:18 +01:00
README.adoc	Convert README.md -> README.adoc	2014-06-06 22:56:44 -07:00
pom.xml	Upgrade to Hibernate Validator 5.1.2.Final	2014-10-01 17:28:29 +01:00

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 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 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 file containing application PID (by default in application directory and
  file name is `application.pid`).