Spring Boot Admin實(shí)現(xiàn)服務(wù)健康預(yù)警功能
Over View
上一篇文章主要介紹了Spring Boot Admin的概況以及我們?nèi)绾卧谙到y(tǒng)中引入和使用Spring Boot Admin,以此來幫助我們更加了解自己的系統(tǒng),做到能快速發(fā)現(xiàn)、排查問題。本篇文章將用代碼演示Spring Boot Admin的消息通知功能,并利用這個開箱即用的特性來個性化我們的需求,優(yōu)化我們在服務(wù)治理方面的工作效率。
Spring Boot Admin內(nèi)置了多種開箱即用的系統(tǒng)通知渠道,包括郵件、Slack、Telegram、Hipchat等多種社交媒體的通知渠道。但是考慮到它所支持的大都是一些國外的主流社交媒體,在國內(nèi)的本地化可能并不是那么的友好。不過沒關(guān)系Spring Boot Admin也提供了通用的接口,使得用戶可以基于他所提供的接口來自定義通知方式。下面使用Spring Boot Admin的通知功能來實(shí)現(xiàn)基于郵件和國內(nèi)辦公軟件“飛書”的服務(wù)健康預(yù)警。
郵件預(yù)警
依賴引入
在Spring Boot Admin的服務(wù)端項(xiàng)目中引入郵件相關(guān)依賴
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId> </dependency>
添加配置
添加Spring Mail相關(guān)配置,我們配置好我們郵箱的Smtp服務(wù)器相關(guān)信息
spring.mail.host=your email smtp server spring.mail.password=your password spring.mail.port=your email smtp server port spring.mail.test-connection=true spring.mail.username=837718548@qq.com
添加Spring Boot Admin(SBA)中相關(guān)的郵件配置,以下是SBA官方提供的郵件相關(guān)參數(shù)
Property name | Description | Default value |
---|---|---|
spring.boot.admin.notify.mail.enabled | Enable mail notifications | true |
spring.boot.admin.notify.mail.ignore-changes | Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed. | "UNKNOWN:UP" |
spring.boot.admin.notify.mail.template | Resource path to the Thymeleaf template used for rendering. | "classpath:/META-INF/spring-boot-admin-server/mail/status-changed.html" |
spring.boot.admin.notify.mail.to | Comma-delimited list of mail recipients | "root@localhost" |
spring.boot.admin.notify.mail.cc | Comma-delimited list of carbon-copy recipients | |
spring.boot.admin.notify.mail.from | Mail sender | "Spring Boot Admin <noreply@localhost>" |
spring.boot.admin.notify.mail.additional-properties | Additional properties which can be accessed from the template |
我們這里使用如下配置
spring.boot.admin.notify.mail.from=837718548@qq.com spring.boot.admin.notify.mail.ignore-changes="" spring.boot.admin.notify.mail.to=目標(biāo)郵箱
配置中的ignore-changes參數(shù)表示服務(wù)從一個狀態(tài)變成其他狀態(tài)時發(fā)出預(yù)警,例如:"UNKNOWN:UP" 表示服務(wù)從未知狀態(tài)變成UP時,發(fā)出通知。當(dāng)其值是""時,表示任何狀態(tài)變更都會發(fā)出預(yù)警。若想指定其他參數(shù),參考上面的參數(shù)表。
完成上述操作后,重啟Spring Boot Admin服務(wù)端,當(dāng)客戶端服務(wù)注冊進(jìn)來并且狀態(tài)變?yōu)閁P時,我們可以收到一封郵件:
添加郵件模版
Spring Boot admin發(fā)送的郵件可以自定義模板樣式,我們使用thymeleaf語法編寫郵件模板,示例模板代碼可參考本文在Github的代碼示例倉庫,編寫完模板文件之后,將文件放入項(xiàng)目src/main/resources/templates中,并且在配置文件中增加指定模板文件的地址:
spring.boot.admin.notify.mail.template=classpath:/templates/status-changed.html
重啟Spring Boot Admin服務(wù)端,當(dāng)客戶端服務(wù)注冊進(jìn)來并且狀態(tài)變?yōu)閁P時,我們可以收到一封郵件,如下是我們對郵件進(jìn)行本地化之后的樣式:
飛書預(yù)警
由于Spring Boot Admin內(nèi)置的通知渠道都是國外的社交媒體,不過它也提供了自定義通知渠道的接口,所以我們很容易就可以自定義通知渠道,下面演示集成辦公軟件飛書的通知。
獲取通知地址
飛書中提供了聊天機(jī)器人,我們只需調(diào)用機(jī)器人的WebHook就可以實(shí)現(xiàn)詳細(xì)的推送(企業(yè)微信,釘釘也具有類似功能)。
自定義通知渠道
Spring Boot Admin中提供了一個AbstractStatusChangeNotifier抽象類,我們可以通過繼承它來自定義通知渠道
public class FlyBookNotifier extends AbstractStatusChangeNotifier { private static final String DEFAULT_MESSAGE = "#{instance.registration.name} (#{instance.id}) 狀態(tài)發(fā)生轉(zhuǎn)變 #{lastStatus} ➡️ #{instance.statusInfo.status} " + "\n" + "\n 實(shí)例詳情:#{instanceEndpoint}"; private final SpelExpressionParser parser = new SpelExpressionParser(); private RestTemplate restTemplate; private URI webhookUrl; private Expression message; public FlyBookNotifier(InstanceRepository repository, RestTemplate restTemplate) { super(repository); this.restTemplate = restTemplate; this.message = parser.parseExpression(DEFAULT_MESSAGE, ParserContext.TEMPLATE_EXPRESSION); } @Override protected Mono<Void> doNotify( InstanceEvent event, Instance instance) { if (webhookUrl == null) { return Mono.error(new IllegalStateException("'webhookUrl' must not be null.")); } return Mono .fromRunnable(() -> restTemplate.postForEntity(webhookUrl, createMessage(event, instance), Void.class)); } public void setRestTemplate(RestTemplate restTemplate) { this.restTemplate = restTemplate; } protected Object createMessage(InstanceEvent event, Instance instance) { Map<String, Object> messageJson = new HashMap<>(); messageJson.put("title", "👹警告&👼提醒"); messageJson.put("text", getText(event, instance)); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); return new HttpEntity<>(messageJson, headers); } protected String getText(InstanceEvent event, Instance instance) { Map<String, Object> root = new HashMap<>(); root.put("event", event); root.put("instance", instance); root.put("instanceEndpoint", instance.getEndpoints().toString()); root.put("lastStatus", getLastStatus(event.getInstance())); StandardEvaluationContext context = new StandardEvaluationContext(root); context.addPropertyAccessor(new MapAccessor()); return message.getValue(context, String.class); } public URI getWebhookUrl() { return webhookUrl; } public void setWebhookUrl(URI webhookUrl) { this.webhookUrl = webhookUrl; } public String getMessage() { return message.getExpressionString(); } public void setMessage(String message) { this.message = parser.parseExpression(message, ParserContext.TEMPLATE_EXPRESSION); } }
上面代碼是一個示例,用戶可以根據(jù)自己的需求來自定義消息體的格式和內(nèi)容。
隨后我們在Spring中創(chuàng)建該通知類的bean
@Configuration public static class NotifierConfiguration { @Bean @ConditionalOnMissingBean @ConfigurationProperties("spring.boot.admin.notify.flybook") public FlyBookNotifier flyBookNotifier(InstanceRepository repository) { return new FlyBookNotifier(repository, new RestTemplate()); } }
最后我們在項(xiàng)目的配置文件中添加我們飛書渠道的配置信息
spring.boot.admin.notify.flybook.ignore-changes="" spring.boot.admin.notify.flybook.webhook-url=https://open.feishu.cn/open-apis/bot/hook...
完成上述操作后,重啟Spring Boot Admin服務(wù)端,當(dāng)客戶端服務(wù)注冊進(jìn)來并且狀態(tài)變?yōu)閁P時,我們可以在飛書端收到Spring Boot Admin自動推過來的預(yù)警信息:
至此,我們的自定義消息渠道就已經(jīng)完成。通過繼承AbstractStatusChangeNotifier抽象類,我們可以很輕易的自定義自己想要實(shí)現(xiàn)的推送渠道(設(shè)計(jì)模式:模板方法模式)。
總結(jié)
本文主要介紹了Spring Boot Admin中所提供的多種消息預(yù)警推送渠道,并且我們可以通過自定義消息預(yù)警渠道來滿足我們自身的需求,整個過程并不需要耗費(fèi)太多的人力和時間成本。我們用了兩個示例來演示如何實(shí)現(xiàn)Spring Boot Admin的消息預(yù)警功能,分別是郵件預(yù)警和自定義的飛書預(yù)警。
本文的示例代碼
SBA-client:https://github.com/cg837718548/sba-client-demo.git
SBA-server:https://github.com/cg837718548/sba-server-demo.git
到此這篇關(guān)于Spring Boot Admin實(shí)現(xiàn)服務(wù)健康預(yù)警功能的文章就介紹到這了,更多相關(guān)spring boot 健康預(yù)警內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
MyBatis的@SelectProvider注解構(gòu)建動態(tài)SQL方式
這篇文章主要介紹了MyBatis的@SelectProvider注解構(gòu)建動態(tài)SQL方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08java調(diào)用淘寶api聯(lián)網(wǎng)查詢ip歸屬地
java聯(lián)網(wǎng)查詢IP歸屬地,原理是根據(jù)淘寶提供的service查詢IP的歸屬地并且解析http請求返回的json串2014-03-03淺談Spring Cloud中的API網(wǎng)關(guān)服務(wù)Zuul
這篇文章主要介紹了淺談Spring Cloud中的API網(wǎng)關(guān)服務(wù)Zuul,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-10-10SpringBoot項(xiàng)目打包成jar后獲取classpath下文件失敗的解決
這篇文章主要介紹了SpringBoot項(xiàng)目打包成jar后獲取classpath下文件失敗的解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-07-07解決DataInputStream?read不等于-1,socket文件傳輸只能傳輸一個文件無法傳輸多個問題
這篇文章主要介紹了解決DataInputStream?read不等于-1,socket文件傳輸只能傳輸一個文件無法傳輸多個問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08