首页 > 其他分享 >Logback简介与配置详解

Logback简介与配置详解

时间：2023-12-19 22:32:36浏览次数：23  
标签：输出 log 简介 详解 logback path 日志 Logback

在开发和维护Spring Boot应用程序时，一个强大而灵活的日志框架是至关重要的。Spring Boot默认集成了Logback，一个高性能的Java日志框架。本文将介绍如何配置Logback以满足你的日志记录需求。

logback.jpg

Logback简介

官方网址：https://logback.qos.ch/

Logback是一款为Java应用程序设计的日志框架，旨在提供高性能、灵活性和可扩展性。它是log4j项目的继任者，并被广泛用于Java应用程序的日志记录。

Logback分为三个主要的模块：logback-core、logback-classic、和logback-access。

  • logback-core提供了基本的日志功能。

  • logback-classic建立在logback-core之上，兼容SLF4J和log4j API，提供了一套强大的日志框架。

  • logback-access允许通过servlet容器的访问日志功能来记录HTTP请求。（）

Spring Boot默认集成了Logback，并用INFO级别输出到控制台。 由于Spring Boot通常使用嵌入式Servlet容器，并且这些容器已经具备了记录访问日志的功能，因此在默认情况下不需要引入logback-access。

Logback 具有许多优点，其中一些包括：

  • 性能高效

Logback被设计为高性能的日志框架，具有较低的运行时开销。

异步日志记录和可配置的缓冲机制有助于提高性能。

  • 灵活的配置

Logback的配置文件采用XML格式（通常命名为logback.xml），允许用户以声明式的方式配置日志输出。

支持通过Groovy脚本进行配置，提供更灵活的选项。

  • 丰富的Appender

提供多种Appender用于将日志输出到不同的目的地，如控制台、文件、数据库等。

支持异步Appender以提高性能。

  • 简单而强大的 API

Logback 的 API 设计简单易用，同时具备强大的功能。它继承了 Log4j 的 API，但在设计上进行了改进和优化，使得开发者可以更容易地集成和使用。

  • 广泛的社区支持

作为一个成熟而受欢迎的日志框架，Logback 拥有广泛的社区支持和活跃的开发者社群。这意味着开发者可以在社区中获取丰富的资源、文档和支持。

springboot配置logback

在src/main/resources目录下创建名为logback-spring.xml或者logback.xml的Logback配置文件。Spring Boot默认会加载类路径下的logback-spring.xml文件。如果该文件不存在，则会尝试加载logback.xml。如果我们使用的是别的配置名称，则需要在springboot 的application.yml配置文件中经行配置：

# 日志配置
logging:
  config: classpath:mylogback.xml

logback.xml的配置完整示例

  • 同步配置文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志存放路径 -->
	<property name="log.path" value="/data/xjdoc/logs" />
    <!-- 日志输出格式 -->
	<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />

	<!-- 控制台输出 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
	</appender>
	
	<!-- 系统日志输出 -->
	<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/sys-info.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</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">
	    <file>${log.path}/sys-error.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
        </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>

	<!-- 系统模块日志级别控制  -->
	<logger name="cn.xj" level="info" />
	<!-- Spring日志级别控制  -->
	<logger name="org.springframework" level="warn" />
	
	<!--系统操作日志-->
    <root level="info">
      	<appender-ref ref="console" />
        <appender-ref ref="file_info" />
        <appender-ref ref="file_error" />
    </root>

</configuration>
  • 异步配置文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志存放路径 -->
	<property name="log.path" value="/data/xjdoc/logs" />
    <!-- 日志输出格式 -->
	<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />

	<!-- 控制台输出 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
	</appender>
	
	<!-- 系统日志输出 -->
	<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/sys-info.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</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">
	    <file>${log.path}/sys-error.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 60天 -->
			<maxHistory>60</maxHistory>
        </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>

    <appender name="async_file_info" class="ch.qos.logback.classic.AsyncAppender">
        <!--  当队列的剩余容量小于这个阈值并且当前日志level为 TRACE, DEBUG or INFO ，则丢弃这些日志。  -->
        <discardingThreshold>0</discardingThreshold>
        <!--  更改默认的队列的深度,该值会影响性能.默认值为256  -->
        <queueSize>1024</queueSize>
        <!--  新增这行为了打印栈堆信息  -->
        <includeCallerData>true</includeCallerData>
        <!--  添加附加的appender,最多只能添加一个  -->
        <appender-ref ref="file_info"/>
    </appender>
    <appender name="async_file_error" class="ch.qos.logback.classic.AsyncAppender">
        <!--  当队列的剩余容量小于这个阈值并且当前日志level为 TRACE, DEBUG or INFO ，则丢弃这些日志。  -->
        <discardingThreshold>0</discardingThreshold>
        <!--  更改默认的队列的深度,该值会影响性能.默认值为256  -->
        <queueSize>1024</queueSize>
        <!--  新增这行为了打印栈堆信息  -->
        <includeCallerData>true</includeCallerData>
        <!--  添加附加的appender,最多只能添加一个  -->
        <appender-ref ref="file_error"/>
    </appender>
    <appender name="async_file_debug" class="ch.qos.logback.classic.AsyncAppender">
        <!--  当队列的剩余容量小于这个阈值并且当前日志level为 TRACE, DEBUG or INFO ，则丢弃这些日志。  -->
        <discardingThreshold>0</discardingThreshold>
        <!--  更改默认的队列的深度,该值会影响性能.默认值为256  -->
        <queueSize>1024</queueSize>
        <!--  新增这行为了打印栈堆信息  -->
        <includeCallerData>true</includeCallerData>
        <!--  添加附加的appender,最多只能添加一个  -->
        <appender-ref ref="file_debug"/>
    </appender>

    <!-- 系统模块日志级别控制  -->
    <logger name="cn.xj" level="info" />
    <!-- Spring日志级别控制  -->
    <logger name="org.springframework" level="warn" />

	
	<!--系统操作日志-->
    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="async_file_info" />
        <appender-ref ref="async_file_error" />
    </root>

</configuration>

logback.xml的配置详解

配置文件基本结构如下:

_20231219173450.jpg

property

    <!-- 日志存放路径 -->
 <property name="log.path" value="/data/xjdoc/logs" />
    <!-- 日志输出格式 -->
 <property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />

<property> 元素用于定义属性，允许在配置文件的其他地方引用这些属性;说明如下：

log.path

这行配置定义了一个名为 log.path 的属性，其值为 /data/xjdoc/logs。这个属性可以在配置文件的其他地方通过 ${log.path} 进行引用。这种属性的定义用于集中管理日志存放路径，方便在多处引用时进行统一修改。

log.pattern

这行配置定义了一个名为 log.pattern 的属性，其值为一个复杂的日志输出格式。这个属性可以在配置文件的其他地方通过 ${log.pattern} 进行引用。这种属性的定义用于集中管理日志输出格式，方便在多处引用时进行统一修改。

  • %d{HH:mm:ss.SSS}: 输出日志的时间戳，精确到毫秒。
转换模式 结果示例
%d 2006-10-20 14:06:49,812
%date 2006-10-20 14:06:49,812
%date{ISO8601} 2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS} 14:06:49.812
%d{HH:mm:ss.SSS} 14:06:49.812
%date{dd MMM yyyy;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812
  • [%thread]: 输出线程名。
  • %-5level: 输出日志级别，左对齐占5个字符的宽度。
  • %logger{20}: 输出 logger 名称，占20个字符的宽度。
  • [%method,%line]: 输出调用方法和行号。
  • %msg: 输出日志消息。
  • %n: 输出平台特定的换行符。

appender

 <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
     <file>${log.path}/sys-info.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
   <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
   <!-- 日志最大的历史 60天 -->
   <maxHistory>60</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> 元素

  • ConsoleAppender（控制台输出）

class="ch.qos.logback.core.ConsoleAppender"

用于将日志输出到控制台。

主要用于开发和调试时观察日志。

  • FileAppender（文件输出） class="ch.qos.logback.core.FileAppender"

用于将日志输出到文件。

可以配置文件路径、文件名等参数。

  • RollingFileAppender（滚动文件输出）

class="ch.qos.logback.core.RollingFileAppender"

在FileAppender的基础上，支持滚动策略，可以按照一定规则滚动创建日志文件，例如按时间、文件大小等。

  • AsyncAppender（异步输出）

class="ch.qos.logback.core.AsyncAppender"

用于异步输出日志，可以提高性能，特别适用于高吞吐的应用。

包装其他Appender，将日志记录过程异步执行。

滚动策略 (<rollingPolicy> 元素)

  • TimeBasedRollingPolicy（基于时间的滚动策略）

基于时间的滚动策略，按照一定的时间间隔滚动创建新的日志文件。

fileNamePattern 属性定义了日志文件名的格式，可以包含时间相关的占位符，例如 %d{yyyy-MM-dd}。

  • SizeAndTimeBasedRollingPolicy（基于时间和大小的滚动策略）

同时基于时间和文件大小的滚动策略，既可以按照时间滚动，又可以在达到一定文件大小时滚动创建新的日志文件。

fileNamePattern 属性定义了日志文件名的格式，可以包含时间相关的占位符，例如 %d{yyyy-MM-dd}。

maxFileSize 属性定义了每个日志文件的最大大小。

  • FixedWindowRollingPolicy（固定窗口的滚动策略）

固定窗口的滚动策略，按照一定的窗口大小滚动创建新的日志文件。

  • SizeBasedTriggeringPolicy（基于大小触发滚动策略）

基于文件大小触发滚动的策略，当当前日志文件大小达到一定阈值时触发滚动。

  • TimeBasedFileNamingAndTriggeringPolicy（基于时间的文件命名和触发策略）

基于时间的文件命名和触发策略，按照一定的时间间隔和文件名格式触发滚动。

<encoder> 元素

用于配置日志的输出格式，${log.pattern} 引用了之前定义的 log.pattern 属性，以保持一致的日志输出格式。

<filter> 元素

  • 使用 ch.qos.logback.classic.filter.LevelFilter 过滤器，仅接受 INFO 级别的日志记录。
  • onMatch 指定匹配时的操作为接受（ACCEPT）。
  • onMismatch 指定不匹配时的操作为拒绝（DENY）。

logger

    <!-- 系统模块日志级别控制  -->
    <logger name="cn.xj" level="info" />
    <!-- Spring日志级别控制  -->
    <logger name="org.springframework" level="warn" />

name 属性

通常使用类名或者包名来指定 Logger。

level 属性

level 属性定义了日志级别，表示记录的日志消息级别。可选值包括 trace、debug、info、warn、error。

  • TRACE（追踪）

TRACE 是最低级别的日志，用于记录程序的详细执行信息。

这个级别通常用于调试，输出对程序执行流程的跟踪信息。

TRACE 级别的日志量较大，一般情况下不会在生产环境中启用。

  • DEBUG（调试）

DEBUG 级别用于输出调试信息，有助于开发者定位和解决问题。

DEBUG 日志通常包含详细的变量信息、方法调用堆栈等。

在开发和测试阶段中，可以启用 DEBUG 日志以获取更多的信息。

  • INFO（信息）

INFO 级别用于记录一般性的信息，表示程序执行的正常流程。

INFO 日志用于显示重要的运行时信息，通常在生产环境中启用。

这是默认的日志级别，如果没有明确指定级别，则使用 INFO。

  • WARN（警告）

WARN 级别用于记录一些可能需要关注的问题，但不会导致程序失败。

WARN 日志表明程序可能遇到了某些问题或潜在的错误，但仍然可以继续执行。

这是一个提醒性的级别。

  • ERROR（错误）

ERROR 级别用于记录程序的错误和异常情况。

ERROR 日志表示程序遇到了严重的问题，可能导致程序崩溃或无法正常运行。

ERROR 级别的日志通常需要开发者及时关注和处理。

root

在 Logback 配置文件中，<root> 元素用于配置根 Logger，它是整个日志系统的根节点。根 Logger 拥有最高级别，通常用于设置全局的日志级别和全局的 Appender（附加器）。

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

level 属性

level 属性定义了根 Logger 的默认日志级别，表示整个日志系统的最低输出级别。例如，上例中设置为 INFO，表示只输出 INFO 级别及以上的日志。

<appender-ref> 元素

<appender-ref> 元素用于引用一个或多个 Appender，将其关联到根 Logger，即设置根 Logger 的输出目的地。可以有多个<appender-ref>元素，表示将日志输出到多个目的地。

总结

Logback 是一个强大且灵活的日志框架，它为 Java 应用程序提供了先进的日志记录功能。通过合理配置，可以满足各种应用场景的需求，从而更好地帮助开发者监控和调试应用程序。希望本文对 Logback 的简介和配置提供了清晰的指导，使你能更好地使用 Logback 进行日志记录。

标签：输出,log,简介,详解,logback,path,日志,Logback
From： https://blog.51cto.com/xiuji/8895391

相关文章

  • [强网杯2023] 强网先锋 ez_fmt 详解
    题目详解查看保护机制，地址随机化未开启Arch:amd64-64-littleRELRO:FullRELROStack:CanaryfoundNX:NXenabledPIE:NoPIE(0x400000)查看main函数，题目给出了一个栈地址，同时还有个很明显的字符串格式化漏洞，但是只能利用一......
  • SpringBoot 注解详解
    1.注解详解@SpringBootApplication：申明让springboot自动给程序进行必要的配置，这个配置等同于：@Configuration，@EnableAutoConfiguration和@ComponentScan三个配置。@ResponseBody：表示该方法的返回结果直接写入HTTPresponsebody中，一般在异步获取数据时使用，用于构建RESTful的a......
  • opencv图像处理机器学习真实项目教程(python实现)1计算机视觉简介
    1计算机视觉简介欢迎来到计算机视觉的世界。本书将带您踏上令人兴奋且快速发展的计算机视觉和图像处理世界的旅程。本书首先介绍计算机视觉和OpenCV库。然后，我们将继续介绍本课程的基本库和所需的环境设置。主要内容：计算机视觉简介计算机视觉的应用PythonOpenCVOpenCV......
  • Java Properties配置文件使用方法入门详解​
    JavaProperties配置文件使用方法详解使用配置文件的优点：好处1:可以把软件的设置永久化存储好处2:如果我们要修改参数，不需要改动代码，直接修改配置文件就可以了Properties配置文件文件后缀名为.properties，其内容是按键值对存储的。前面为键，后面为值。properties是一个双列集合，拥有Ma......
  • 格式工厂MP4视频转格式（H265->H264）图文详解
    最近上传到网站上的视频播放时只有声音没有图像，但是在本地播放一切正常，检查后发现问题是有些浏览器不支持播放H265格式的视频。不能让访问网站的用户去换浏览器或者单独安装浏览器插件，最简单的解决办法还是自己转化视频格式重新上传。推荐一个老牌免费使用简单的视频格式转换软件—......
  • Gowin FPGA Designer 简介
    高云FPGADesigner是高云FPGA开发的IDE软件，软件包不大，安装包241M，解压Gowin_V1.9.8.07_vin压缩包，后点击文件夹的exe安装包，直接一直按下一步，完成软件的安装，安装后在桌面会有如下图标  双击打开软件，进入主界面，如下  软件的使用，请参考软件使用视频或者在高云官......
  • springboot 记录使用log4j与logback发送日志到syslog服务器
    Linux服务器配置编辑/etc/rsyslog.conf文件。（我的在这里，根据自己系统查看）#取消注释这几行$ModLoadimudp$UDPServerRun514#ProvidesTCPsyslogreception$ModLoadimtcp$InputTCPServerRun514..........#末位追加：local2.info/var/log/login_info.log......
  • 详解ZooKeeper在微服务注册中心的应用
    本文分享自华为云社区《SpringCloudZooKeeper详解，以及与Go、Rust等非Java服务的集成》，作者：张俭。ZooKeeper，是一个开源的分布式协调服务，不仅支持分布式选举、任务分配，还可以用于微服务的注册中心和配置中心。本文，我们将深入探讨ZooKeeper用做微服务注册中心的场景。ZooKeeper......
  • IDE之VS：Visual Studio的简介(包括 VS2013、VS2015、VS2017、VS2019、VS2022)、安装、
    原文链接：https://blog.csdn.net/qq_41185868/article/details/81052119最近开始使用vs2019,应该是最新的版本。之前都是vs2015,感觉19更智能，兼容性更好，速度也更快。详细了解下这几个版本。1、简介：MicrosoftVisualStudio（简称VS）是美国微软公司的开发工具包系列产品，功能完备的I......
  • 神经网络优化篇：详解正则化（Regularization）
    正则化深度学习可能存在过拟合问题——高方差，有两个解决方法，一个是正则化，另一个是准备更多的数据，这是非常可靠的方法，但可能无法时时刻刻准备足够多的训练数据或者获取更多数据的成本很高，但正则化通常有助于避免过拟合或减少的网络误差。如果怀疑神经网络过度拟合了数据，即存在高......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99