Spring Boot ActuatorAdmin

news2025/1/12 8:44:57

Spring Boot Actuator&Admin

指标监控简介

干嘛的:

主要运用在微服务架构,所以我建议你先学微服务,否则可能get不到它的用处,只有大型的分布式系统才会用到指标监控… Why:?

对于一个大型的几十个、几百个微服务构成的微服务架构系统,在线上时通常会遇到下面一些问题,比如:

  1. 如何知道哪些服务除了问题,如何快速定位? (健康状况)
  2. 如何统一监控各个微服务的性能指标(内存、jvm、并发数、线程池、Http 请求统计)
  3. 如何统一管理各个微服务的日志?(切换线上日志等级,快速搜索日志…)
  4. 如何优雅管理服务下线(正在运行的线程不发生中断)

So: 在这种大型分布式应用的环境下,我们如何能够快速发现问题、快速解决问题, 必须要有监控平台、(链路追踪、日志)

SpringBoot Actuator

SpringBoot自带监控功能Actuator,可以帮助实现对程序内部运行情况监控,比如监控状况、Bean加载情况、环境变量、日志信息、线程信息等

依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

Actuator Endpoint端点

官方文档:https://docs.spring.io/spring-boot/docs/2.4.10/reference/html/production-ready-features.html#production-ready-endpoints

总之使用了actuator之后我们就可以通过http或者 JMX方式 获取应用的一些指标信息

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A4nMBV2l-1670331038967)(C:\Users\jeol\AppData\Roaming\Typora\typora-user-images\image-20221118190037432.png)]

JMX方式查看EndPoint

这里是使用jconsole命令来查看这些信息

http获取EndPoint信息

http部分端点信息是被限制访问的,springboot中添加如下配置开启权限

management:
  endpoints:
    web:
      exposure:
        include: '*'

然后通过请求项目根路径 + /actuator + /EndPoint名称

当然你也可以直接调用项目根路径 + /actuator 获取所有可以调用的endpoint的uri

shutdown:优雅关闭

优雅的关闭应用

配置

# 对应枚举类org.springframework.boot.web.server.Shutdown 优雅关闭和立即关闭两个枚举值
server:
  shutdown: graceful
  
management:
  endpoints:
    web:
      exposure:
        include: '*'
  endpoint:
    shutdown:
      enabled: true # 设置shutdown断点开启关闭,默认是关闭的  

然后post访问 http://localhost:8005/nacos-producer/actuator/shutdown

修改默认的访问路径
# 设置actuator的base-path
management.endpoints.web.base-path= /system

修改后

请求项目根路径 +/system + /EndPoint名称

单独控制某个断点启用
# 是否启用端点默认配置
management.endpoints.enabled-by-default=false
# 启用info端点
management.endpoint.info.enabled=true
security 保护endpoint

就是设置一个角色 ,需要权限才能访问

@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
    http.requestMatcher(EndpointRequest.toAnyEndpoint()).authorizeRequests((requests) ->
        requests.anyRequest().hasRole("ENDPOINT_ADMIN"));
    http.httpBasic();
    return http.build();
}
其他配置

比如jmx不再允许访问所有endpoint,比如排除特定的endpoint不公开等等,请查看官网

Spring Boot Admin

可视化监控平台, 是一个基于 Spring Boot Actuator 端点之上的 Vue.js 应用程序。

官方文档:https://github.com/codecentric/spring-boot-admin

快速搭建

服务端

依赖
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-server</artifactId>
            <version>2.6.9</version>
        </dependency>
代码

启动类添加@EnableAdminServer

@SpringBootApplication
@Slf4j
@EnableAdminServer
public class BootAdminApplication {

    public static void main(String[] args) {

        SpringApplication.run(BootAdminApplication.class, args);
        log.info("{} startup success", "BootAdminApplication");
    }
}

客户端

依赖
        <!--spring-boot-admin 客户端依赖-->
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-starter-client</artifactId>
            <version>2.6.9</version>
        </dependency>
配置
spring.boot:
    admin:
      client:
        url: http://localhost:8728

management:
  endpoints:
    web:
      exposure:
        include: '*'
#      base-path: /system # 设置actuator的base-path
    enabled-by-default: true  # 是否启用端点
  endpoint:
    shutdown:
      enabled: true # 设置shutdown断点开启关闭,默认是关闭的
    health:
      show-details: always # 就会显示健康状态的详细指标

默认使用应用名称注册,可以选择使用ip注册

spring:
 boot:
    admin:
      client:
        url: http://localhost:8080
        instance:
          prefer-ip: true # 使用ip注册进来
  application:
    name: boot-05-web-admin # 客户端名称

成功测试

admin服务端安全防护

默认是不需要密码就可以访问的,这里使用springSecrity 来支持基础的用户名密码登录

官方文档:https://codecentric.github.io/spring-boot-admin/2.6.6/#_securing_spring_boot_admin_server

        <!--安全问题-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>

@Configuration(proxyBeanMethods = false)
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {

  private final AdminServerProperties adminServer;

  private final SecurityProperties security;

  public SecuritySecureConfig(AdminServerProperties adminServer, SecurityProperties security) {
    this.adminServer = adminServer;
    this.security = security;
  }

  @Override
  protected void configure(HttpSecurity http) throws Exception {
    SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
    successHandler.setTargetUrlParameter("redirectTo");
    successHandler.setDefaultTargetUrl(this.adminServer.path("/"));

    http.authorizeRequests(
        (authorizeRequests) -> authorizeRequests.antMatchers(this.adminServer.path("/assets/**")).permitAll() 
            .antMatchers(this.adminServer.path("/actuator/info")).permitAll()
            .antMatchers(this.adminServer.path("/actuator/health")).permitAll()
            .antMatchers(this.adminServer.path("/login")).permitAll().anyRequest().authenticated() 
    ).formLogin(
        (formLogin) -> formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler).and() 
    ).logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout"))).httpBasic(Customizer.withDefaults()) 
        .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) 
            .ignoringRequestMatchers(
                new AntPathRequestMatcher(this.adminServer.path("/instances"),
                    HttpMethod.POST.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/instances/*"),
                    HttpMethod.DELETE.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/actuator/**")) 
            ))
        .rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));
  }

  // Required to provide UserDetailsService for "remember functionality"
  @Override
  protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.inMemoryAuthentication().withUser(security.getUser().getName())
        .password("{noop}" + security.getUser().getPassword()).roles("USER");
  }

}
  • 授予对所有静态资产和登录页面的公共访问权。
  • 所有其他请求都必须经过身份验证。
  • 配置登录和注销。
  • 启用HTTP基本支持。这是Spring Boot Admin Client注册所需的。
  • 使用Cookie启用CSRF保护
  • 为Spring Boot Admin Client用于(取消)注册的端点禁用CSRF保护。
  • 禁用致动器端点的CSRF保护。
spring.security:
    user:
      name: sry
      password: 123456

通过注册中心集成客户端

如果你有成百上千个微服务, 这样配置未免太麻烦。如果您已经为您的应用程序使用了 Spring Cloud (Alibaba-nacos) Discovery,那么您就不需要 SBA 客户端。只需在 Spring Boot Admin Server 中添加一个 DiscoveryClient,剩下的工作由我们的 AutoConfiguration 完成。

下面的步骤使用 Nacos,但是也支持其他 SpringDiscovery实现。

服务端添加依赖

        <!--nacos-服务注册发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

服务端添加配置

spring:
  cloud:
    nacos:
      # 需要注意的是客户客户端会在此端口+1000的基础上获取通信端口,具体参考nacos安装中的几个端口
      server-addr: 61.171.5.6:30848
      discovery:
        username: nacos
        password: nacos
        # group: nacos-producer1  # 默认使用DEFAULT_GROUP作为分组名称
        #service: nacos-producer1 # 默认使用spring.application.name作为服务名称
#        namespace: public #指定命名空间 ,

# 也会将SBA服务配置为客户端, 所以也可以配置自己的endpoint规则(可选)
management:
  endpoints:
    web:
      exposure:
        include: '*'
  endpoint:
    health:
      show-details: always # 就会显示健康状态的详细指标

客户端

客户端就不需要spring-boot-admin-starter-client依赖了,也不需要指定服务端地址,只需要开启endpoint的访问配置即可

如果服务端不是通过注册中心进行获取客户端 ,需要单独为客户端配置,因为不配置客户端无法向服务端注册应用( 没有配置不会报错,只是在监控台看不到应用,也就是没有注册进去)

spring.boot.admin.client:
   username: sry
   password: 123456

问题

应用下线后

Did not observe any item or terminal signal within 10000ms in

常用配置

Health:监控状况

  • 一个组件指标状态为Down则总状态信息Down,很多组件中都定制了Health子节点指标: 比如jdbc、redis、等等

Metrics:运行时指标

缺省情况下的指标信息:

  • 如需查看某一指标可以在URL后面加上对应的指标名称

    • 如要查看http.server.requests指标:则访问actuator/metrics/http.server.requests
  • 还可以传入tag过滤具体数据:/metrics/http.server.requests?tag=method:GET

    • 所有tag都可以作为参数(大小写敏感)

Logfile:远程日志跟踪

必须按如下配置设置日志添加到文件中,一旦设置会出现一个 /actuator/logfile 端点

logging:
  file:
    name: D:/logs/xushu.log

如果使用的是配置文件,这个就不行了

treaddump && heapdump

使用jvisualvm进行分析线程信息和堆信息

邮件通知

如果服务下线,会进行邮件通知

在spring boot amdin 服务端修改

仅做记录

       <!--邮件通知-->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-mail</artifactId>
       </dependency> 
spring: 
  mail:
    # 发件人使用的qq邮箱服务
    host: smtp.qq.com
    username: tulingxushu@foxmail.com
    # 授权码,不是密码,在qq邮箱设置-账号里面有生成授权码
    password: bktymeooyuapggbe
  boot:
    admin:
      notify:
        mail:
          # 收件人,多个中间用,分隔
          to: tulingxushu@foxmail.com
          # 发件人
          from: tulingxushu@foxmail.com

还需要开启邮箱的smtp服务

定制endpoint

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/76243.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

低代码如何自定义主题?一文教会你

SuccAP低代码开发平台&#xff0c;除了提供了多主题供选择外&#xff0c;还支持自定义报表主题&#xff0c;当系统自带的主题无法满足项目需求时&#xff0c;可以根据项目设计并新增主题&#xff0c;本文将介绍如何去新增自定义主题。 新增自定义主题可按如下步骤操作&#xf…

APS高级计划排程在乳制品行业的应用

目前乳制品行业供应链管理中存在的主要问题 生产盲目性&#xff0c;应对市场变化能力不足。现如今牛奶已经成为人们日常饮食需求的必需品&#xff0c;很多生产厂家就开始大量的生产&#xff0c;全然不顾市场的需求度&#xff0c;应对市场变化的能力不足&#xff0c;导致了有一…

计算机毕业设计ssm+vue基本微信小程序的心理服务平台 uniapp 小程序

项目介绍 随着计算机技术的发展,带来社会各行业的进步,信息化逐渐运用到人们的生活中。传统模式的青少年心理健康管理满足不了现代人的生活追求,服务质量、服务速度,之前的很多网站由于功能、或者框架设计等原因,无法完美的展现它的特色,优势,浪费了很多资源。使用管理系统进行…

今天步行数5000多

今天步行数量比较多的&#xff0c;有五千多步吧&#xff0c;希望明天能继续保持下去。

企业知识分享系统的设计与实现

摘 要 随着信息技术和网络技术的飞速发展&#xff0c;人类已进入全新信息化时代&#xff0c;传统管理技术已无法高效&#xff0c;便捷地管理信息。为了迎合时代需求&#xff0c;优化管理效率&#xff0c;各种各样的管理系统应运而生&#xff0c;各行各业相继进入信息管理时代&…

两种方案解决vscode浏览器跨域问题

一、 问题 1.1 在接收 json 数据的时候出现了以下错误&#xff1b; 打开测试用的 json 文件发现数据并没有问题&#xff0c;而第一个报错可以看到 Cross origin requests are only supported for protocol schemes&#xff1a;… &#xff0c;也就是说所使用的数据不在跨域的许…

毕业后5年,我终于变成了月薪13000的软件测试工程师

目录 我为什么选择转行 工作环境 我选择了转行软件测试 写在最后 《软件测试工程师发展规划路线》 一、测试基础 了解测试的基础技能&#xff0c;掌握主流缺陷管理工具的使用&#xff0c;熟练测试环境的操作与运维 二、Linux必备知识 Linux作为现在最流行的软件环境系…

场景案例│数字员工助力医疗行业打通信息系统壁垒,实现高效率运营

据埃森哲研究预测&#xff0c;到2026年人工智能技术每年将为医疗保健行业节省1500亿美元。 随着人们对数字化的需求日益增长&#xff0c;数字技术成为转型升级的新兴力量&#xff0c;许多医疗机构积极采用数字员工推进数字化转型的步伐。 在数字员工的支持下&#xff0c;医疗…

Redis Replication

高可用架构-Redis Replication 今天学习下如何基于Redis 复制功能构建高可用架构-主从复制&#xff0c;Redis Replication 支持数据复制和故障切换。Redis复制是允许Redis实例完全复制主实例的过程。默认情况下&#xff0c;复制是一个异步过程。Redis复制在主机端和副本端都是…

2023最新SSM计算机毕业设计选题大全(附源码+LW)之java毕业设计选题档案管理系统bvr3c

毕业设计其实不难&#xff0c;主要毕业的时候任务太紧了&#xff0c;所以大家都非常忙没有时间去做&#xff0c;毕业设计还是早做准备比较好&#xff0c;多花点时间也可以做出来的&#xff0c;建议还是自己动手去做&#xff0c;比如先选一个题&#xff0c;这样就有方向&#xf…

Flutter实现文件上传华为对象存储(OBS)

本文主要讲述在 Flutter 项目中如何实现将文件上传到华为 OBS&#xff08;对象存储&#xff09;中&#xff0c;并封装为三方库方便灵活使用。 背景介绍 在大多项目中都会存在文件上传的需求&#xff0c;之前的实现都是调用后台的文件上传接口将文件上传到服务器上&#xff0c;…

从投资人发现“新大陆”,看“产融星城”为何成?

文丨熔财经 作者|陈小江 “我从来不把《我要投资》节目看作是秀&#xff08;综艺&#xff09;&#xff0c;要知道《我要投资》是在前面的&#xff0c;秀&#xff08;综艺&#xff09;只是一种形式而已。本质上&#xff0c;&#xff08;参加节目&#xff09;还是为了投资”。 …

「Redis数据结构」跳跃表(SkipList)

「Redis数据结构」跳跃表&#xff08;SkipList&#xff09; 文章目录「Redis数据结构」跳跃表&#xff08;SkipList&#xff09;一、概述二、结构跳跃表节点跳跃表三、特点一、概述 跳表&#xff08;SkipList&#xff0c;全称跳跃表&#xff09;是用于有序元素序列快速搜索查找…

shell编程二

目录语法引号exprtestif...then...fiif...elseif...elseif嵌套case…esacforwhilebreak 和 continue函数语法 引号 " ":如果有字符串&#xff0c;字符串原样输出&#xff0c;如果有$变量则查看变量的值 :所有的字符无论是否有变量都原样输出 ˋˋ:在该引号包含的…

如何批量查询网站的搜狗收录情况?搜狗收录么查询

如何批量查询网站的搜狗收录情况&#xff1f;搜狗收录么查询 查询网站的搜狗收录的具体操作&#xff1a; 第一步、打开网站综合查询工具 第二步、添加需要查询的网站域名 第三步、勾选要查询的功能&#xff08;勾选搜狗是否收录和搜狗总收录&#xff09; 第…

redis 主从复制(读写分离)集群搭建(含错误处理)

目录 1.概述 2.搭建 2.1.安装配置 2.2.认主 2.3.错误处理 3.原理 1.概述 当面临大流量时&#xff0c;redis可以采取集群的方式进行扩容&#xff0c;将压力分散到集群中的多个结点上去防止redis被打挂。redis的扩容方式有两种&#xff1a; 垂直扩容&#xff0c;即读写分离…

【移动端测试】了解Android的配置和使用过程

Android 是基于JAVA语言来进行开发编写的&#xff0c;但是对于Android体系中最底层是Linux层&#xff0c;现在说一下android 项目的结构目录: 整体结构和一个普通的java项目很类似 每一个项目都有一个主Activity 相当于java类中的main 方法是程序的入口 比如 该项目中的ListVi…

centos7搭建nginx主从以及集群

一、nginx升级之路 之前因为业务量并不是很大&#xff0c;所以公司nginx采用的是单机。因为nginx单机性能也很好&#xff0c;所以也没有发生过什么问题。不过后来还是慢慢进行了几次调整。最终换成了多IP地址解析和nginx主从。下面就介绍一下怎么一步步升级的。 1.最初版本&a…

天翼物联携手6家单位发起移动物联网高质量发展共同倡议

近日&#xff0c;由工信部指导&#xff0c;中国信息通信研究院&#xff08;以下简称“中国信通院”&#xff09;、中国通信学会、无锡市人民政府、人民邮电报社、江苏省工业和信息化厅、江苏省通信管理局共同主办&#xff0c;无锡物联网创新促进中心、天翼物联科技有限公司等单…

uniapp中tabBar菜单栏的实现以及页面常用的生命周期(菜单栏颜色切换)

前言 本篇文章带大家使用uniapp通过小案例实现tab菜单栏的切换&#xff0c;并对页面中常用的生命周期进行介绍。 实现菜单栏的切换 配置page页面 我们这里要实现三个页面的切换&#xff0c;所以要先在page.json文件中配置三个页面的路径 "pages": [ //pages数组…