logback发送告警邮件

在服务器程序运行时，如果出现一个错误日志，我们希望得到告警，方便及时处理。 本文介绍如何使用logback中的SMTPAppender实现Error日志消息的发送.

申请邮箱开启smtp

邮箱默认是禁用SMTP服务的，而且现在的主流邮箱甚至禁止使用邮箱密码来使用SMTP服务，而是需要另外使用一套授权码作为密码，这个也是为了提升安全

• 开启SMTP服务

  
  开启SMTP服务

• 网易邮箱设置授权码

  
  网易邮箱授权码

• QQ邮箱设置授权码

  
  QQ邮箱授权码

网易邮箱可以自己设定授权码，QQ邮箱是由系统自动生成的一个授权码

添加依赖

只需要添加额外的javax.mail，如果不是spring boot就还需要添加logback-classic

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>javax.mail</groupId>
        <artifactId>mail</artifactId>
        <version>1.4.7</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

日志配置文件

• logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="commonPattern" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class{0}:%line][%X{Trace-Id}]: %msg%n%rEx{full,
          java.lang.reflect.Method,
          sun.reflect,
          org.apache.catalina,
          org.springframework.aop,
          org.springframework.security,
          org.springframework.transaction,
          org.springframework.web,
          org.springframework.beans,
          org.springframework.cglib,
          net.sf.cglib,
          org.apache.tomcat.util,
          org.apache.coyote,
          ByCGLIB,
          BySpringCGLIB,
          com.google.common.cache.LocalCache$
        }"/>
    <appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
        <smtpHost>smtp.163.com</smtpHost>
        <smtpPort>465</smtpPort>
        <!--<STARTTLS>true</STARTTLS>-->
        <SSL>true</SSL>
        <asynchronousSending>false</asynchronousSending>
        <username>foo</username>
        <password>bar</password>
        <to>bar@qq.com</to>
        <from>foo@163.com</from>
        <subject>TESTING: %logger{20} - %m</subject>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${commonPattern}</pattern>
        </layout>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <encoder>
            <pattern>${commonPattern}</pattern>
        </encoder>
    </appender>

    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>

    <root level="WARN">
        <appender-ref ref="EMAIL"/>
    </root>

</configuration>

结果

SMTPAppender内部使用了CyclicBuffer作为循环缓存保存日志记录，当遇到ERROR级别日志时，就会把CyclicBuffer中的所有日志作为一封邮件发送出去

告警邮件

注意事项

• 日志中可能显示了太多的非ERROR级别日志，可以增加配置

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    <level>ERROR</level>
</filter>

常见问题

• DynamicClassLoadingException: Failed to instantiate type ch.qos.logback.classic.net.SMTPAppender
• java.lang.NoClassDefFoundError: javax/mail/internet/InternetAddress
• javax.mail.AuthenticationFailedException: 550 User has no permission：一般是因为没有开启授权码

参考

• LOGBACK EMAIL ALERT USING GMAIL