Spring Boot Admin 的使用详解

偏执的太偏执、 2022-05-21 06:55 187阅读 0赞

这篇文章主要介绍了Spring Boot Admin 的使用详解，Spring Boot Admin 用于监控基于 Spring Boot 的应用，有兴趣的可以了解一下

**一、前言**

Spring Boot Admin 用于监控基于 Spring Boot 的应用。官方文档在这里（v1.3.4）：《[Spring Boot Admin Reference Guide][]》

实践的过程中，感觉这个 User Guide 结构上还是说的不太明白。所以我就大概写一遍我的实践过程与理解。

阅读此文前提条件是：

*  使用过 Maven。
 *  你跑过基于 Spring Boot 的 hello world 程序。
 *  第三节需要你会点 Spring Cloud 的 Eureka Server 配置。

**二、在 Spring Boot 项目中配置**

这种配置中，Spring Boot Admin 作为 Server，其他 Spring Boot 应用作为 Client，Client 把自身的信息“注册”到 Server，我们就能在 Server 上看到“注册”的 Spring Boot 应用的状态信息了。

**2.1、Server 端**

新建一个项目

**2.1.1、添加依赖**

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;de.codecentric&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-admin-server&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.3.4&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;de.codecentric&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-admin-server-ui&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.3.4&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**2.1.2、开启监控**

添加 @EnableAdminServer 注解开启监控

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@Configuration</code> 
     </div> 
     <div> 
      <code>@EnableAutoConfiguration</code> 
     </div> 
     <div> 
      <code>@EnableAdminServer</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>class</code> 
      <code>SpringBootAdminApplication { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>static</code> 
      <code>void</code> 
      <code>main(String[] args) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>SpringApplication.run(SpringBootAdminApplication.</code> 
      <code>class</code> 
      <code>, args);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

这里未指定 Server 运行的端口，默认是 8080，如果要指定，则需要在 application.properties 文件中设置：  
application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>server.port=8080</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**2.2、Client 端**

**2.2.1、添加依赖**

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;de.codecentric&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-admin-starter-client&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.3.4&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

这里的 spring-boot-admin-starter-client 会自动依赖 jolokia-core，jolokia是用于 JMX-bean 管理的。

**2.2.2、触发自动配置、指明 Server 注册地址**

application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>spring.boot.admin.url=<a href="http://localhost:8080" rel="nofollow">http://localhost:8080</a></code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

上面 3.1.2 中 Server 端我们使用默认的 8080 端口，所以这里声明 Server 的地址为：http://localhost:8080

**2.3、开始管理**

至此，启动 Server 端和 Client 端，在浏览器输入 Server 的地址：http://localhost:8080 就能看到“注册”进来的 Spring Boot 应用信息了。

**2.4、显示应用版本**

为了在 Spring Boot Admin 的应用管理列表显示被管理应用的版本号，你需要设置 info.version，例如使用 maven filtering：  
application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>info.version=@project.version@</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

这里设置显示的版本号为 Maven pom.xml 中的构建版本号。

**2.5、JMX-bean管理**

JMX-bean 管理需要使用第三方的 [jolokia ][jolokia]，因为 spring-boot-admin-starter-client 会自动依赖 jolokia-core，所以这里不需要显示依赖了，第三节的基于 Eureka 注册发现的配置中，就需要显示地依赖：

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.jolokia&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;jolokia-core&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**2.6、Loglevel 管理**

当前日志级别管理仅限 Logback，通过 JMX 实现，所以需要依赖 jolokia 。同时，还需要配置 Logback 的 JMXConfigurator：  
logback.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>configuration</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>include</code> 
      <code>resource</code> 
      <code>=</code> 
      <code>"org/springframework/boot/logging/logback/base.xml"</code> 
      <code>/&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>jmxConfigurator</code> 
      <code>/&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>configuration</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

这个 logback.xml 放在与 application.properties 同级的目录就可以了，如果不配置 Logback，那么 Spring Boot Admin 就无法管理应用的日志级别。

**2.7、Server 端监控自己**

以上的配置，基本就可以很好工作了。

但是有一个问题，我们没有监控作为 Server 端的 Spring Boot Admin 自身。如果要监控到 Server 自己，把 Server 端也当作是 Client 一样来配置就可以实现了：把 2.2.1、2.2.2、2.4、2.6 的步骤在 Server 端也配置一遍。

**三、在 Spring Cloud 项目的 Eureka 中配置**

这里示例的 Spring Cloud 项目是使用 Eureka 来做注册/发现的，官方 Github 示例里有基于 Consul 和 Zookeper 的配置。

配置好之后，Spring Boot Admin 就可以管理所有注册到 Eureka Server 的应用了，包括 Spring Boot Admin 自己（因为自己也会注册到 Eureka Server）。

**3.1、一个简单的 Eureka Server**

关于 Eureka Server 这里不做详细介绍，只列一下配置经过：

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework.cloud&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-cloud-starter-eureka-server&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

Eureka Server 启动类

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@SpringBootApplication</code> 
     </div> 
     <div> 
      <code>@EnableEurekaServer</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>class</code> 
      <code>EurekaServerApplication { </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>static</code> 
      <code>void</code> 
      <code>main(String[] args) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>SpringApplication.run(EurekaServerApplication.</code> 
      <code>class</code> 
      <code>, args);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>spring.application.name=eureka-server</code> 
     </div> 
     <div> 
      <code>server.port=8761</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

在 application.properties 同级目录下新建 bootstrap.properties 文件： bootstrap.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>eureka.instance.hostname=localhost</code> 
     </div> 
     <div> 
      <code>eureka.client.registerWithEureka=false</code> 
     </div> 
     <div> 
      <code>eureka.client.fetchRegistry=false</code> 
     </div> 
     <div> 
      <code>eureka.client.serviceUrl.defaultZone=http://${eureka.instance.hostname}:${server.port}/eureka/</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

此文件作用与 application.properties 几乎样，只是但是作用在 application context 启动时期。原话是：like application.properties but for the bootstrap phase of an application context 。

以上配置表明，我们的 Eureka Server 运行在 8761 端口。服务注册地址是：http://localhost:8761/eureka/

**3.2、Server 端**

官方示例：[spring-boot-admin-sample-eureka][]

**3.2.1、添加 spring-cloud-starter-eureka 依赖**

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;de.codecentric&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-admin-server&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.3.4&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;de.codecentric&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-admin-server-ui&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>version</code> 
      <code>&gt;1.3.4&lt;/</code> 
      <code>version</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework.cloud&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-cloud-starter-eureka&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**3.2.2、添加 @EnableDiscoveryClient 开启发现**

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@Configuration</code> 
     </div> 
     <div> 
      <code>@EnableAutoConfiguration</code> 
     </div> 
     <div> 
      <code>@EnableDiscoveryClient</code> 
     </div> 
     <div> 
      <code>@EnableAdminServer</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>class</code> 
      <code>SpringBootAdminApplication { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>static</code> 
      <code>void</code> 
      <code>main(String[] args) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>SpringApplication.run(SpringBootAdminApplication.</code> 
      <code>class</code> 
      <code>, args);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**3.2.3、指明去哪注册**

application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>eureka.instance.client.serviceUrl.defaultZone: <a href="http://localhost:8761/eureka/" rel="nofollow">http://localhost:8761/eureka/</a></code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

也就是我们在 3.1 中配置的 Eureka Server 服务地址。

这个配置我测试时并不成功，改为 eureka.client.serviceUrl.defaultZone: http://localhost:8761/eureka/ 才可以，不知为何。

**3.2.4、官方未说明的**

3.2.1 ~ 3.2.3 的配置，会把 Server 注册到 Eureka Server，也就是说 Spring Boot Admin 也可以管理自身，但现在的 Server 配置还不全面（比如自身还缺的配置有：版本信息、 JMX 管理和 Loglevel 管理）。加上以下配置： application.properties

[?][Link 1]

pom.xml

[?][Link 1]

logback.xml

[?][Link 1]

**3.3、Client 端**

Client 端的配置主要是把自己注册到 Eureka Server 中就可以被 Spring Boot Admin 管理了，免去了手工配置 Spring Boot Admin 服务地址的操作（即 2.2.2 节操作）。

**3.3.1、依赖**

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework.cloud&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-cloud-starter-eureka&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework.boot&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-starter-actuator&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

注意要添加 spring-boot-starter-actuator 依赖，因为获取应用信息是通过 actuator 中的相关 endpoints 获取的。

之所以 Server 端不需要添加此依赖，是因为 spring-boot-admin-server 依赖于 spring-boot-admin-starter-client ，而 spring-boot-admin-starter-client 依赖于 spring-boot-starter-actuator 。

**3.3.2、启动类**

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>@SpringBootApplication</code> 
     </div> 
     <div> 
      <code>@EnableEurekaClient</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code>class</code> 
      <code>ClientEurekaSampleApplication { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>static</code> 
      <code>void</code> 
      <code>main(String[] args) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>SpringApplication.run(ClientEurekaSampleApplication.</code> 
      <code>class</code> 
      <code>, args);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

添加 @EnableDiscoveryClient 或 @EnableEurekaClient 注解到启动类上，将自己注册到 Erueka Server。

**3.3.3、指明去哪注册**

bootstrap.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>eureka.client.serviceUrl.defaultZone: <a href="http://localhost:8761/eureka/" rel="nofollow">http://localhost:8761/eureka/</a></code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

**3.3.4、其他项配置**

application.properties

[?][Link 1]

logback.xml

[?][Link 1]

pom.xml

[?][Link 1]

**四、通知**

官方提供好几种通知方式，这里贴一下邮件通知的配置，其他 Pagerduty、Hipchat 、Slack 和 Reminder 的通知配置请参见官方文档。

使用 spring-boot-starter-mail 依赖配置 JavaMailSender

pom.xml

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;org.springframework.boot&lt;/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;spring-boot-starter-mail&lt;/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

application.properties

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>spring.mail.host=smtp.example.com</code> 
     </div> 
     <div> 
      <code>spring.boot.admin.notify.mail.to=admin@example.com</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

表格：邮件配置选项

<table style="width:665px;"> 
 <thead> 
  <tr> 
   <th>Property name</th> 
   <th>Description</th> 
   <th>Default value</th> 
   <th>中文说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>spring.boot.admin.notify.mail.enabled</td> 
   <td>Enable mail notifications</td> 
   <td>true</td> 
   <td>默认启用</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.ignore-changes</td> 
   <td>Comma-delimited list of status changes to be ignored. Format: “:”. Wildcards allowed.</td> 
   <td>“UNKNOWN:UP”</td> 
   <td>需要忽略的状态改变通知，逗号分隔</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.to</td> 
   <td>Comma-delimited list of mail recipients</td> 
   <td>“root@localhost”</td> 
   <td>接收通知的邮箱地址，逗号分隔</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.cc</td> 
   <td>Comma-delimited list of carbon-copy recipients</td> 
   <td>&nbsp;</td> 
   <td>抄送</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.from</td> 
   <td>Mail sender</td> 
   <td>&nbsp;</td> 
   <td>发送人</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.subject</td> 
   <td>Mail subject. SpEL-expressions are supported</td> 
   <td>“#{application.name} (#{application.id}) is #{to.status}”</td> 
   <td>主题</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.notify.mail.text</td> 
   <td>Mail body. SpEL-expressions are supported</td> 
   <td>“#{application.name} (#{application.id})\nstatus changed from #{from.status} to #{to.status}\n\n#{application.healthUrl}”</td> 
   <td>内容</td> 
  </tr> 
 </tbody> 
</table>

**五、附：Spring Boot Admin Server 配置说明**

表格：Spring Boot Admin Server 配置选项

<table style="width:665px;"> 
 <thead> 
  <tr> 
   <th>Property name</th> 
   <th>Description</th> 
   <th>Default value</th> 
   <th>中文说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>spring.boot.admin.context-path</td> 
   <td>The context-path prefixes the path where the Admin Server's statics assets and API should be served. Relative to the Dispatcher-Servlet.</td> 
   <td>&nbsp;</td> 
   <td>Admin Server 保留的静态访问和API的前缀（当你在业务应用中使用而不是单独使用时就很有必要了）</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.monitor.period</td> 
   <td>Time interval in ms to update the status of applications with expired status-informations.</td> 
   <td>10.000</td> 
   <td>更新应用信息的频率，单位毫秒</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.monitor.status-lifetime</td> 
   <td>Lifetime of application statuses in ms. The applications /health-endpoint will not be queried until the lifetime has expired.</td> 
   <td>10.000</td> 
   <td>被监控的应用信息的过期时间，单位毫秒</td> 
  </tr> 
 </tbody> 
</table>

**5.1、Spring Cloud 对自动发现的支持**

来自被发现的应用的状态信息是经过 ServiceInstanceConverter 转换过的，自动配置时，使用了 Spring Boot Admin 自带的 Eureka 转换实现。你也可以实现相关接口并并添加到上下文以替换默认的。

表格：注册发现配置选项

**六、附：Spring Boot Admin Client 配置说明**

Spring Boot Admin Client 注册到 Spring Boot Admin Server，Client 定期地发送 Http Post 到 admin 提供自己的应用信息。如果需要管理 loglevels 或 JMX-beans ，则要在依赖中添加 Jolokia ，使得 JMX-beans 也可以通过 http 访问。

表格：Spring Boot Admin Client配置选项

<table style="width:662px;"> 
 <thead> 
  <tr> 
   <th>Property name</th> 
   <th>Description</th> 
   <th>Default value</th> 
   <th>中文说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>spring.boot.admin.client.enabled</td> 
   <td>Enables the Spring Boot Admin Client.</td> 
   <td>true</td> 
   <td>默认开启</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.url</td> 
   <td>List of URLs of the Spring Boot Admin server to register at. This triggers the AutoConfiguration.&nbsp;Mandatory.</td> 
   <td>&nbsp;</td> 
   <td>admin server 的地址列表，此设置会触发自动配置，必须</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.api-path</td> 
   <td>Http-path of registration endpoint at your admin server.</td> 
   <td>“api/applications”</td> 
   <td>注册到 admin server 端点的 Http-path</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.username spring.boot.admin.password</td> 
   <td>Username and password for http-basic authentication. If set the registration uses http-basic-authentication when registering at the admin server.</td> 
   <td>&nbsp;</td> 
   <td>注册到 admin server 的账号密码</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.period</td> 
   <td>Interval for repeating the registration (in ms).</td> 
   <td>10.000</td> 
   <td>重试注册的间隔时间</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.auto-registration</td> 
   <td>If set to true the periodic task to register the application is automatically scheduled after the application is ready.</td> 
   <td>true</td> 
   <td>应用启动后自动执行周期性的注册任务</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.auto-deregistration</td> 
   <td>Switch to enable auto-deregistration at Spring Boot Admin server when context is closed.</td> 
   <td>false</td> 
   <td>当应用关闭时，自动取消注册</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.client.health-url</td> 
   <td>Client-health-url to register with. Can be overridden in case the reachable URL is different (e.g. Docker). Must be unique in registry.</td> 
   <td>Guessed based on management-url and endpoints.health.id.</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.client.management-url</td> 
   <td>Client-management-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).</td> 
   <td>Guessed based on service-url, server.servlet-path, management.port and management.context-path.</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.client.service-url</td> 
   <td>Client-service-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).</td> 
   <td>Guessed based on hostname, server.port and server.context-path.</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.client.name</td> 
   <td>Name to register with.</td> 
   <td>${spring.application.name} if set, “spring-boot-application” otherwise.</td> 
   <td>注册时的名字</td> 
  </tr> 
  <tr> 
   <td>spring.boot.admin.client.prefer-ip</td> 
   <td>Use the ip-address rather then the hostname in the guessed urls. If server.address / management.address is set, it get used. Otherwise the IP address returned from InetAddress.getLocalHost() gets used.</td> 
   <td>false</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

**七、问答**

这部分我也啰嗦一下翻译出来。

我可以把 spring-boot-admin 添加到我的业务应用中吗？

答：可以，但不应该这么做。你可以设置 spring.boot.admin.context-path 来改变 admin server 保留的 UI 和 REST-API 的访问，取决于你的应用复杂性，你可能会陷入困境。另一方面，当你的应用挂掉后，你的监控也一起挂掉，那么要监控有什么用呢？

该怎么自定义 UI ？

答：修改 UI 你仅可以复制并修改 spring-boot-admin-ui，并添加你自己的模块到 classpath 中。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

转载自：https://www.jb51.net/article/124601.htm

[Spring Boot Admin Reference Guide]: http://codecentric.github.io/spring-boot-admin/1.3.4/
[Link 1]: https://www.jb51.net/article/124601.htm#
[jolokia]: https://jolokia.org/
[spring-boot-admin-sample-eureka]: https://github.com/codecentric/spring-boot-admin/tree/master/spring-boot-admin-samples/spring-boot-admin-sample-eureka/