乐趣区

关于spring:SpringBoot实战基于异常日志的邮件报警

jiezi

SpringBoot 实战基于异样日志的邮件报警

置信所有奋斗在一线的小伙伴，会很关怀本人的零碎的运行状况，一般来说，基础设施齐全一点的公司都会有欠缺的报警计划，那么如果咱们是一个小公司呢，不能因为基础设施没有，就失去对象的感知能力吧；如果咱们的零碎大量异样却不能实时的触达给咱们，那么也就只会有一个后果 – 杀个程序猿祭天

本文简略的介绍一种实现思路，基于 error 日志来实现邮件的报警计划

<!– more –>

I. 我的项目环境

1. 我的项目依赖

本我的项目借助 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA 进行开发

开一个 web 服务用于测试

<dependencies>
    <!-- 邮件发送的外围依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-mail</artifactId>
    </dependency>
</dependencies>

2. 配置

邮件相干配置如下，留神应用本人的用户名 + 受权码填充上面缺失的配置

spring:
  #邮箱配置
  mail:
    host: smtp.163.com
    from: xhhuiblog@163.com
    # 应用本人的发送方用户名 + 受权码填充
    username:
    password:
    default-encoding: UTF-8
    properties:
      mail:
        smtp:
          auth: true
          starttls:
            enable: true
            required: true

II. 异样日志的邮件预警

1. 设计思路

接下来这个计划的次要出发点在于，当程序呈现大量的异样，表明利用多半呈现了问题，须要立马发送给我的项目 owner

要实现这个计划，关键点就在于异样呈现的感知与上报

  • 异样的捕捉，并输入日志（这个感觉属于标配了吧，别通知我当初还有利用不输入日志文件的 …）

    • 对于这个感知，借助 logback 的扩大机制，能够实现，前面介绍
  • 异样上报：邮件发送

对于 email 的应用姿态，举荐参考博文 SpringBoot 系列之邮件发送姿态介绍

2. 自定义 appender

定义一个用于谬误发送的 Appender，如下

public class MailUtil extends AppenderBase<ILoggingEvent> {public static void sendMail(String title, String context) {SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        // 邮件发送人
        simpleMailMessage.setFrom(ContextUtil.getEnvironment().getProperty("spring.mail.from", "bangzewu@126.com"));
        // 邮件接管人，能够是多个
        simpleMailMessage.setTo("bangzewu@126.com");
        // 邮件主题
        simpleMailMessage.setSubject(title);
        // 邮件内容
        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 容器

下面的邮件发送中，须要应用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文件内容如下：

<?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 级别的日志，那么须要过滤一下，默认是 info 级别的，ThresholdFilter-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>


    <!-- 指定我的项目中某个包，当有日志操作行为时的日志记录级别 -->
    <!-- 级别顺次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
    <!-- additivity=false 示意匹配之后，不再持续传递给其余的 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

接下来演示一下，是否能够达到咱们的预期

@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. 小结

本篇博文次要提供了一个思路，借助 logback 的扩大机制，来实现谬误日志与预警邮件绑定，实现一个简略的利用异样监控

下面这个实现只算是一个雏形，算是抛砖引玉，有更多能够丰盛的细节，比方

  • 飞书 / 钉钉告诉（借助飞书钉钉的机器来报警，相比拟于邮件感知性更高）
  • 依据异样类型，做预警的辨别
  • 更高级的频率限度等

在这里举荐一个我之前开源的预警系统，能够实现灵便预警计划配置，频率限度，重要性降级等

  • 一个可扩大的报警零碎 https://github.com/liuyueyi/quick-alarm

III. 不能错过的源码和相干知识点

0. 我的项目

  • 工程：https://github.com/liuyueyi/spring-boot-demo
  • 源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-case/430-mail-alarm

举荐关联博文

  • SpringBoot 系列之邮件发送姿态介绍

1. 一灰灰 Blog

尽信书则不如，以上内容，纯属一家之言，因集体能力无限，不免有疏漏和谬误之处，如发现 bug 或者有更好的倡议，欢送批评指正，不吝感谢

上面一灰灰的集体博客，记录所有学习和工作中的博文，欢送大家前去逛逛

  • 一灰灰 Blog 集体博客 https://blog.hhui.top
  • 一灰灰 Blog-Spring 专题博客 http://spring.hhui.top

退出移动版