Skip to content
This repository was archived by the owner on Jun 29, 2018. It is now read-only.

Commit 01cc20d

Browse files
author
Johannes Stelzer
committed
Updated docs to current release
1 parent 66173f5 commit 01cc20d

File tree

2 files changed

+42
-9
lines changed

2 files changed

+42
-9
lines changed

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,20 @@ This application provides a simple GUI to administrate Spring Boot applications
2020
* Easy loggerlevel management
2121
* Interact with JMX-Beans
2222
* View Threaddump
23+
* View Traces
2324

2425
#### Server application
2526
Add the following dependency to your pom.xml.
2627
```xml
2728
<dependency>
2829
<groupId>de.codecentric</groupId>
2930
<artifactId>spring-boot-admin-server</artifactId>
30-
<version>1.1.2</version>
31+
<version>1.2.0</version>
3132
</dependency>
3233
<dependency>
3334
<groupId>de.codecentric</groupId>
3435
<artifactId>spring-boot-admin-server-ui</artifactId>
35-
<version>1.1.2</version>
36+
<version>1.2.0</version>
3637
</dependency>
3738
```
3839

@@ -52,22 +53,54 @@ See also the [example project](https://github.com/codecentric/spring-boot-admin/
5253

5354
For configuring Hazelcast support see [spring-boot-admin-server](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-server/README.md) or [hazelcast-example project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-hazelcast)
5455

55-
#### Client applications
56-
Each application that want to register itself to the admin application has to include the [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-starter-admin-client) as dependency. This starter JAR includes some [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot documentation") features that includes registering tasks, controller, etc.
56+
#### Register / Discover client applications
57+
To get all your boot applications shown in spring boot admin you have two choices:
58+
59+
1) either you include the spring-boot-admint-starter-client into your applications
60+
61+
or
62+
63+
2) you add a DiscoveryClient (e.g. Eureka) to your spring boot admin server.
64+
65+
**Note:** If you don't include the spring-boot-admin-starter-client the logfile won't be availible, due to the fact that the logfile endpoint won't be exposed.
66+
67+
##### Register client applications via spring-boot-admin-starter-client
68+
Each application that want to register itself to the admin application has to include the [spring-boot-admin-starter-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-starter-client) as dependency. This starter JAR includes some [AutoConfiguration](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration "Spring Boot documentation") features that includes registering tasks, controller, etc.
5769
```xml
5870
<dependency>
5971
<groupId>de.codecentric</groupId>
6072
<artifactId>spring-boot-starter-admin-client</artifactId>
61-
<version>1.1.2</version>
73+
<version>1.2.0</version>
6274
</dependency>
6375
```
64-
6576
Inside your configuration (e.g. application.properties) you also have to define the URL of the Spring Boot Admin Server, e.g.
6677
```
6778
spring.boot.admin.url=http://localhost:8080
6879
```
80+
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)
6981

70-
For all configuration options see [spring-boot-starter-admin-client](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-starter-admin-client/README.md)
82+
##### Discover client applications via DiscoveryClient
83+
Just add spring-clouds ``@EnableDiscoveryClient`` annotation and include an appropriate implementation (e.g. Eureka) to your classpath.
84+
```java
85+
@Configuration
86+
@EnableAutoConfiguration
87+
@EnableDiscoveryClient
88+
@EnableAdminServer
89+
public class SpringBootAdminApplication {
90+
public static void main(String[] args) {
91+
SpringApplication.run(SpringBootAdminApplication.class, args);
92+
}
93+
}
94+
```
95+
96+
```xml
97+
<dependency>
98+
<groupId>org.springframework.cloud</groupId>
99+
<artifactId>spring-cloud-starter-eureka</artifactId>
100+
<verion>1.0.0.RELEASE</version>
101+
</dependency>
102+
```
103+
See the sample [discovery sample project](https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-discovery)
71104

72105

73106
#### Screenshots

spring-boot-admin-server/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Add the following dependency to your pom.xml.
88
<dependency>
99
<groupId>de.codecentric</groupId>
1010
<artifactId>spring-boot-admin-server</artifactId>
11-
<version>1.1.2</version>
11+
<version>1.2.0</version>
1212
</dependency>
1313
<dependency>
1414
<groupId>de.codecentric</groupId>
1515
<artifactId>spring-boot-admin-server-ui</artifactId>
16-
<version>1.1.2</version>
16+
<version>1.2.0</version>
1717
</dependency>
1818
```
1919

0 commit comments

Comments
 (0)