Commit b910b19e by Johannes Stelzer

update README and screenshots

increment version
parent 507405ac
...@@ -23,7 +23,8 @@ This application provides a simple GUI to administrate Spring Boot applications ...@@ -23,7 +23,8 @@ This application provides a simple GUI to administrate Spring Boot applications
* Interact with JMX-Beans * Interact with JMX-Beans
* View Threaddump * View Threaddump
* View Traces * View Traces
* Desktop notification on status change * Mail and desktop notification on status change
* Event journal of status changes (non persistent)
#### Server application #### Server application
Add the following dependency to your pom.xml. Add the following dependency to your pom.xml.
...@@ -31,12 +32,12 @@ Add the following dependency to your pom.xml. ...@@ -31,12 +32,12 @@ Add the following dependency to your pom.xml.
<dependency> <dependency>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server</artifactId> <artifactId>spring-boot-admin-server</artifactId>
<version>1.2.1</version> <version>1.2.2</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server-ui</artifactId> <artifactId>spring-boot-admin-server-ui</artifactId>
<version>1.2.1</version> <version>1.2.2</version>
</dependency> </dependency>
``` ```
...@@ -73,14 +74,14 @@ Each application that want to register itself to the admin application has to in ...@@ -73,14 +74,14 @@ Each application that want to register itself to the admin application has to in
<dependency> <dependency>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId> <artifactId>spring-boot-admin-starter-client</artifactId>
<version>1.2.1</version> <version>1.2.2</version>
</dependency> </dependency>
``` ```
Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin Server, e.g. Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin Server, e.g.
``` ```
spring.boot.admin.url=http://localhost:8080 spring.boot.admin.url=http://localhost:8080
``` ```
For all configuration options see [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client/README.md) For all configuration options see [spring-boot-admin-starter-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client/README.md)
##### Discover client applications via DiscoveryClient ##### Discover client applications via DiscoveryClient
Just add spring-clouds ``@EnableDiscoveryClient`` annotation and include an appropriate implementation (e.g. Eureka) to your classpath. Just add spring-clouds ``@EnableDiscoveryClient`` annotation and include an appropriate implementation (e.g. Eureka) to your classpath.
...@@ -100,11 +101,28 @@ public class SpringBootAdminApplication { ...@@ -100,11 +101,28 @@ public class SpringBootAdminApplication {
<dependency> <dependency>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId> <artifactId>spring-cloud-starter-eureka</artifactId>
<version>1.0.1.RELEASE</version> <version>1.0.3.RELEASE</version>
</dependency> </dependency>
``` ```
See the sample [discovery sample project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-discovery) See the sample [discovery sample project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-discovery)
#### Mail notification on status change
Configure a JavaMailSender using spring-boot-starter-mail and set a recipient:
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
```
```
spring.mail.host=smtp.example.com
spring.boot.admin.notify.to=admin@example.com
```
For all configuration options see [spring-boot-admin-server](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-server/README.md)
#### Screenshots #### Screenshots
...@@ -118,6 +136,11 @@ See the sample [discovery sample project](https://github.com/codecentric/spring- ...@@ -118,6 +136,11 @@ See the sample [discovery sample project](https://github.com/codecentric/spring-
[](url "title") [](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-details.png"> <img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-details.png">
##### Environment
[](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-environment.png">
##### Logging ##### Logging
[](url "title") [](url "title")
...@@ -128,6 +151,22 @@ See the sample [discovery sample project](https://github.com/codecentric/spring- ...@@ -128,6 +151,22 @@ See the sample [discovery sample project](https://github.com/codecentric/spring-
[](url "title") [](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-jmx.png"> <img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-jmx.png">
##### Threads
[](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-threads.png">
##### JMX
[](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-trace.png">
##### Journal
[](url "title")
<img src="https://raw.githubusercontent.com/codecentric/spring-boot-admin/master/screenshot-journal.png">
#### Build #### Build
In order to build spring-boot-admin you need to have node.js and npm on your PATH. In order to build spring-boot-admin you need to have node.js and npm on your PATH.
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin</artifactId> <artifactId>spring-boot-admin</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Spring Boot Admin</name> <name>Spring Boot Admin</name>
......
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
This diff was suppressed by a .gitattributes entry.
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin</artifactId> <artifactId>spring-boot-admin</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-samples</artifactId> <artifactId>spring-boot-admin-samples</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-sample-discovery</artifactId> <artifactId>spring-boot-admin-sample-discovery</artifactId>
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-samples</artifactId> <artifactId>spring-boot-admin-samples</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-sample-hazelcast</artifactId> <artifactId>spring-boot-admin-sample-hazelcast</artifactId>
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-samples</artifactId> <artifactId>spring-boot-admin-samples</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-sample</artifactId> <artifactId>spring-boot-admin-sample</artifactId>
......
{ {
"name": "spring-boot-admin-server-ui", "name": "spring-boot-admin-server-ui",
"version": "1.2.1", "version": "1.2.3",
"scripts": { "scripts": {
"postinstall": "./node_modules/protractor/bin/webdriver-manager update", "postinstall": "./node_modules/protractor/bin/webdriver-manager update",
"pretest": "./node_modules/protractor/bin/webdriver-manager start &", "pretest": "./node_modules/protractor/bin/webdriver-manager start &",
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin</artifactId> <artifactId>spring-boot-admin</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-server-ui</artifactId> <artifactId>spring-boot-admin-server-ui</artifactId>
......
...@@ -8,12 +8,12 @@ Add the following dependency to your pom.xml. ...@@ -8,12 +8,12 @@ Add the following dependency to your pom.xml.
<dependency> <dependency>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server</artifactId> <artifactId>spring-boot-admin-server</artifactId>
<version>1.2.1</version> <version>1.2.2</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server-ui</artifactId> <artifactId>spring-boot-admin-server-ui</artifactId>
<version>1.2.1</version> <version>1.2.2</version>
</dependency> </dependency>
``` ```
...@@ -41,6 +41,18 @@ Since the DiscoveryClient doesn't tell the management.context-path you can suffi ...@@ -41,6 +41,18 @@ Since the DiscoveryClient doesn't tell the management.context-path you can suffi
Explictly disable DiscoveryClient support by setting ``spring.boot.admin.discover.enabled=false``. Explictly disable DiscoveryClient support by setting ``spring.boot.admin.discover.enabled=false``.
## Mail notification options:
| Name | Description |
| --------------------- | ----------- |
|spring.boot.admin.notify.enabled|enable mail notification (default: true)|
|spring.boot.admin.notify.to|comma-delimited list of mail recipients (default: "root@localhost")|
|spring.boot.admin.notify.cc|comma-delimited list of mail cc-recipients|
|spring.boot.admin.notify.from|sender of mail|
|spring.boot.admin.notify.subject|mail-subject; SpEL-expressions supported (default: "#{application.name} (#{application.id}) is #{to.status}") |
|spring.boot.admin.notify.text|mail-body; SpEL-expressions supported (default: "#{application.name} (#{application.id})\nstatus changed from #{from.status} to #{to.status}\n\n#{application.healthUrl}"|
|spring.boot.admin.notify.ignoreChanges|comma-deleiited list of status changes to be ignored. (default: "UNKNOWN:UP")|
## Hazelcast Support ## Hazelcast Support
Spring Boot Admin Server supports cluster replication with Hazelcast. Spring Boot Admin Server supports cluster replication with Hazelcast.
It is automatically enabled when its found on the classpath. It is automatically enabled when its found on the classpath.
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin</artifactId> <artifactId>spring-boot-admin</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-server</artifactId> <artifactId>spring-boot-admin-server</artifactId>
......
...@@ -21,7 +21,7 @@ The main service that is used is a registrar that registeres the application at ...@@ -21,7 +21,7 @@ The main service that is used is a registrar that registeres the application at
| spring.boot.admin.client.managemntUrl | Client-management-URL to register with. Can be overriden in case the reachable URL is different (e.g. Docker). Must be unique in registry.<br>Default: is guessed based on serviceUrl management.port and management.context-path| | spring.boot.admin.client.managemntUrl | Client-management-URL to register with. Can be overriden in case the reachable URL is different (e.g. Docker). Must be unique in registry.<br>Default: is guessed based on serviceUrl management.port and management.context-path|
| spring.boot.admin.client.healthUrl | Client-management-URL to register with. Can be overriden in case the reachable URL is different (e.g. Docker). Must be unique in registry.<br>Default: is guessed based on managementUrl and endpoints.health.id | | spring.boot.admin.client.healthUrl | Client-management-URL to register with. Can be overriden in case the reachable URL is different (e.g. Docker). Must be unique in registry.<br>Default: is guessed based on managementUrl and endpoints.health.id |
| spring.boot.admin.client.name | Name to register with. Defaults to the ApplicationContexts name. Only set when it should differ.<br>Default: _${spring.application.name}_ if set, spring-boot-application otherwise. | | spring.boot.admin.client.name | Name to register with. Defaults to the ApplicationContexts name. Only set when it should differ.<br>Default: _${spring.application.name}_ if set, spring-boot-application otherwise. |
| spring.boot.admin.client.useIpAddressOf | If an network-interface name is specified, its ip-address wil be used for the guessed url (instead of hostname).|
### Other configuration properties ### Other configuration properties
Options from other spring boot features. These should be set to enable all features. Options from other spring boot features. These should be set to enable all features.
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<parent> <parent>
<groupId>de.codecentric</groupId> <groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin</artifactId> <artifactId>spring-boot-admin</artifactId>
<version>1.2.2-SNAPSHOT</version> <version>1.2.3-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-boot-admin-starter-client</artifactId> <artifactId>spring-boot-admin-starter-client</artifactId>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment