Java中多環境Logback配置與ELK日志發送

Java中多環境Logback配置與ELK日志發送

 

一、項目基於SpringBoot實現，引入SpringBoot相關庫后，本文還要講上傳到ELK的Logstash，所以需要在pom.xml中加入：

        <!-- https://mvnrepository.com/artifact/net.logstash.logback/logstash-logback-encoder -->
        <dependency>
            <groupId>net.logstash.logback</groupId>
            <artifactId>logstash-logback-encoder</artifactId>
            <version>5.2</version>
        </dependency>

 

二、基於SpringBoot，要實現日志的多環境配置，比如test\dev\uat\prod，這時需要把logback.xml改為logback-spring.xml，否則無法使用基於 spring.profiles.active=dev 等方式來配置環境。

 

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="30 seconds">
    <!-- 上下文名稱  -->
    <contextName>test</contextName>

    <!-- 存放日志文件路徑 -->
    <property name="Log_Home" value="./logs"/>

    <!-- INFO級別 -->
    <appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${Log_Home}/info.log</File>
        <!-- 根據時間來制定滾動策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>
                ${Log_Home}/info.%d{yyyy-MM-dd}.%i.log.gz
            </FileNamePattern>
            <!-- 多久后自動清楚舊的日志文件,單位:月 -->
            <MaxHistory>12</MaxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 默認值是 10MB,文檔最大值 -->
                <MaxFileSize>100MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <encoder>
            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>
        </encoder>
    </appender>
    <!-- ch.qos.logback.core.ConsoleAppender 控制台輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日志消息，%n是換行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--上傳日志到LogStash-->
    <appender name="LOGSTASH_uat"
              class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>127.0.0.1:5044</destination>
        <!-- encoder必須配置,有多種可選 -->
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder">
            <customFields>{"appName":"backend-sync"}</customFields>
        </encoder>
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>
    <!--上傳日志到LogStash-->
    <appender name="LOGSTASH_dev"
              class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>127.0.0.1:5044</destination>
        <!-- encoder必須配置,有多種可選 -->
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder">
            <customFields>{"appName":"backend-sync"}</customFields>
        </encoder>
        <connectionStrategy>
            <roundRobin>
                <connectionTTL>5 minutes</connectionTTL>
            </roundRobin>
        </connectionStrategy>
    </appender>
    <springProfile name="uat,prod">
        <!-- 當前日志總級別為TRACE、DEBUG、INFO、 WARN、ERROR、ALL和 OF -->
        <root level="WARN">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE_INFO"/>
            <appender-ref ref="LOGSTASH_uat"/>
        </root>
        <logger name="com.yungoal" level="INFO">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE_INFO"/>
            <appender-ref ref="LOGSTASH_uat"/>
        </logger>
    </springProfile>
    <springProfile name="dev,test">
        <!-- 當前日志總級別為TRACE、DEBUG、INFO、 WARN、ERROR、ALL和 OF -->
        <root level="WARN">
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="FILE_INFO"/>
            <appender-ref ref="LOGSTASH_dev"/>
        </root>
    </springProfile>
</configuration>

 

 

 

三、使用方法

    方法一：java -jar myapplication.jar --spring.profiles.active=dev

    方法二：創建spring boot的application.properties在類目錄下，然后里面加入一行spring.profiles.active=dev，然后再建立幾個環境文件，如application-dev.properties、application-uat.properties等，系統將自動通過application.properties中的spring.profiles.active=dev來選擇。