在服務(wù)器程序運行時伴箩，如果出現(xiàn)一個錯誤日志，我們希望得到告警，方便及時處理整陌。 本文介紹如何使用logback中的SMTPAppender實現(xiàn)Error日志消息的發(fā)送.

申請郵箱開啟smtp

郵箱默認是禁用SMTP服務(wù)的，而且現(xiàn)在的主流郵箱甚至禁止使用郵箱密碼來使用SMTP服務(wù)，而是需要另外使用一套授權(quán)碼作為密碼泌辫，這個也是為了提升安全

• 開啟SMTP服務(wù)

  
  
  開啟SMTP服務(wù)

• 網(wǎng)易郵箱設(shè)置授權(quán)碼

  
  
  網(wǎng)易郵箱授權(quán)碼

• QQ郵箱設(shè)置授權(quán)碼

  
  
  QQ郵箱授權(quán)碼

網(wǎng)易郵箱可以自己設(shè)定授權(quán)碼随夸，QQ郵箱是由系統(tǒng)自動生成的一個授權(quán)碼

添加依賴

只需要添加額外的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>

結(jié)果

SMTPAppender內(nèi)部使用了CyclicBuffer作為循環(huán)緩存保存日志記錄震放，當(dāng)遇到ERROR級別日志時宾毒，就會把CyclicBuffer中的所有日志作為一封郵件發(fā)送出去

告警郵件

注意事項

• 日志中可能顯示了太多的非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：一般是因為沒有開啟授權(quán)碼

參考

• LOGBACK EMAIL ALERT USING GMAIL