Spring boot admin 服务监控利器

秒速五厘米 2023-09-28 17:50 134阅读 0赞

#### spring boot admin ####

*  一、简介
 *  二、搭建
 *   *  1、服务端
     *   *  8、服务端配置
     *  2、客户端
     *   *  4、客户端配置
     *  3、微服务
     *   *  3.1、服务端
         *  3.2、客户端
     *  4、我的微服务预警发送其他服务状态信息思路

## 一、简介 ##

`用于对 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 就可以实现应用的管理和监控。  
![在这里插入图片描述][131a27ca1c894203b9c9f3ee783df685.png]

**主要的功能点有：**

*  显示应用程序的监控状态
 *  应用程序上下线监控
 *  查看 JVM，线程信息
 *  可视化的查看日志以及下载日志文件
 *  动态切换日志级别
 *  Http 请求信息跟踪

## 二、搭建 ##

### 1、服务端 ###

需先搭建服务端，监控服务，被监控的服务连接过来即可，开箱即用。

**1、新建一个项目做为服务端**  
**2、引入spring-boot-admin服务端依赖**

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-actuator</artifactId>
 </dependency>
 
 <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`**

![在这里插入图片描述][7ffc1de2d1414f149fcce12d5acf4af8.png]  
**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配的)

![在这里插入图片描述][2672a2a49cfb4b239a8d24d90dfacba8.png]

![在这里插入图片描述][942a63357d764c8ca30c2258b752b027.png]**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、服务端配置 ####

<table> 
 <thead> 
 <tr> 
 <th>配置</th> 
 <th>默认参数</th> 
 <th>解释</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>spring.boot.admin.context-path</td> 
 <td>/</td> 
 <td>server端的访问路径</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.status-interval</td> 
 <td>10,000ms</td> 
 <td>检查实例状态的时间间隔。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.status-lifetime</td> 
 <td>10,000ms</td> 
 <td>client端状态的生命周期，该生命周期内不会更新client状态。单位是毫秒</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.info-interval</td> 
 <td>1m</td> 
 <td>查询实例信息的时间间隔。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.info-lifetime</td> 
 <td>1m</td> 
 <td>info的生命周期，该生命周期内不会更新info状态。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.default-timeout</td> 
 <td>10,000</td> 
 <td>发出请求时的默认超时。可以使用spring.boot.admin.monitor.timeout.*重写特定端点的单独值。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.timeout.*</td> 
 <td></td> 
 <td>每个endpointId超时的键值对。默认default-timeout</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.default-retries</td> 
 <td>0</td> 
 <td>失败请求的默认重试次数。修改请求(PUT, POST, PATCH, DELETE)永远不会重试。可以使用spring.boot.admin.monitor.retries.*重写特定端点的单个值。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.monitor.retries.*</td> 
 <td></td> 
 <td>键值对，包含每个endpointId的重试次数。默认为default-retries。修改请求(PUT, POST, PATCH, DELETE)永远不会重试。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.metadata-keys-to-sanitize</td> 
 <td>“.password " , " . ∗ s e c r e t ", ".*secret ",".∗secret”, “.*key " , " . ∗ t o k e n ", ".*token ",".∗token”, “.*credentials.”, “.*vcap_services$”</td> 
 <td>匹配这些regex模式的键的元数据值将在所有json输出中被清除。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.probed-endpoints</td> 
 <td>“health”, “env”, “metrics”, “httptrace:trace”, “threaddump:dump”, “jolokia”, “info”, “logfile”, “refresh”, “flyway”, “liquibase”, “heapdump”, “loggers”, “auditevents”</td> 
 <td>要获取的client的端点信息</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-auth.enabled</td> 
 <td>true</td> 
 <td>启用从Spring配置属性中提取凭证</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-auth.default-user-name</td> 
 <td>null</td> 
 <td>用于验证注册服务的默认用户名。该spring.boot.admin.instance-auth.enabled属性必须为true。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-auth.default-user-password</td> 
 <td>null</td> 
 <td>用于验证注册服务的默认用户密码。该spring.boot.admin.instance-auth.enabled属性必须为true。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-auth.service-map.*.user-name</td> 
 <td></td> 
 <td>用于使用指定名称对注册的服务进行身份验证的用户名。该spring.boot.admin.instance-auth.enabled属性必须为true。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-auth.service-map.*.user-password</td> 
 <td></td> 
 <td>用户密码，用于使用指定名称对注册的服务进行身份验证。该spring.boot.admin.instance-auth.enabled属性必须为。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.instance-proxy.ignored-headers</td> 
 <td>“Cookie”, “Set-Cookie”, “Authorization”</td> 
 <td>向客户提出请求时，不转发标题。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.public-url</td> 
 <td>&lt;img src=“assets/img/icon-spring-boot-admin.svg”&gt;&lt;\span&gt;Spring Boot Admin &lt;/span &gt;</td> 
 <td>用于在ui中构建基本href的基本URL。 如果在反向代理后面运行（使用路径重写），则可以用来进行正确的自我引用。如果省略主机/端口，将从请求中推断出来。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.brand 要在导航栏中显示的品牌。</td> 
 <td></td> 
 <td></td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.title</td> 
 <td>“Spring Boot Admin”</td> 
 <td>要显示的页面标题。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.login-icon</td> 
 <td>“assets/img/icon-spring-boot-admin.svg”</td> 
 <td>在登录页面上用作图像的图标。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.favicon</td> 
 <td>“assets/img/favicon.png”</td> 
 <td>用作默认图标的图标，用于桌面通知的图标。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.favicon-danger</td> 
 <td>“assets/img/favicon-danger.png”</td> 
 <td>当一项或多项服务关闭并用作桌面通知时，用作收藏夹图标。</td> 
 </tr> 
 <tr> 
 <td>启用spring.boot.admin.ui.remember-me</td> 
 <td>true</td> 
 <td>切换为在登录页面上显示/隐藏“记住我”复选框。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.cache</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的缓存数据。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.datasource</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的数据源数据。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.gc</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的gc数据。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.process</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的过程数据。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.memory</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的内存数据。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.ui.poll-timer.threads</td> 
 <td>2500</td> 
 <td>以毫秒为单位的轮询持续时间，以获取新的线程数据。</td> 
 </tr> 
 </tbody> 
</table>

### 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、启动项目**  
此时客户端就已经注册进来了。

![在这里插入图片描述][c9d0097b19ca4694b68c4708fb9a1e89.png]点击可查看更多信息  
![在这里插入图片描述][64ab6ac4782c4222977a9ae1b0f211b7.png]

点击日志也可在线查看日志

![在这里插入图片描述][29cabde0956c42658d19bb24dbd1b5ad.png]

此时，如果我们服务掉线了，就会触发服务端的预警功能，告知我们。

#### 4、客户端配置 ####

<table> 
 <thead> 
 <tr> 
 <th>配置</th> 
 <th>默认值</th> 
 <th>解释</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>spring.boot.admin.client.enabled</td> 
 <td>true</td> 
 <td>是否启用springbootAdmin客户端</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.url</td> 
 <td></td> 
 <td>要注册的server端的url地址。如果要同时在多个server端口注册，则用逗号分隔各个server端的url地址</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.api-path</td> 
 <td>“instances”</td> 
 <td>管理服务器上注册端点的http路径。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.username, spring.boot.admin.client.password</td> 
 <td></td> 
 <td>SBA Server api使用HTTP基本认证保护时使用的用户名和密码。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.period</td> 
 <td>10,000</td> 
 <td>重复注册的时间间隔(ms)。（client通过持续不断地向server端进行注册来保持client端与server端的连接）</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.connect-timeout</td> 
 <td>5,000</td> 
 <td>连接注册超时时间(毫秒)。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.read-timeout</td> 
 <td>5,000</td> 
 <td>注册读取超时，单位是毫秒</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.auto-registration</td> 
 <td>true</td> 
 <td>若设置为true，则在应用就绪后自动调度注册应用的定时任务。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.auto-deregistration</td> 
 <td>null</td> 
 <td>是否开启自动注销,如果服务端运行在云平台，默认值是true</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.register-once</td> 
 <td>true</td> 
 <td>如果设置为true，客户端将只注册一个管理服务器(按照spring.boot.admin.instance.url定义的顺序);如果该管理服务器宕机，将自动向下一个管理服务器注册。如果为false，将在所有管理服务器上注册。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.health-url</td> 
 <td>根据management-url和endpoint .health.id</td> 
 <td>要注册的Health-url。在可达URL不同的情况下可以被重写(例如Docker)。在注册表中必须唯一。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.management-base-url</td> 
 <td>根据management-base-url和management.context-path</td> 
 <td>要注册的Management-url。可被覆盖的情况下可达的url是不同的(例如Docker)。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.service-base-url</td> 
 <td>根据主机名、server.port</td> 
 <td>用于计算service-url 的基本URL。该路径值在运行时进行获取并赋值给 base url。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.service-url</td> 
 <td>根据service-base-url和server.context-path</td> 
 <td>要注册的Service-url。可被覆盖的情况下可达的url是不同的(例如Docker)。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.service-path</td> 
 <td>/</td> 
 <td>要注册的服务路径。在可达路径不同的情况下可以被重写(例如，以编程方式设置的上下文路径)。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.name</td> 
 <td>${spring.application.name}</td> 
 <td>注册的服务名称，覆盖spring.application.name</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.prefer-ip</td> 
 <td>false</td> 
 <td>在注册的url中使用ip地址而不是主机名。如果true,将使用ip:port。否则将使用InetAddress.getLocalHost()返回的IP地址。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.metadata.*</td> 
 <td></td> 
 <td>与此实例关联的元数据键-值对。</td> 
 </tr> 
 <tr> 
 <td>spring.boot.admin.client.instance.metadata.tags.*</td> 
 <td></td> 
 <td>标记为与此实例关联的键-值对。</td> 
 </tr> 
 </tbody> 
</table>

### 3、微服务 ###

除特别说明外，都是在上面的基础上添加

#### 3.1、服务端 ####

**1、添加依赖**

<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，有返回值，就可提取里面的信息，报错了说明没有该服务没有启动

结果展示：如我的预警内容，发送当前服务状态、当前服务剩余健康实例、其他健康服务数等等  
![在这里插入图片描述][c3e02ccd276f455aa651cbc5c237562f.png]

[131a27ca1c894203b9c9f3ee783df685.png]: https://img-blog.csdnimg.cn/131a27ca1c894203b9c9f3ee783df685.png
[7ffc1de2d1414f149fcce12d5acf4af8.png]: https://img-blog.csdnimg.cn/7ffc1de2d1414f149fcce12d5acf4af8.png
[2672a2a49cfb4b239a8d24d90dfacba8.png]: https://img-blog.csdnimg.cn/2672a2a49cfb4b239a8d24d90dfacba8.png
[942a63357d764c8ca30c2258b752b027.png]: https://img-blog.csdnimg.cn/942a63357d764c8ca30c2258b752b027.png
[c9d0097b19ca4694b68c4708fb9a1e89.png]: https://img-blog.csdnimg.cn/c9d0097b19ca4694b68c4708fb9a1e89.png
[64ab6ac4782c4222977a9ae1b0f211b7.png]: https://img-blog.csdnimg.cn/64ab6ac4782c4222977a9ae1b0f211b7.png
[29cabde0956c42658d19bb24dbd1b5ad.png]: https://img-blog.csdnimg.cn/29cabde0956c42658d19bb24dbd1b5ad.png
[c3e02ccd276f455aa651cbc5c237562f.png]: https://img-blog.csdnimg.cn/c3e02ccd276f455aa651cbc5c237562f.png