SpringBoot實(shí)戰(zhàn)基于異常日志的郵件報(bào)警

image

SpringBoot實(shí)戰(zhàn)基于異常日志的郵件報(bào)警

相信所有奮斗在一線的小伙伴，會很關(guān)心自己的系統(tǒng)的運(yùn)行情況，一般來說，基礎(chǔ)設(shè)施齊全一點(diǎn)的公司都會有完善的報(bào)警方案，那么如果我們是一個(gè)小公司呢，不能因?yàn)榛A(chǔ)設(shè)施沒有，就失去對象的感知能力吧；如果我們的系統(tǒng)大量異常卻不能實(shí)時(shí)的觸達(dá)給我們，那么也就只會有一個(gè)結(jié)果--殺個(gè)程序猿祭天

本文簡單的介紹一種實(shí)現(xiàn)思路，基于error日志來實(shí)現(xiàn)郵件的報(bào)警方案

I. 項(xiàng)目環(huán)境

1. 項(xiàng)目依賴

本項(xiàng)目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA進(jìn)行開發(fā)

開一個(gè)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è)計(jì)思路

接下來這個(gè)方案的主要出發(fā)點(diǎn)在于，當(dāng)程序出現(xiàn)大量的異常，表明應(yīng)用多半出現(xiàn)了問題，需要立馬發(fā)送給項(xiàng)目owner

要實(shí)現(xiàn)這個(gè)方案，關(guān)鍵點(diǎn)就在于異常出現(xiàn)的感知與上報(bào)

  • 異常的捕獲，并輸出日志（這個(gè)感覺屬于標(biāo)配了吧，別告訴我現(xiàn)在還有應(yīng)用不輸出日志文件的...）
    • 對于這個(gè)感知，借助logback的擴(kuò)展機(jī)制，可以實(shí)現(xiàn)，后面介紹
  • 異常上報(bào)：郵件發(fā)送

關(guān)于email的使用姿勢，推薦參考博文 SpringBoot 系列之郵件發(fā)送姿勢介紹

2. 自定義appender

定義一個(gè)用于錯(cuò)誤發(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"));
        //郵件接收人，可以是多個(gè)
        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() {
        // 做一個(gè)簡單的頻率過濾
        long now = System.currentTimeMillis();
        if (now - lastAlarmTime >= INTERVAL) {
            lastAlarmTime = now;
            return true;
        } else {
            return false;
        }
    }
}

3. Spring容器

上面的郵件發(fā)送中，需要使用JavaMailSender，寫一個(gè)簡單的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>


    <!-- 指定項(xiàng)目中某個(gè)包，當(dāng)有日志操作行為時(shí)的日志記錄級別 -->
    <!-- 級別依次為【從高到低】：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!";
        }
    }
}
image

5.小結(jié)

本篇博文主要提供了一個(gè)思路，借助logback的擴(kuò)展機(jī)制，來實(shí)現(xiàn)錯(cuò)誤日志與預(yù)警郵件綁定，實(shí)現(xiàn)一個(gè)簡單的應(yīng)用異常監(jiān)控

上面這個(gè)實(shí)現(xiàn)只算是一個(gè)雛形，算是拋磚引玉，有更多可以豐富的細(xì)節(jié)，比如

  • 飛書/釘釘通知（借助飛書釘釘?shù)臋C(jī)器來報(bào)警，相比較于郵件感知性更高）
  • 根據(jù)異常類型，做預(yù)警的區(qū)分
  • 更高級的頻率限制等

在這里推薦一個(gè)我之前開源的預(yù)警系統(tǒng)，可以實(shí)現(xiàn)靈活預(yù)警方案配置，頻率限制，重要性升級等

III. 不能錯(cuò)過的源碼和相關(guān)知識點(diǎn)

0. 項(xiàng)目

推薦關(guān)聯(lián)博文

1. 一灰灰Blog

盡信書則不如，以上內(nèi)容，純屬一家之言，因個(gè)人能力有限，難免有疏漏和錯(cuò)誤之處，如發(fā)現(xiàn)bug或者有更好的建議，歡迎批評指正，不吝感激

下面一灰灰的個(gè)人博客，記錄所有學(xué)習(xí)和工作中的博文，歡迎大家前去逛逛

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容