SpringBoot Admin 详解

一、Actuator 详解
- 1.Actuator原生端点
- - 1.1 监控检查端点：health
  - 1.2 应用信息端点：info
  - 1.3 http调用记录端点：httptrace
  - 1.4 堆栈信息端点：heapdump
  - 1.5 线程信息端点：threaddump
  - 1.6 获取全量Bean的端点：beans
  - 1.7 条件自动配置端点：conditions
  - 1.8 配置属性端点：configprops
  - 1.9 追踪度量端点：metrics
  - 1.10 根据名称追踪度量端点：metrics/{name}
  - 1.11 获取全部环境端点：env
  - 1.12 根据名称获取环境属性端点：env/{name}
  - 1.13 审计事件端点：auditevents
  - 1.14 停止Actuator端点：shutdown
- 2.使用Actuator
- - 2.1 引入依赖
  - 2.2 增加配置信息
  - 2.3 验证端点
  - 2.5 自定义根路径
二、SpringBoot Admin 详解
- 1.服务端搭建
- - 1.1 引入依赖
  - 1.2 启动类增加注解
  - 1.3 启动服务
- 2.客户端搭建
- - 2.1 引入依赖
  - 2.2 增加application.yml配置
  - 2.3 启动客户端
三、SpringBoot Admin功能展示
- 1.功能介绍-细节
- 2.功能介绍-环境
- 3.功能介绍-类
- 4.功能介绍-配置属性
- 5.功能介绍-日志配置
- 6.功能介绍-JVM
- 7.功能介绍-映射

SpringBoot Admin是一个三方的监控和服务管理组件，常用于服务监控的检查，服务元信息获取，是一个轻量且简单的组件。他依赖于Actuator暴漏的接口完成大部分功能，Actuator是一个用于提供服务多种监控接口的组件。这里先总结Actuator的用法，再介绍SpringBoot Admin集成Actuator以后如何使用。

一、Actuator 详解

Actuator是一个可以快速集成在SpringBoot项目中的组件，他支持对单个项目暴露监控接口，同时还支持自定义的监控接口，方便我们进行自定义的一些信息监控，比如说health这个是用途最广范的接口，经常被用来做服务的健康检查，企业中有各种各样的监控组件，但无论使用何种监控组件都需要有一个接口对外提供健康信息展示，那health就可以做这个事情。

1.Actuator原生端点

所谓原生端点（Endpoint）就是指Actuator自带的监控接口，这些接口是最常用、最普遍的监控类接口，适用于大多数场景，一般这些场景是完全够用的了，除非有特殊场景，否则是无需自己定义端点信息的。下面根据这些监控接口的常用频率来由高到底进行说明。

1.1 监控检查端点：health

接口地址：/health
请求方式：GET
端点作用：验证服务是否健康，是否在线的接口，这个也是最常用的接口，一般对服务的监控监控都是使用该接口，SpringBoot项目基本都会使用该接口做健康监控。

1.2 应用信息端点：info

接口地址：/info
请求方式：GET
端点作用：获取自定义的info信息，使用时需要在配置文件增加info开头的配置信息，比如如下：

1.3 http调用记录端点：httptrace

接口地址：/httptrace
请求方式：GET
端点作用：默认显示最近100次的http调用记录，包含请求和响应

1.4 堆栈信息端点：heapdump

接口地址：/heapdump
请求方式：GET
端点地址：可以返回一份jvm的堆信息，这个功能和jvm参数的堆转存储快照类似

1.5 线程信息端点：threaddump

接口地址：/threaddump
请求方式：GET
端点作用：获取线程活动的信息

1.6 获取全量Bean的端点：beans

接口地址：/beans
请求方式：GET
端点作用：获取服务中全部的Bean的信息

1.7 条件自动配置端点：conditions

接口地址：/conditions
请求方式：GET
端点作用：用于显示系统中使用条件进行装配的信息的情况，常见的有ConditionalOnProperty等，只有满足某些条件才会进行操作，此端点用于显示此类的条件满足情况。

1.8 配置属性端点：configprops

接口地址：/configprops
请求方式：GET
端点作用：描述的是属性被Bean加载的信息

1.9 追踪度量端点：metrics

接口地址：/metrics
请求方式：GET
端点作用：内存、http等信息的追踪展示

1.10 根据名称追踪度量端点：metrics/{name}

接口地址：/metrics/{name}
请求方式：GET
端点作用：指定名称的展示

1.11 获取全部环境端点：env

接口地址：/env
请求方式：GET
端点作用：获取服务的全部环境信息

1.12 根据名称获取环境属性端点：env/{name}

接口地址：/env/{name}
请求方式：GET
端点作用：指定名称获取对应环境属性的值

1.13 审计事件端点：auditevents

接口地址：/auditevents
请求方式：GET
端点作用：显示应用的审计事件，比如认证失败等

1.14 停止Actuator端点：shutdown

接口地址：/shutdown
请求方式：POST
端点作用：用以关闭Actuator所在的应用服务，注意只有这个是POST，使用他可以不用进入服务器就实现应用的关闭，比如某个服务异常了，想要将这个服务从集群中剔除出去，就可以使用这个功能。

2.使用Actuator

这里使用一个SpringBoot项目进行测试Actuator的提供的这些接口。注意这个项目得是web项目。

2.1 引入依赖

这里需要至少引入web和Actuator的依赖


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

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
     <version>2.6.11</version>
 </dependency>

2.2 增加配置信息

如果不增加配置信息，上面的这些监控接口就只有个别的开启了，大部分是不可用的，比如health是开启的但也只展示在线信息，所以我们需要开启其他端点。下面的配置信息都有详细的注解，这里不做多余的解释了，解释详见配置上的注释，正常生产使用这些配置也完全够用了：

server:
  port: 8093

#  配置应用名称, 方便监控使用
spring:
  application:
    name: test-actuator
    version: 1.0.0


# 暴露监控端点
management:
  endpoints:
    web:
      exposure:
        # 配置需要暴露出去的端点，一般直接*暴露全部就行
        include: "*"
  endpoint:
    health:
      # health 默认只展示 是否在线，增加该配置后会展示更多信息
      show-details: ALWAYS
    shutdown:
      # 启用关闭应用的功能，不启用则无法关闭应用
      enabled: true
  info:
    env:
      # 开启info端点的配置支持，不开启info将无信息返回，即使配置了info也无信息
      enabled: true
# 自定义info端点信息，info端点获取的就是这里的信息
info:
  title: ${spring.application.name}服务
  version: ${spring.application.name}-${spring.application.version}
  description: ${spring.application.name}服务监控

2.3 验证端点

上面配置增加完以后就可以启动服务了，这里基本不会有任何意外，然后开始验证接口。

验证health端点
注意这里actuator是固定前缀，支持更改（生产如果处于安全考虑可以更改）：
```
http://localhost:8093/actuator/health
```
health端点的信息如下，这里包含了在线状态服务器的ping状态，服务器的磁盘信息等。
验证info端点
info端点的信息是自定义信息，这里验证是否返回的是我们自定义的信息
```
http://localhost:8093/actuator/info
```
可以看到返回的正式我们自定义的信息，这里信息可以随便指定，title、version等名称都是随便指定的。
验证beans端点
这个是获取全量bean信息的端点
```
http://localhost:8093/actuator/beans
```
结果如下图，也没啥问题
验证shutdown端点
这个接口需要使用POST方式进行调用
```
http://localhost:8093/actuator/shutdown
```
然后借助postman进行调用测试，结果如下：

然后观察应用程序，发现确实已经被关闭了：
验证jvm端快照端点
这个可以用来观察生产实时的堆信息，还是有一些作用的。
```
http://localhost:8093/actuator/heapdump
```
请求后会直接下载一份堆信息，需要我们使用对应工具才可以打开，网上一堆这种在线工具，下面是执行截图：

可以随便找个在线工具打开看看，这里笔者用的是这个：https://heaphero.io/heap-index.jsp#header
分析结果如下，这里不做jvm知识的拓展了，从下图可以看到已经正常分析出了堆的信息了，说明我们拿到的dump文件时可用的：

端点验证就不一一验证了。

2.5 自定义根路径

上面也提到过，Actuator是支持自定义根路径的，如果使用根路径会有一些安全隐患，比如别人通过抓包知道了你的接口地址，就可以使用Actuator的接口使用DOS进行攻击你的系统，这是有安全隐患的，解决这个办法有的是去集成认证，有的是更改默认地址，默认地址更改后就很难猜出来真正的端点地址了。所以这里建议生产更改默认的接口地址，如下：

# 暴露监控端点
management:
  endpoints:
    web:
      # 这是监控的默认根路径，支持自定义
      base-path: /observe

重启服务进行验证，如下，可见地址更改生效：
在这里插入图片描述

二、SpringBoot Admin 详解

SpringBoot Admin是一个在github上开元的社区项目，通过使用Actuator暴漏的端点来是实现项目的可视化监控和管理。SpringBoot Admin是一个简单易用的小组件，易上手，可以作为中小公司健康监控系统的使用是没有太大问题的。
SpringBoot Admin是一个BS架构，分为客户端和服务端，这里分别就进行介绍。

1.服务端搭建

服务端搭建也比较简单，只需要少量的配置就可以运行，首先我们需要导入所需服务端的依赖

1.1 引入依赖

这里需要引入web和admin-server两个依赖，admin监控的肯定是web服务，所以这里引入web依赖。

<!-- 版本保持与springboot统一即可 -->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.6.11</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.6.11</version>
</dependency>

1.2 启动类增加注解

这个也比较简单，直接启动类上增加一个注解即可，用以表示admin的服务端。

@EnableAdminServer

如下：
在这里插入图片描述

1.3 启动服务

只需要简单的两步导入依赖和增加注解即可开启一个服务端，服务启动基本不会有任何异常，服务启动完成以后，然后打开如下地址：

# applications 是默认地址
http://localhost:8094/applications

然后展示如下，此时没有客户端，所有目前这里没有任何信息，信息的展示需要等到客户端同样启动以后才会有展示：
在这里插入图片描述

2.客户端搭建

客户端搭建也很简单，只需要引入web依赖和admin的客户端依赖就行，注意客户端不需要重复引入Actuator的依赖，因为Admin的客户端已经默认引入了这个依赖。

2.1 引入依赖

<!-- 客户端依赖版本保持和服务端一致 -->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.6.11</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.6.11</version>
</dependency>

2.2 增加application.yml配置

客户端因为默认是集成了Actuator的，所以我们上面使用的Actuator的配置依然是可用的，只需要在原有的Actuator的配置基础上增加服务端地址的信息指定即可，客户端全部配置信息如下：

server:
  port: 8093

#  配置应用名称, 方便监控使用
spring:
  application:
    name: test-actuator
    version: 1.0.0
  boot:
    admin:
      client:
        # 指定admin-server的地址
        url:  http://localhost:8094


# 暴露监控端点
management:
  endpoints:
    web:
      exposure:
        # 配置需要暴露出去的端点，一般直接*暴露全部就行
        include: "*"
      # 这是监控的默认根路径，支持自定义
      base-path: /observe
  endpoint:
    health:
      # health 默认只展示 是否在线，增加该配置后会展示更多信息
      show-details: ALWAYS
    shutdown:
      # 启用关闭应用的功能，不启用则无法关闭应用
      enabled: true
  info:
    env:
      # 开启info端点的配置支持，即使配置了info也无信息
      enabled: true
# 自定以info端点信息，info端点获取的就是这里的信息
info:
  title: ${spring.application.name}服务
  version: ${spring.application.name}-${spring.application.version}
  description: ${spring.application.name}服务监控

2.3 启动客户端

添加完配置以后直接启动客户端服务就行了，客户端服务启动完成后就可以导服务端的页面中查看信息了，服务端地址：http://localhost:8094/applications
信息展示如下：
在这里插入图片描述
到这里客户端和服务端的搭建就全部完成了，以下介绍下admin的使用。

三、SpringBoot Admin功能展示

SpringBoot Admin其实就是将Actuator暴露的端点进行了可视化，这里大部分的接口都是Actuator提供的。
在admin-server的首页点击服务名，如下
在这里插入图片描述
然后会弹出如下的服务信息，这里继续点击服务名，即可进入到当前服务的监控页面了

点击后进入到下面的页面，几乎主要的功能都在这里了：

或者也可以从如下位置直接点击进入到上图的页面：

1.功能介绍-细节

细节这块的信息，仔细一看就会比较熟悉了，基础展示如下：
信息：展示的是info端点的信息。
监控：展示的就是health的信息
元数据：项目的启动时间
进程：项目的进程id使用的cpu等信息
线程：线程的总数与当前系统使用的线程数
垃圾回收：jvm垃圾回收的次数与耗时
内存heap：jvm堆使用信息
non heap：jvm栈的使用信息
在这里插入图片描述