SpringCloud集成ELK

2024-09-07 09:52

本文主要是介绍SpringCloud集成ELK,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1、添加依赖

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

2、在logback-spring.xml中添加配置信息(logback-spring.xml在文末)

<!--输出到 logstash的 appender-->
<appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender"><destination>192.168.2.203:4560</destination><encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>
</appender>......
<root level="info">......<appender-ref ref="logstash" />
</root>

192.168.2.203:4560对应搭建的Logstash地址

Logback日志打印

由于SpringBoot项目在引用了sprng-boot-starter-logging依赖,默认使用logback来记录日志。因为之间微服务系统引用了spring-bot-stater-web依赖,该依赖包含了spring-boot-starter-logging,该依赖包含了spring-boot-starter-logging,所以无需再次引入

请添加图片描述

在各个微服务中的logback配置文件logack-spring.xml中配置文件(一般auth-server、gateway-server、user-server)

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false"><contextName>spring-cloud</contextName><springProperty scope="context" name="springAppName" source="spring.application.name"/><property name="log.path" value="logs/user-server" /><property name="log.maxHistory" value="15" /><property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %boldCyan([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %yellow(%thread) %green(%logger) %msg%n"/><property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level [${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] %thread %logger %msg%n"/><!--输出到控制台--><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${log.colorPattern}</pattern></encoder></appender><!--输出到文件--><appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern><MaxHistory>${log.maxHistory}</MaxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>INFO</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><root level="debug"><appender-ref ref="console" /></root><root level="info"><appender-ref ref="file_info" /><appender-ref ref="file_error" /></root>
</configuration>

logback-spring.xml配置文件大致结构如下:

<configuration><property/><appender/><root/>
</configuration>

下面详细介绍标签的作用

<configuration>为logback配置文件的根标签,该标签包含三个属性:

  • scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true
  • scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟
  • debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false

用来定义变量值的标签,有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使${}来使用变量。

<springProperty scope="context" name="springAppName" source="spring.application.name"/>

这段配置用于引用Spring上下文的变量。通过这段配置,我们可以在logback配置文件中使用${springAppName}来引用配置文件application.yml里的spring.application.name配置值,在febs-server-system模块中,该值为user-server

<property name="log.path" value="logs/user-server" />

上面这段配置定义了log.path变量,用于指定日志文件存储路径。

<property name="log.maxHistory" value="15" />

上面这段配置定义了log.maxHistory变量,用于指定日志文件存储的天数,这里指定为15天。

 <property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %boldCyan([${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %yellow(%thread) %green(%logger) %msg%n"/>

这段配置定义了彩色日志打印的格式。在logback配置文件中,我们可以使用%magenta()%boldCyan()等标识指定日志的颜色;%d{yyyy-MM-dd HH:mm:ss}用于格式化日志打印时间;%highlight(%-5level)配置了不同日志级别使用不同的颜色高亮显示;%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}用于打印Spring Cloud Sleuth提供的TraceIdSpanId等信息,如果不配置这些信息,我们在上一章搭建的Zipkin Server就无法追踪我们的请求链了。

 <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level [${springAppName:-},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}] %thread %logger %msg%n"/>

这段配置定义了普通日志打印格式,大体上和上面彩色日志配置差不多,却别就是去掉了颜色配置。

如果微服务项目没有使用Spring Cloud Sleuth进行请求追踪,那么TraceIdSpanId打印出来都是空的,可以用下面这段配置来替代:

<property name="log.colorPattern" value="%magenta(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %yellow(%thread) %green(%logger) %msg%n"/>
<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5level %thread %logger %msg%n"/>

appender

appender用来格式化日志输出节点,有俩个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。

<appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>${log.colorPattern}</pattern></encoder>
</appender>

上面这段配置用于指定日志输出到控制台,日志打印格式采用上面定义的彩色日志打印(IDEA控制台支持彩色日志输出),这样在开发的时候,控制台输出的日志会更为美观,易于分析问题。

<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern><MaxHistory>${log.maxHistory}</MaxHistory></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>INFO</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter>
</appender><appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/error/error.%d{yyyy-MM-dd}.log</fileNamePattern></rollingPolicy><encoder><pattern>${log.pattern}</pattern></encoder><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter>
</appender>

这两段配置用于指定日志输出到日志文件。其中,名称为file_infoappender指定了INFO级别的日志输出到log/febs-server-system/info目录下,文件名称为info.日期.log,并且日志格式为普通格式,因为文件一般不支持彩色显示;名称为file_errorappender指定了ERROR级别的日志输出到log/febs-server-system/error目录下,文件名称为error.日期.log,日志格式也为普通格式

root

root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性,用来设置打印级别。如果在appender里制定了日志打印的级别,那么root指定的级别将会被覆盖。

剩下的模块照着febs-server-system模块配置即可。编写好日志配置文件后,在启动各个微服务系统的时候,控制台输出如下所示:请添加图片描述

在spring-cloud模块下,你将会看到保存好的日志文件

请添加图片描述

这篇关于SpringCloud集成ELK的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1144739

相关文章

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示:项目相关背景:项目场景:基于Spring

Spring Boot 整合 SSE的高级实践(Server-Sent Events)

《SpringBoot整合SSE的高级实践(Server-SentEvents)》SSE(Server-SentEvents)是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实... 目录1、简述2、Spring Boot 中的SSE实现2.1 添加依赖2.2 实现后端接口2.3 配置超时时

Spring Boot读取配置文件的五种方式小结

《SpringBoot读取配置文件的五种方式小结》SpringBoot提供了灵活多样的方式来读取配置文件,这篇文章为大家介绍了5种常见的读取方式,文中的示例代码简洁易懂,大家可以根据自己的需要进... 目录1. 配置文件位置与加载顺序2. 读取配置文件的方式汇总方式一:使用 @Value 注解读取配置方式二

一文详解Java异常处理你都了解哪些知识

《一文详解Java异常处理你都了解哪些知识》:本文主要介绍Java异常处理的相关资料,包括异常的分类、捕获和处理异常的语法、常见的异常类型以及自定义异常的实现,文中通过代码介绍的非常详细,需要的朋... 目录前言一、什么是异常二、异常的分类2.1 受检异常2.2 非受检异常三、异常处理的语法3.1 try-

Java中的@SneakyThrows注解用法详解

《Java中的@SneakyThrows注解用法详解》:本文主要介绍Java中的@SneakyThrows注解用法的相关资料,Lombok的@SneakyThrows注解简化了Java方法中的异常... 目录前言一、@SneakyThrows 简介1.1 什么是 Lombok?二、@SneakyThrows

Java中字符串转时间与时间转字符串的操作详解

《Java中字符串转时间与时间转字符串的操作详解》Java的java.time包提供了强大的日期和时间处理功能,通过DateTimeFormatter可以轻松地在日期时间对象和字符串之间进行转换,下面... 目录一、字符串转时间(一)使用预定义格式(二)自定义格式二、时间转字符串(一)使用预定义格式(二)自

Spring 请求之传递 JSON 数据的操作方法

《Spring请求之传递JSON数据的操作方法》JSON就是一种数据格式,有自己的格式和语法,使用文本表示一个对象或数组的信息,因此JSON本质是字符串,主要负责在不同的语言中数据传递和交换,这... 目录jsON 概念JSON 语法JSON 的语法JSON 的两种结构JSON 字符串和 Java 对象互转

JAVA保证HashMap线程安全的几种方式

《JAVA保证HashMap线程安全的几种方式》HashMap是线程不安全的,这意味着如果多个线程并发地访问和修改同一个HashMap实例,可能会导致数据不一致和其他线程安全问题,本文主要介绍了JAV... 目录1. 使用 Collections.synchronizedMap2. 使用 Concurren