Spring Cloud Admin健康檢查 郵件、釘釘群通知
原始碼地址:https://github.com/muxiaonong/Spring-Cloud/tree/master/cloudadmin
Admin 簡介
官方文件:What is Spring Boot Admin?
SpringBootAdmin是一個用於管理和監控SpringBoot微服務的社群專案,可以使用客戶端註冊或者Eureka服務發現向服務端提供監控資訊。
注意,服務端相當於提供UI介面,實際的監控資訊由客戶端Actuator提供
通過SpringBootAdmin,你可以通過華麗大氣的介面訪問到整個微服務需要的監控資訊,例如服務健康檢查資訊、CPU、記憶體、作業系統資訊等等
本篇文章使用SpringBoot 2.3.3.RELEASE、SpringCloud Hoxton.SR6、SpringBoot Admin 2.2.3版本,此外,服務註冊中心採用eureka
一、SpringCloud使用SpringBoot Admin
1.1 建立一個SpringBoot專案,命名為admin-test,引入如下依賴
<!-- Admin 服務 --> <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> <version>2.2.1</version> </dependency> <!-- Admin 介面 --> <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-server-ui</artifactId> <version>2.2.1</version> </dependency>
1.2 啟動類
@SpringBootApplication
@EnableAdminServer
public class AdminTestApplication {
public static void main(String[] args) {
SpringApplication.run(AdminTestApplication.class, args);
}
}
1.3 配置檔案
spring.application.name=admin-test management.endpoints.jmx.exposure.include=* management.endpoints.web.exposure.include=* management.endpoint.health.show-details=always # spring cloud access&secret config alibaba.cloud.access-key=**** alibaba.cloud.secret-key=****
1.4 啟動專案
輸入專案地址:http://localhost:8080/applications
二、配置郵件通知
2.1 pom
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
2.2 郵件配置
spring.mail.host=smtp.qq.com
spring.mail.username=單純QQ號
spring.mail.password=授權碼
spring.mail.properties.mail.smpt.auth=true
spring.mail.properties.mail.smpt.starttls.enable=true
spring.mail.properties.mail.smpt.starttls.required=true
#收件郵箱
[email protected]
# 發件郵箱
spring.boot.admin.notify.mail.from= [email protected]
2.3 QQ郵箱設定
找到自己的QQ郵箱
QQ郵箱 》 設定 》 賬戶 》紅框處獲取 授權碼
我們將 consumer 服務下線後,
接著我們就收到了郵件通知,告訴我們服務關閉了
三、傳送釘釘群通知
找到群裡面的 群設定 》 智慧群助手 》 新增機器人
注意:這裡的自定義關鍵詞一定要和專案的關鍵字匹配
獲取 Webhook 到專案中,這個是後面要使用到的
啟動類:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import de.codecentric.boot.admin.server.config.EnableAdminServer;
import de.codecentric.boot.admin.server.domain.entities.InstanceRepository;
@SpringBootApplication
@EnableAdminServer
public class AdminApplication {
public static void main(String[] args) {
SpringApplication.run(AdminApplication.class, args);
}
@Bean
public DingDingNotifier dingDingNotifier(InstanceRepository repository) {
return new DingDingNotifier(repository);
}
}
通知類:
import java.util.Map;
import com.alibaba.fastjson.JSONObject;
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 reactor.core.publisher.Mono;
public class DingDingNotifier extends AbstractStatusChangeNotifier {
public DingDingNotifier(InstanceRepository repository) {
super(repository);
}
@Override
protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
String serviceName = instance.getRegistration().getName();
String serviceUrl = instance.getRegistration().getServiceUrl();
String status = instance.getStatusInfo().getStatus();
Map<String, Object> details = instance.getStatusInfo().getDetails();
StringBuilder str = new StringBuilder();
str.append("服務預警 : 【" + serviceName + "】");
str.append("【服務地址】" + serviceUrl);
str.append("【狀態】" + status);
str.append("【詳情】" + JSONObject.toJSONString(details));
return Mono.fromRunnable(() -> {
DingDingMessageUtil.sendTextMessage(str.toString());
});
}
}
傳送工具類
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import com.alibaba.fastjson.JSONObject;
public class DingDingMessageUtil {
public static String access_token = "Token";
public static void sendTextMessage(String msg) {
try {
Message message = new Message();
message.setMsgtype("text");
message.setText(new MessageInfo(msg));
URL url = new URL("https://oapi.dingtalk.com/robot/send?access_token=" + access_token);
// 建立 http 連線
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoOutput(true);
conn.setDoInput(true);
conn.setUseCaches(false);
conn.setRequestMethod("POST");
conn.setRequestProperty("Charset", "UTF-8");
conn.setRequestProperty("Content-Type", "application/Json; charset=UTF-8");
conn.connect();
OutputStream out = conn.getOutputStream();
String textMessage = JSONObject.toJSONString(message);
byte[] data = textMessage.getBytes();
out.write(data);
out.flush();
out.close();
InputStream in = conn.getInputStream();
byte[] data1 = new byte[in.available()];
in.read(data1);
System.out.println(new String(data1));
} catch (Exception e) {
e.printStackTrace();
}
}
}
訊息類:
public class Message {
private String msgtype;
private MessageInfo text;
public String getMsgtype() {
return msgtype;
}
public void setMsgtype(String msgtype) {
this.msgtype = msgtype;
}
public MessageInfo getText() {
return text;
}
public void setText(MessageInfo text) {
this.text = text;
}
}
public class MessageInfo {
private String content;
public MessageInfo(String content) {
this.content = content;
}
public String getContent() {
return content;
}
public void setContent(String content) {
this.content = content;
}
}
我們下線一個服務後,就可以看到釘釘群就發了訊息的通知
同時,當我們啟動服務的時候,也會有訊息通知我們服務啟動了
四 總結
上面就是我們對admin 健康檢查的實際應用,在企業中一般會有簡訊通知+釘釘群通知和郵件,感興趣的小夥伴可以去試試看,還是挺好玩的,還有一個就是微信通知,在服務號 模板訊息感興趣的小夥伴可以自行去研究看看,大家加油~