目录
5.1.1 认识 SpringBoot Actuator
- Actuator Endpoints（端点）
- Endpoints 是 Actuator 的核心部分，它用来监视应用程序以及交互；SpringBoot Actuator 内置好多 Endpoints，并且支持扩展
- SpringBoot Actuator 提供的原生端点有三类：
- 应用配置类：自动配置信息、Spring Bean 信息、yml 文件信息、环境信息等
- 度量指标类：主要是运行期间的动态信息，例如堆栈、健康指标、metrics信息等
- 操作控制类：主要是指 shutdown，用户可以发送一个请求将应用的监控功能关闭
# 暴露端点
management:
endpoints:
web:
exposure:
include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 *, 可以开放所有端点
endpoint:
health:
show-details: always
5.1.2 搭建SpringBootAdmin监控服务器
- 搭建监控服务器的步骤
- 添加SpringBoot Admin Starter 自动配置依赖
- 添加启动注解：@EnableAdminServer
5.1.2.1 创建 sca-commerce-admin 子项目
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>sca-commerce</artifactId>
<groupId>com.edcode.commerce</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>sca-commerce-admin</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<!-- 模块名及描述信息 -->
<name>sca-commerce-admin</name>
<description>监控服务器</description>
<dependencies>
<!-- spring cloud alibaba nacos discovery 依赖 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2.2.3.RELEASE</version>
</dependency>
<!-- SpringBoot Admin -->
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-server</artifactId>
<version>2.2.0</version>
</dependency>
<dependency>
<groupId>com.edcode.commerce</groupId>
<artifactId>sca-commerce-mvc-config</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
<!--
SpringBoot的Maven插件, 能够以Maven的方式为应用提供SpringBoot的支持，可以将
SpringBoot应用打包为可执行的jar或war文件, 然后以通常的方式运行SpringBoot应用
-->
<build>
<finalName>${artifactId}</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
bootstrap.yml
server:
port: 7001
servlet:
context-path: /sca-commerce-admin
spring:
application:
name: sca-commerce-admin
cloud:
nacos:
# 服务注册发现
discovery:
enabled: true # 如果不想使用 Nacos 进行服务注册和发现, 设置为 false 即可
#server-addr: ${NACOS_ADDR:127.0.0.1}:8848
server-addr: ${NACOS_ADDR_1:192.168.3.250}:8848,${NACOS_ADDR_2:127.0.0.1}:8849,${NACOS_ADDR_3:127.0.0.1}:8850 # Nacos 服务器地址
namespace: ${NAMESPACE_ID:1adcfdd8-5763-4768-9a15-9c7157988950}
metadata:
management:
context-path: ${server.servlet.context-path}/actuator
thymeleaf:
check-template: false
check-template-location: false
# 暴露端点
management:
endpoints:
web:
exposure:
include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 *, 可以开放所有端点
endpoint:
health:
show-details: always
AdminApplication
package com.edcode.commerce;
import de.codecentric.boot.admin.server.config.EnableAdminServer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author eddie.lee
* @blog blog.eddilee.cn
* @description 监控中心服务器启动入口
*/
@EnableAdminServer
@SpringBootApplication
public class AdminApplication {
public static void main(String[] args) {
SpringApplication.run(AdminApplication.class, args);
}
}
访问 Web 页面
地址：http://127.0.0.1:7001/sca-commerce-admin/applications/sca-commerce-admin
点击 “应用墙”
点击中间图标
进入到该服务的详细信息页
5.1.3 应用注册到 SpringBoot Admin Server
- 被监控和管理的应用（微服务），注册到 Admin Server 的两种方式
- 方式一：被监控和管理的应用程序，使用 SpringBoot Admin Client 库，通过 HTTP 调用注册到 SpringBoot Admin Server 上
- 方式二：首先，被监控和管理的应用程序，注册到 SpringCloud 集成的注册中心；然后 SpringBoot Admin Server 通过注册中心获取到被监控和管理的应用程序
推荐：方式二
5.1.3.1 改造 sca-commerce-alibaba-nacos-client 子项目
bootstrap.yml 追加 actuator
spring:
application:
name: sca-commerce-nacos-client # 应用名称也是构成 Nacos 配置管理 dataId 字段的一部分 (当 config.prefix 为空时)
cloud:
nacos:
# 服务注册发现
discovery:
enabled: true # 如果不想使用 Nacos 进行服务注册和发现, 设置为 false 即可
#server-addr: ${NACOS_ADDR:127.0.0.1}:8848
server-addr: ${NACOS_ADDR_1:192.168.3.250}:8848,${NACOS_ADDR_2:127.0.0.1}:8849,${NACOS_ADDR_3:127.0.0.1}:8850 # Nacos 服务器地址
namespace: ${NAMESPACE_ID:1adcfdd8-5763-4768-9a15-9c7157988950}
###########
######### 在原来基础上追加 actuator ###########
###########
metadata:
management:
context-path: ${server.servlet.context-path}/actuator
然后，就可以启动 sca-commerce-alibaba-nacos-client 子项目
查看 Nacos 是否注册上
查看 SpringBoot Admin
5.2.1 监控中心服务器添加安全访问控制
5.2.1.1 引用 Spring Security 依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
5.2.1.2 改造 bootstrap.yml 配置
server:
port: 7001
servlet:
context-path: /sca-commerce-admin
spring:
application:
name: sca-commerce-admin
#####
##### 为 security 设置账户密码 #####
security:
user:
name: ${ADMIN_SECURITY_USER:admin}
password: ${ADMIN_SECURITY_PASSWORD:123456}
cloud:
nacos:
# 服务注册发现
discovery:
enabled: true # 如果不想使用 Nacos 进行服务注册和发现, 设置为 false 即可
#server-addr: ${NACOS_ADDR:127.0.0.1}:8848
server-addr: ${NACOS_ADDR_1:127.0.0.1}:8848,${NACOS_ADDR_2:127.0.0.1}:8849,${NACOS_ADDR_3:127.0.0.1}:8850 # Nacos 服务器地址
namespace: ${NAMESPACE_ID:1adcfdd8-5763-4768-9a15-9c7157988950}
metadata:
management:
context-path: ${server.servlet.context-path}/actuator
#####
##### 为 security 设置账户密码 #####
user.name: ${ADMIN_SECURITY_USER:admin}
user.password: ${ADMIN_SECURITY_PASSWORD:123456}
thymeleaf:
check-template: false
check-template-location: false
# 暴露端点
management:
endpoints:
web:
exposure:
include: '*' # 需要开放的端点。默认值只打开 health 和 info 两个端点。通过设置 *, 可以开放所有端点
endpoint:
health:
show-details: always
只需要在 sca-commerce-admin 子工程改造即可，其余子工程不需要改动
5.2.1.3 打开 SpringBoot Admin Web
http://127.0.0.1:7001/sca-commerce-admin/login
5.3.1 自定义告警
5.3.1.1 方式一：邮件方式
pom.xml
<!-- 实现对 Java Mail 的自动化配置 -->
<!-- https://blog.csdn.net/yimcarson/article/details/84936440 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
bootstrap.yml
spring:
# 被监控的应用状态变更为 DOWN、OFFLINE、UNKNOWN 时, 会自动发出告警: 实例的状态、原因、实例地址等信息
# 需要在 pom.xml 文件中添加 spring-boot-starter-mail 依赖
# 配置发送告警的邮箱服务器
# 但是, 这个要能连接上, 否则会报错
mail:
host: smtp.qq.com
port: 587
username: ${ADMIN_EMAIL_USERNAME:xxx@qq.com}
password: ${ADMIN_EMAIL_PASSWORD:123456}
default-encoding: UTF-8
# 监控告警通知
boot:
admin:
notify:
mail:
from: ${spring.mail.username}
to: ${ADMIN_EMAIL_USERNAME:xxx@qq.com}
cc: ${ADMIN_EMAIL_USERNAME:xxx@qq.com}
- 测试步骤
- 启动 sca-commerce-admin、sca-commerce-alibaba-nacos-client
- 关闭 sca-commerce-alibaba-nacos-client
- 查看邮件
5.3.1.2 方式二：自定义告警
package com.edcode.commerce.notifier;
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.domain.events.InstanceStatusChangedEvent;
import de.codecentric.boot.admin.server.notify.AbstractEventNotifier;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;
/**
* @author eddie.lee
* @blog blog.eddilee.cn
* @description 自定义告警
*/
@Slf4j
@Component
@SuppressWarnings("all")
public class QinyiNotifier extends AbstractEventNotifier {
protected QinyiNotifier(InstanceRepository repository) {
super(repository);
}
/**
* <h2>实现对事件的通知</h2>
* */
@Override
protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
return Mono.fromRunnable(() -> {
if (event instanceof InstanceStatusChangedEvent) {
log.info("Instance Status Change: [{}], [{}], [{}]",
instance.getRegistration().getName(), event.getInstance(),
((InstanceStatusChangedEvent) event).getStatusInfo().getStatus());
} else {
log.info("Instance Info: [{}], [{}], [{}]",
instance.getRegistration().getName(), event.getInstance(),
event.getType());
}
});
}
}
测试步骤和上面一样，只是没有集成短信之类通知，只能在 IDEA Console 查看打印日志信息
自定义告警的好处：可以把现在打印的 log.info 当成短信啊 或者 第三方的集成通知，发送给管理员、开发人员等
210
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
