需求

将项目的日志存储到Elasticsearch

前提

该项目基于ruoyi-vue开发,日志部分使用logback

POM文件改动

pom中添加如下依赖

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>6.6</version>
</dependency>

logback.xml改动

1. 新增如下代码

<appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
  	<!-- 配置logstash地址 -->
    <destination>127.0.0.1:10515</destination>
    <!-- <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder" /> -->
    <!-- 日志输出编码 -->
    <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
        <providers>
            <timestamp>
                <!-- 时区设置,此处根据实际情况进行设置,注意UTC(世界统一时间,比北京早8小时) -->
                <timeZone>Asia/Shanghai</timeZone>
            </timestamp>
            <pattern>
                <pattern>
                    {
                    "severity": "%level",
                    "service": "${springAppName:-}",
                    "trace": "%X{X-B3-TraceId:-}",
                    "span": "%X{X-B3-SpanId:-}",
                    "exportable": "%X{X-Span-Export:-}",
                    "pid": "${PID:-}",
                    "thread": "%thread",
                    "class": "%logger{40}",
                    "msg": "%message"
                    }
                </pattern>
            </pattern>
        </providers>
    </encoder>
</appender>

2. 将新增加的appender添加到输出
   以ruoyi-vue作为示例:

<root level="info">
    <appender-ref ref="console" />
    <appender-ref ref="logstash" />
</root>

<!--系统操作日志-->
<root level="info">
    <appender-ref ref="file_info" />
    <appender-ref ref="file_error" />
    <appender-ref ref="logstash" />
</root>

<!--系统用户操作日志-->
<logger name="sys-user" level="info">
    <appender-ref ref="sys-user"/>
    <appender-ref ref="logstash"/>
</logger>

logstash改动

在…/logstash/config目录下新建一个xlzbd.conf文件(文件名根据项目自行定义),conf内容如下:

input {
  tcp {
    # 内容描述
    type => "xlzbd-syslog"
    # 监听端口
    port => 10515    	
  }	
}

output {
  elasticsearch {
    # 目标es地址
    hosts => ["http://localhost:19200"]
    # 索引命名
    index => "xlzbd-syslog-%{+YYYY.MM.dd}"
    # es用户名称(未开启无需填写)
    user => "elastic"
    # es用户密码(未开启无需填写)
    password => ""
  }
}

配置结束

启动项目启动logstash,项目日志即被写入到es

参考文章

1. 最实用的logback讲解（2）—appender
2. serverTimezone=UTC的那些坑
3. logstash-logback-encoder
4. logback整合Logstash