为什么要使用Spring Boot Admin
Spring Boot Actuator 提供了对单个 Spring Boot 应用的监控,信息包含应用状态、内存、线程、堆栈等,比较全面的监控了 Spring Boot 应用的整个生命周期,可以有效的帮我解决众多服务的健康检查、指标监控问题、配置管理、日志聚合问题、异常排查问题等等。
Spring Boot Admin来源背景
codecentric的Spring Boot Admin是一个社区项目,用于管理和监视您的Spring Boot®应用程序。这些应用程序在我们的Spring Boot Admin Client中注册(通过HTTP),或者是通过Spring Cloud®(例如Eureka,Consul)发现的。 UI只是Spring Boot Actuator端点之上的Vue.js应用程序。
Spring Boot Admin功能介绍
Spring Boot Admin提供了很多服务治理方面的功能,利用它能节省我们很多在治理服务方面的时间和精力Spring Boot Admin提供了如下功能(包括但不限于):
显示健康状态及详细信息,如JVM和内存指标、数据源指标、缓存指标
跟踪并下载日志文件
查看jvm系统-和环境属性
查看Spring启动配置属性方便loglevel管理
查看线程转储视图http-traces
查看http端点查看计划任务
查看和删除活动会话(使用spring-session)
状态更改通知(通过电子邮件、Slack、Hipchat…)
状态变化的事件日志(非持久性)
下载 heapdump
查看 Spring Boot 配置属性
支持 Spring Cloud 的环境端点和刷新端点
支持 K8s
易用的日志级别管理
与JMX-beans交互
查看线程转储
查看http跟踪
查看auditevents
查看http-endpoints
查看计划任务
查看和删除活动会话(使用 Spring Session )
查看Flyway/Liquibase数据库迁移
状态变更通知(通过电子邮件,Slack,Hipchat等,支持钉钉)
状态更改的事件日志(非持久化)
搭建Spring Boot Admin Server
Spring Boot Admin的最新版本为: 2.2.2。
基础环境:Jdk 11、Maven、IntelliJ IDEA2019
引入依赖
Spring Boot Admin Server 一般推荐独立作为一个 Spring Boot jar应用运行。 只需要将下列依赖添加到你的 pom.xml 中:
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-server</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
添加配置
通过在配置中添加@EnableAdminServer来引入Spring Boot Admin Server配置:
@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class SpringBootAdminApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootAdminApplication.class, args);
}
}
配置端口
server: port: 8088
此时我们通过浏览器访问:http://localhost:8088 可以看到我们可以访问到Spring Boot Admin Server的UI界面:
注册客户端
Spring boot Admin提供了多种注册客户端服务的方式,要在SBA(Spring Boot Admin)服务器上注册应用程序,您可以直接注册SBA客户端或使用Spring Cloud Discovery(例如Eureka,Consul等)。在SBA服务器端,还有一个使用静态配置的简单选项。本文将演示直接注册、使用Zookeeper、使用Kubernetes来注册发现客户端服务。
直接注册方式
引入依赖
使用直接注册方式,需要在客户端服务中引入依赖,从而做到直接与SBA服务端通信。
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
根据开头所述Spring Boot Admin是基于Spring Boot Actuator之上的,所以我们需要引入Spring Boot Actuator相关依赖,此外我们需要处理Actuator的安全性,所以引入Spring Security相关依赖。
增强配置
1:spring.boot.admin.client.url: "http://localhost:8088"
2:management.endpoints.web.exposure.include: "*"
1:要注册到其中的Spring Boot Admin Server的URL。
2:与Spring Boot 2一样,默认情况下,大多数Actuator(端点)都不通过http公开,在这里我们公开了所有端点。对于生产,您应该仔细选择要公开的端点。
此时我们同时运行SBA的服务端和客户端服务,再次访问http://localhost:8088,可以看到我们的客户端服务已经注册进去,并且可以看到客户端服务的一些信息。
Zookeeper服务组件发现方式
我们通过一些服务发现组件对客户端服务进行注册的时候,我们就可以忽略掉客户端服务了,即我们不需要在客户端服务中引入Spring Boot Admin相关依赖,因为服务端可以通过服务发现组件来自动发现客户端服务。
引入依赖
我们在SBA服务端以及客户端中引入Zookeeper相关依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zookeeper-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-context</artifactId>
</dependency>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
添加配置
在SBA服务端项目中添加Zookeeper相关配置
spring:
cloud:
zookeeper:
connect-string: 你的Zookeeper地址
boot:
admin:
discovery:
instances-metadata:
sba-register: true
因为Zookeeper中可能存在很多服务,而我们只想发现我们关注的服务,此时我们可以通过上述配置来实现,即我们只发现元数据为sba-register: true的客户端服务。在SBA客户端中添加Zookeeper相关配置
spring.cloud.zookeeper.connect-string=你的Zookeeper地址
spring.cloud.zookeeper.discovery.metadata.sba-register=true
对应SBA服务端的配置,我们指定了Zookeeper的地址,并且指定了该客户端服务的注册元数据为sba-register: true此时我们同时运行SBA的服务端和客户端服务,再次访问SBA服务端地址,可以看到服务端已经通过Zookeeper自动发现客户端服务,并且可以看到客户端服务的一些信息。
进阶实战
简单的日志查看
默认情况下,日志文件无法通过执行器端点访问,因此在 Spring Boot Admin 中不可见。为了启用日志文件执行器端点,您需要通过设置logging.path或 logging.file。
Spring Boot Admin 将检测所有看起来像URL的内容,并将其呈现为超链接。还支持ANSI颜色转义。您需要设置一个自定义文件日志模式,因为Spring Boot的默认模式不使用颜色。
以 logging.file 为例, 我们在客户端 application.yml增加以下配置:
logging:
file: /application.log
pattern:
file: '%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([�.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx'
然后即可在 SBA 控制台显示:
总结
本文主要介绍了Spring Boot Admin(SBA)的诞生背景已经其带来的一些功能特性,在这个微服务遍地开花的时代SBA缓解了我们在微服务中遇到的许多棘手的问题。后面本文还用代码演示了如何在项目中引入并使用SBA。本文只涉及到了SBA的基础实践,我会在后续文章中详细演示更多SBA的高级功能,看看我们能从中受益多少。