源码地址: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
- publicclassAdminTestApplication{
- publicstaticvoidmain(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
- #springcloudaccess&secretconfig
- 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
- #收件邮箱
- spring.boot.admin.notify.mail.to=xxxx@qq.com
- #发件邮箱
- spring.boot.admin.notify.mail.from=xxxx@qq.com
2.3 QQ邮箱设置
找到自己的QQ邮箱
QQ邮箱 》 设置 》 账户 》红框处获取 授权码
我们将 consumer 服务下线后,
接着我们就收到了邮件通知,告诉我们服务关闭了
三、发送钉钉群通知
找到群里面的 群设置 》 智能群助手 》 添加机器人
注意:这里的自定义关键词一定要和项目的关键字匹配
获取 Webhook 到项目中,这个是后面要使用到的
启动类:
- importorg.springframework.boot.SpringApplication;
- importorg.springframework.boot.autoconfigure.SpringBootApplication;
- importorg.springframework.context.annotation.Bean;
- importde.codecentric.boot.admin.server.config.EnableAdminServer;
- importde.codecentric.boot.admin.server.domain.entities.InstanceRepository;
- @SpringBootApplication
- @EnableAdminServer
- publicclassAdminApplication{
- publicstaticvoidmain(String[]args){
- SpringApplication.run(AdminApplication.class,args);
- }
- @Bean
- publicDingDingNotifierdingDingNotifier(InstanceRepositoryrepository){
- returnnewDingDingNotifier(repository);
- }
- }
通知类:
- importjava.util.Map;
- importcom.alibaba.fastjson.JSONObject;
- importde.codecentric.boot.admin.server.domain.entities.Instance;
- importde.codecentric.boot.admin.server.domain.entities.InstanceRepository;
- importde.codecentric.boot.admin.server.domain.events.InstanceEvent;
- importde.codecentric.boot.admin.server.notify.AbstractStatusChangeNotifier;
- importreactor.core.publisher.Mono;
- publicclassDingDingNotifierextendsAbstractStatusChangeNotifier{
- publicDingDingNotifier(InstanceRepositoryrepository){
- super(repository);
- }
- @Override
- protectedMono<Void>doNotify(InstanceEventevent,Instanceinstance){
- StringserviceName=instance.getRegistration().getName();
- StringserviceUrl=instance.getRegistration().getServiceUrl();
- Stringstatus=instance.getStatusInfo().getStatus();
- Map<String,Object>details=instance.getStatusInfo().getDetails();
- StringBuilderstr=newStringBuilder();
- str.append("服务预警:【"+serviceName+"】");
- str.append("【服务地址】"+serviceUrl);
- str.append("【状态】"+status);
- str.append("【详情】"+JSONObject.toJSONString(details));
- returnMono.fromRunnable(()->{
- DingDingMessageUtil.sendTextMessage(str.toString());
- });
- }
- }
发送工具类
- importjava.io.InputStream;
- importjava.io.OutputStream;
- importjava.net.HttpURLConnection;
- importjava.net.URL;
- importcom.alibaba.fastjson.JSONObject;
- publicclassDingDingMessageUtil{
- publicstaticStringaccess_token="Token";
- publicstaticvoidsendTextMessage(Stringmsg){
- try{
- Messagemessage=newMessage();
- message.setMsgtype("text");
- message.setText(newMessageInfo(msg));
- URLurl=newURL("https://oapi.dingtalk.com/robot/send?access_token="+access_token);
- //建立http连接
- HttpURLConnectionconn=(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();
- OutputStreamout=conn.getOutputStream();
- StringtextMessage=JSONObject.toJSONString(message);
- byte[]data=textMessage.getBytes();
- out.write(data);
- out.flush();
- out.close();
- InputStreamin=conn.getInputStream();
- byte[]data1=newbyte[in.available()];
- in.read(data1);
- System.out.println(newString(data1));
- }catch(Exceptione){
- e.printStackTrace();
- }
- }
- }
消息类:
- publicclassMessage{
- privateStringmsgtype;
- privateMessageInfotext;
- publicStringgetMsgtype(){
- returnmsgtype;
- }
- publicvoidsetMsgtype(Stringmsgtype){
- this.msgtype=msgtype;
- }
- publicMessageInfogetText(){
- returntext;
- }
- publicvoidsetText(MessageInfotext){
- this.text=text;
- }
- }
- publicclassMessageInfo{
- privateStringcontent;
- publicMessageInfo(Stringcontent){
- this.content=content;
- }
- publicStringgetContent(){
- returncontent;
- }
- publicvoidsetContent(Stringcontent){
- this.content=content;
- }
- }
我们下线一个服务后,就可以看到钉钉群就发了消息的通知
同时,当我们启动服务的时候,也会有消息通知我们服务启动了
四 总结
上面就是我们对admin 健康检查的实际应用,在企业中一般会有短信通知+钉钉群通知和邮件,感兴趣的小伙伴可以去试试看,还是挺好玩的,还有一个就是微信通知,在服务号 模板消息感兴趣的小伙伴可以自行去研究看看,大家加油~
原文地址:https://mp.weixin.qq.com/s/n6INfg8ceEpRuxLGwzVlCw