diff --git a/spring-boot-actuator/README.adoc b/spring-boot-actuator/README.adoc new file mode 100644 index 0000000000..9785931571 --- /dev/null +++ b/spring-boot-actuator/README.adoc @@ -0,0 +1,51 @@ += 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] +---- + + + org.springframework.boot + spring-boot-starter-actuator + + +---- + +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`). diff --git a/spring-boot-actuator/README.md b/spring-boot-actuator/README.md deleted file mode 100644 index f52f9157b7..0000000000 --- a/spring-boot-actuator/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# 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 -[user guide](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready) -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: - -```xml - - - org.springframework.boot - spring-boot-starter-actuator - - -``` - -For Gradle, use the declaration: - -```groovy - 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 -app 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 response similar to this: - -* **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`). diff --git a/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.adoc b/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.adoc new file mode 100644 index 0000000000..af83419159 --- /dev/null +++ b/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.adoc @@ -0,0 +1,6 @@ +This sample application uses Spring Boot and +http://beta.groovy-lang.org/docs/groovy-2.3.1/html/documentation/markup-template-engine.html[Groovy templates] +in the View layer. The templates for this app live in `classpath:/templates/`, which is +the conventional location for Spring Boot. External configuration is available via +``spring.groovy.template.*''. + diff --git a/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.md b/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.md deleted file mode 100644 index 2be5a58e1b..0000000000 --- a/spring-boot-samples/spring-boot-sample-web-groovy-templates/README.md +++ /dev/null @@ -1,7 +0,0 @@ -This sample application uses Spring Boot and -[Groovy templates](http://beta.groovy-lang.org/docs/groovy-2.3.1/html/documentation/markup-template-engine.html) -in the View layer. The templates for this app live in -`classpath:/templates/`, which is the conventional location for Spring -Boot. External configuration is available via -"spring.groovy.template.*". -