相信所有奮斗在一線的小伙伴残制，會很關(guān)心自己的系統(tǒng)的運行情況熏矿，一般來說升薯，基礎(chǔ)設(shè)施齊全一點的公司都會有完善的報警方案绍妨，那么如果我們是一個小公司呢茫死，不能因為基礎(chǔ)設(shè)施沒有屯烦，就失去對象的感知能力吧舔株；如果我們的系統(tǒng)大量異常卻不能實時的觸達(dá)給我們洁灵，那么也就只會有一個結(jié)果--殺個程序猿祭天
本文簡單的介紹一種實現(xiàn)思路饱岸，基于error日志來實現(xiàn)郵件的報警方案
I. 項目環(huán)境
1. 項目依賴
本項目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA進(jìn)行開發(fā)
開一個web服務(wù)用于測試
<dependencies>
<!-- 郵件發(fā)送的核心依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
</dependencies>
2. 配置
郵件相關(guān)配置如下，注意使用自己的用戶名 + 授權(quán)碼填充下面缺失的配置
spring:
#郵箱配置
mail:
host: smtp.163.com
from: xhhuiblog@163.com
# 使用自己的發(fā)送方用戶名 + 授權(quán)碼填充
username:
password:
default-encoding: UTF-8
properties:
mail:
smtp:
auth: true
starttls:
enable: true
required: true
II. 異常日志的郵件預(yù)警
1. 設(shè)計思路
接下來這個方案的主要出發(fā)點在于徽千，當(dāng)程序出現(xiàn)大量的異常苫费，表明應(yīng)用多半出現(xiàn)了問題，需要立馬發(fā)送給項目owner
要實現(xiàn)這個方案双抽，關(guān)鍵點就在于異常出現(xiàn)的感知與上報
- 異常的捕獲百框，并輸出日志（這個感覺屬于標(biāo)配了吧，別告訴我現(xiàn)在還有應(yīng)用不輸出日志文件的...）
- 對于這個感知牍汹，借助logback的擴(kuò)展機(jī)制铐维，可以實現(xiàn)柬泽，后面介紹
- 異常上報：郵件發(fā)送
關(guān)于email的使用姿勢，推薦參考博文 SpringBoot 系列之郵件發(fā)送姿勢介紹
2. 自定義appender
定義一個用于錯誤發(fā)送的Appender嫁蛇，如下
public class MailUtil extends AppenderBase<ILoggingEvent> {
public static void sendMail(String title, String context) {
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
//郵件發(fā)送人
simpleMailMessage.setFrom(ContextUtil.getEnvironment().getProperty("spring.mail.from", "bangzewu@126.com"));
//郵件接收人锨并，可以是多個
simpleMailMessage.setTo("bangzewu@126.com");
//郵件主題
simpleMailMessage.setSubject(title);
//郵件內(nèi)容
simpleMailMessage.setText(context);
JavaMailSender javaMailSender = ContextUtil.getApplicationContext().getBean(JavaMailSender.class);
javaMailSender.send(simpleMailMessage);
}
private static final long INTERVAL = 10 * 1000 * 60;
private long lastAlarmTime = 0;
@Override
protected void append(ILoggingEvent iLoggingEvent) {
if (canAlarm()) {
sendMail(iLoggingEvent.getLoggerName(), iLoggingEvent.getFormattedMessage());
}
}
private boolean canAlarm() {
// 做一個簡單的頻率過濾
long now = System.currentTimeMillis();
if (now - lastAlarmTime >= INTERVAL) {
lastAlarmTime = now;
return true;
} else {
return false;
}
}
}
3. Spring容器
上面的郵件發(fā)送中，需要使用JavaMailSender睬棚，寫一個簡單的SpringContext工具類琳疏，用于獲取Bean/Propertiy
@Component
public class ContextUtil implements ApplicationContextAware, EnvironmentAware {
private static ApplicationContext applicationContext;
private static Environment environment;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
ContextUtil.applicationContext = applicationContext;
}
@Override
public void setEnvironment(Environment environment) {
ContextUtil.environment = environment;
}
public static ApplicationContext getApplicationContext() {
return applicationContext;
}
public static Environment getEnvironment() {
return environment;
}
}
4. logback配置
接下來就是在日志配置中，使用我們上面定義的Appender
logback-spring.xml文件內(nèi)容如下：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d [%t] %-5level %logger{36}.%M\(%file:%line\) - %msg%n</pattern>
<!-- 控制臺也要使用UTF-8闸拿，不要使用GBK空盼，否則會中文亂碼 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<appender name="errorAlarm" class="com.git.hui.demo.mail.util.MailUtil">
<!--如果只是想要 Error 級別的日志，那么需要過濾一下新荤，默認(rèn)是 info 級別的揽趾，ThresholdFilter-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
</appender>
<!-- 指定項目中某個包，當(dāng)有日志操作行為時的日志記錄級別 -->
<!-- 級別依次為【從高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE -->
<!-- additivity=false 表示匹配之后苛骨，不再繼續(xù)傳遞給其他的logger-->
<logger name="com.git.hui" level="DEBUG" additivity="false">
<appender-ref ref="STDOUT"/>
<appender-ref ref="errorAlarm"/>
</logger>
<!-- 控制臺輸出日志級別 -->
<root level="INFO">
<appender-ref ref="STDOUT"/>
</root>
</configuration>
5. 測試demo
接下來演示一下篱瞎，是否可以達(dá)到我們的預(yù)期
@Slf4j
@RestController
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class);
}
@GetMapping("div")
public String div(int a, int b) {
try {
return String.valueOf(a / b);
} catch (Exception e) {
log.error("div error! {}/{}", a, b, e);
return "some error!";
}
}
}
5.小結(jié)
本篇博文主要提供了一個思路，借助logback的擴(kuò)展機(jī)制痒芝，來實現(xiàn)錯誤日志與預(yù)警郵件綁定俐筋，實現(xiàn)一個簡單的應(yīng)用異常監(jiān)控
上面這個實現(xiàn)只算是一個雛形，算是拋磚引玉严衬，有更多可以豐富的細(xì)節(jié)澄者，比如
- 飛書/釘釘通知（借助飛書釘釘?shù)臋C(jī)器來報警，相比較于郵件感知性更高）
- 根據(jù)異常類型请琳，做預(yù)警的區(qū)分
- 更高級的頻率限制等
在這里推薦一個我之前開源的預(yù)警系統(tǒng)粱挡，可以實現(xiàn)靈活預(yù)警方案配置，頻率限制俄精，重要性升級等
- 一個可擴(kuò)展的報警系統(tǒng) https://github.com/liuyueyi/quick-alarm
III. 不能錯過的源碼和相關(guān)知識點
0. 項目
- 工程：https://github.com/liuyueyi/spring-boot-demo
- 源碼：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-case/430-mail-alarm
推薦關(guān)聯(lián)博文
1. 一灰灰Blog
盡信書則不如询筏，以上內(nèi)容，純屬一家之言竖慧，因個人能力有限嫌套，難免有疏漏和錯誤之處，如發(fā)現(xiàn)bug或者有更好的建議圾旨，歡迎批評指正踱讨，不吝感激
下面一灰灰的個人博客，記錄所有學(xué)習(xí)和工作中的博文碳胳，歡迎大家前去逛逛
- 一灰灰Blog個人博客 https://blog.hhui.top
- 一灰灰Blog-Spring專題博客 http://spring.hhui.top
