其他
Spring Boot Admin 服务监控利器
一、简介
用于对 Spring Boot 应用的管理和监控。可以用来监控服务是否健康、是否在线、以及一些jvm数据等等。
Spring Boot Admin 分为服务端(spring-boot-admin-server)和客户端(spring-boot-admin-client)，服务端和客户端之间采用 http 通讯方式实现数据交互；单体项目中需要整合 spring-boot-admin-client 才能让应用被监控。
在 SpringCloud 项目中，spring-boot-admin-server 是直接从注册中心抓取应用信息，不需要每个微服务应用整合 spring-boot-admin-client 就可以实现应用的管理和监控。
主要的功能点有：
显示应用程序的监控状态 应用程序上下线监控 查看 JVM，线程信息 可视化的查看日志以及下载日志文件 动态切换日志级别 Http 请求信息跟踪
二、搭建
1、服务端
需先搭建服务端，监控服务，被监控的服务连接过来即可，开箱即用。
1、新建一个项目做为服务端
2、引入spring-boot-admin服务端依赖
<!--用于检查系统的监控情况-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!--Spring Boot Admin Server监控服务端-->
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-server</artifactId>
<version>2.3.1</version>
</dependency>
<!--增加安全防护，防止别人随便进-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
3、启动类上开启admin@EnableAdminServer
4、security安全防护配置
import de.codecentric.boot.admin.server.config.AdminServerProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
@Configuration
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {
private final String adminContextPath;
public SecuritySecureConfig(AdminServerProperties adminServerProperties) {
this.adminContextPath = adminServerProperties.getContextPath();
}
@Override
protected void configure(HttpSecurity http) throws Exception {
// 登录成功处理类
SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
successHandler.setTargetUrlParameter("redirectTo");
successHandler.setDefaultTargetUrl(adminContextPath + "/");
http.authorizeRequests()
//静态文件允许访问
.antMatchers(adminContextPath + "/assets/**").permitAll()
//登录页面允许访问
.antMatchers(adminContextPath + "/login", "/css/**", "/js/**", "/image/*").permitAll()
//其他所有请求需要登录
.anyRequest().authenticated()
.and()
//登录页面配置，用于替换security默认页面
.formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
//登出页面配置，用于替换security默认页面
.logout().logoutUrl(adminContextPath + "/logout").and()
.httpBasic().and()
.csrf()
.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
.ignoringAntMatchers(
"/instances",
"/actuator/**"
);
}
}
5、yml配置
server:
port: 9111
spring:
boot:
admin:
ui:
title: HMB服务监控中心
client:
instance:
metadata:
tags:
environment: local
#要获取的client的端点信息
probed-endpoints: health,env,metrics,httptrace:trace,threaddump:dump,jolokia,info,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents
monitor: # 监控发送请求的超时时间
default-timeout: 20000
security: # 设置账号密码
user:
name: admin
password: admin
# 服务端点详细监控信息
management:
trace:
http:
enabled: true
endpoints:
web:
exposure:
include: "*"
endpoint:
health:
show-details: always
6、启动项目
访问 http://ip:端口，如我的http://localhost:9111，账号密码都是admin(上面的security配的)
7、自定义服务状态变化后，提醒功能
import de.codecentric.boot.admin.server.domain.entities.Instance;
import de.codecentric.boot.admin.server.domain.entities.InstanceRepository;
import de.codecentric.boot.admin.server.domain.events.InstanceEvent;
import de.codecentric.boot.admin.server.notify.AbstractStatusChangeNotifier;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;
@Component
public class WarnNotifier extends AbstractStatusChangeNotifier {
public WarnNotifier(InstanceRepository repository) {
super(repository);
}
@Override
protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
// 服务名
String serviceName = instance.getRegistration().getName();
// 服务url
String serviceUrl = instance.getRegistration().getServiceUrl();
// 服务状态
String status = instance.getStatusInfo().getStatus();
// 详情
Map<String, Object> details = instance.getStatusInfo().getDetails();
// 当前服务掉线时间
Date date = new Date();
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String format = simpleDateFormat.format(date);
// 拼接短信内容
StringBuilder str = new StringBuilder();
str.append("服务名：【" + serviceName + "】 \r\n");
str.append("服务状态：【"+ status +"】 \r\n");
str.append("地址：【" + serviceUrl + "】\r\n");
str.append("时间：" + format +"\r\n");
return Mono.fromRunnable(()->{
// 这里写你服务发生改变时，要提醒的方法
// 如服务掉线了，就发送短信告知
});
}
}
8、服务端配置
2、客户端
被监控的服务，需要连接服务端
1、依赖
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>2.3.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
2、yml配置
server:
port: 9222
spring:
application:
name: client
boot:
admin:
client: # spring-boot-admin 客户端配置
url: http://localhost:9111 #服务端连接地址
username: admin # 服务端账号
password: admin # 服务端密码
instance:
prefer-ip: true # 使用ip注册
# 服务端点详细监控信息
management:
# health: # 检测服务状态是通过http://localhost:9111/actuator/health接口，可去掉不用检测项
# mail: # 健康检测时，不要检测邮件
# enabled: false
trace:
http:
enabled: true
endpoints:
web:
exposure:
include: "*"
endpoint:
health:
show-details: always
logfile: # 日志（想在线看日志才配）
external-file: ./logs/client-info.log # 日志所在路径
3、启动项目
此时客户端就已经注册进来了。
点击可查看更多信息
点击日志也可在线查看日志
此时，如果我们服务掉线了，就会触发服务端的预警功能，告知我们。
4、客户端配置
3、微服务
除特别说明外，都是在上面的基础上添加
3.1、服务端
1、添加依赖
<!-- nacos注册中心配置-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2.2.5.RELEASE</version>
</dependency>
2、yml添加配置
spring:
cloud:
nacos:
discovery:
server-addr: localhost:8848
# namespace: # 要和你的服务同一命名空间
3.2、客户端
客户端不用引spring-boot-admin-starter-clien依赖，springbootadmin会去服务列表里找
如果服务有配置context-path路径，则需添加yml配置
spring:
cloud:
nacos:
discovery:
metadata: # minitor监控的context-path配置
management:
context-path: ${server.servlet.context-path}/actuator
4、我的微服务预警发送其他服务状态信息思路
问题：由于该组件重写状态发生变化时的接口，没有提供其他服务的状态信息，只有本服务，但是如果是集群、多实例，我又想知道，该服务其他实例或者其他的服务状态信息，是否存活。
思路：我在发送预警之前，访问其他服务的检测健康接口，如：
http://localhost:7050/attendance/actuator/nacos-discovery，有返回值，就可提取里面的信息，报错了说明没有该服务没有启动
结果展示：如我的预警内容，发送当前服务状态、当前服务剩余健康实例、其他健康服务数等等
END
往期精彩Spring Framework 6 中的新功能和增强功能一览
Zabbix 和 Prometheus 到底怎么选？
UUID 正在被 NanoID 取代？
Spring Boot 开发环境热部署方案
关注后端面试那些事，回复【2022面经】
获取最新大厂Java面经