一文秒懂logstash收集springboot日志的方法

maven依赖

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

springboot 配置文件

logging:
  config: classpath:logback.xml

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
 <include resource="org/springframework/boot/logging/logback/base.xml" />
 <!--======================================= 本地变量 ======================================== -->
 <!--在没有定义${LOG_HOME}系统变量的时候，可以设置此本地变量。提交测试、上线时，要将其注释掉，使用系统变量。 -->
 <property name="LOG_HOME" value="logs/spring.log" />

 <!-- 应用名称：和统一配置中的项目代码保持一致（小写） -->
 <property name="APP_NAME" value="log" />
 <!--日志文件保留天数 -->
 <property name="LOG_MAX_HISTORY" value="30" />
 <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
 <!--应用日志文件保存路径 -->
 <property name="LOG_APP_HOME" value="${APP_NAME}/%d{yyyy-MM-dd}" />

 <!--=========================== 按照每天生成日志文件：默认配置=================================== -->
 <!-- 控制台输出 -->
 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
   <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
   <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  </encoder>
 </appender>
 <!-- 按照每天生成日志文件：主项目日志 -->
 <appender name="APP"
  class="ch.qos.logback.core.rolling.RollingFileAppender">
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
   <!--日志文件输出的文件名 -->
   <FileNamePattern>${LOG_APP_HOME}/base.%d{yyyy-MM-dd}.log
   </FileNamePattern>
   <!--日志文件保留天数 -->
   <MaxHistory>${LOG_MAX_HISTORY}</MaxHistory>
  </rollingPolicy>
  <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
   <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
   <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{500} - %msg%n</pattern>
  </encoder>
 </appender>
 <!--=============================== 日志输出: 默认主业务日志 ====================================== -->
 <logger name="org.springframework">
  <level value="WARN" />
 </logger>
 <logger name="org.apache.shiro">
  <level value="WARN" />
 </logger>
 <logger name="freemarker">
  <level value="WARN" />
 </logger>
 <logger name="org.hibernate">
  <level value="WARN" />
 </logger>
 <logger name="org.hibernate.SQL">
  <level value="DEBUG" />
 </logger>
 <logger name="org.apache.ibatis">
  <level value="DEBUG" />
 </logger>
 <logger name="org.mybatis.spring">
  <level value="DEBUG" />
 </logger>
 <logger name="com.alibaba.druid">
  <level value="DEBUG,INFO" />
 </logger>
    <!-- 这里是你的业务的包名 -->
    <logger name="com.bart.elk">
  <level value="DEBUG" />
 </logger>
 <!-- logstash ip和暴露的端口，我目前理解就是通过这个地址把日志发送过去  -->
 <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
  <!-- 和logstash 的input 配置的端口保持一致 -->
        <destination>localhost:4567</destination> 
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder" />
    </appender>
 <root level="warn,info,debug">
  <appender-ref ref="APP" />
  <appender-ref ref="STDOUT" />
  <appender-ref ref="LOGSTASH" />
        <appender-ref ref="CONSOLE" />
 </root>
</configuration>

logstash

springboot-log.conf

# 文档 
# https://www.elastic.co/guide/en/logstash/5.6/input-plugins.html
# https://www.elastic.co/guide/en/logstash/6.1/input-plugins.html
input{
 tcp {
        mode => "server"
        host => "0.0.0.0"
        port => 4567
        codec => json_lines
 }
}

output{
    # 为了模拟测试就先不放es了，在控制台输出测试看看
 #elasticsearch{
 #    hosts=>["127.0.0.1:9200"]
 #    index => "springboot-elk-%{+YYYY.MM.dd}"
    #}
 stdout{
  codec => rubydebug
 }
}

测试接口

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

@RestController
public class ApiTests {

 protected final static Logger log = LoggerFactory.getLogger(ApiTests.class);
 
 @GetMapping("/api/log")
 public Object log() {
  ServletRequestAttributes requestAttributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
  HttpServletRequest request = requestAttributes.getRequest();
  String ip = request.getRemoteAddr();
  String uri = request.getRequestURI();
  String logStr = String.format("IP=[%s] send request URI = [%s]", ip, uri);
  log.debug("[debug] "+logStr);
  log.info("[info] "+logStr);
  log.warn("[warn] "+logStr);
  log.error("[error] "+logStr);
  return "ok : "+ LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
 } 
}

测试效果

先运行logstash

# linux: 
bin/logstash -f config/springboot-log.conf

# windows: 
bin\logstash.bat -f config/springboot-log.conf

在运行springboot项目，然后调用测试接口：http://localhost:8080/api/log

观察logstash控制台输出：

{
     "@timestamp" => 2021-04-28T15:40:43.182Z,
          "level" => "DEBUG",
           "port" => 57778,
    "thread_name" => "http-nio-8080-exec-1",
    "level_value" => 10000,
       "@version" => "1",
           "host" => "127.0.0.1",
    "logger_name" => "com.bart.elk.ApiTests",
        "message" => "[debug] IP=[127.0.0.1] send request URI = [/api/log]"
}
{
     "@timestamp" => 2021-04-28T15:40:43.182Z,
          "level" => "INFO",
           "port" => 57778,
    "thread_name" => "http-nio-8080-exec-1",
    "level_value" => 20000,
       "@version" => "1",
           "host" => "127.0.0.1",
    "logger_name" => "com.bart.elk.ApiTests",
        "message" => "[info] IP=[127.0.0.1] send request URI = [/api/log]"
}
{
     "@timestamp" => 2021-04-28T15:40:43.183Z,
          "level" => "WARN",
           "port" => 57778,
    "thread_name" => "http-nio-8080-exec-1",
    "level_value" => 30000,
       "@version" => "1",
           "host" => "127.0.0.1",
    "logger_name" => "com.bart.elk.ApiTests",
        "message" => "[warn] IP=[127.0.0.1] send request URI = [/api/log]"
}
{
     "@timestamp" => 2021-04-28T15:40:43.183Z,
          "level" => "ERROR",
           "port" => 57778,
    "thread_name" => "http-nio-8080-exec-1",
    "level_value" => 40000,
       "@version" => "1",
           "host" => "127.0.0.1",
    "logger_name" => "com.bart.elk.ApiTests",
        "message" => "[error] IP=[127.0.0.1] send request URI = [/api/log]"
}

说明运行成功！

参考说明：

logstash-logback-encoder

参考博客-1

参考博客-2

logstash 文档

到此这篇关于一文秒懂logstash收集springboot日志的方法的文章就介绍到这了,更多相关logstash收集springboot日志内容请搜索社区以前的文章或继续浏览下面的相关文章希望大家以后多多支持社区！