• SpringBoot如何打日志、控制输出格式、存储日志到文件


    本专栏将从基础开始,循序渐进,以实战为线索,逐步深入SpringBoot相关知识相关知识,打造完整的云原生学习步骤,提升工程化编码能力和思维能力,写出高质量代码。希望大家都能够从中有所收获,也请大家多多支持。
    专栏地址:SpringBoot专栏
    本文涉及的代码都已放在gitee上:gitee地址
    如果文章知识点有错误的地方,请指正!大家一起学习,一起进步。
    专栏汇总:专栏汇总


    日志其实就是记录程序日常运行的信息,主要作用如下:

    • 编程期调试代码
    • 运营期记录信息
    • 记录日常运营重要信息(峰值流量、平均响应时长……)
    • 记录应用报错信息(错误堆栈)
    • 记录运维过程数据(扩容、宕机、报警……)

    ​ 或许各位小伙伴并不习惯于使用日志,没关系,慢慢多用,习惯就好。想进大厂,这是最基本的,别去面试的时候说没用过,完了,没机会了。

    代码中使用日志工具记录日志

    ​ 日志的使用格式非常固定,直接上操作步骤:

    步骤①:添加日志记录操作

    import org.slf4j.LoggerFactory;
    import org.slf4j.Logger;
    
    @RestController
    @RequestMapping("/books")
    public class BookController extends BaseClass{
        private static final Logger log = LoggerFactory.getLogger(BookController.class);
        @GetMapping
        public String getById(){
            log.debug("debug...");
            log.info("info...");
            log.warn("warn...");
            log.error("error...");
            return "springboot is running...2";
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    ​ 上述代码中log对象就是用来记录日志的对象,下面的log.debug,log.info这些操作就是写日志的API了。

    步骤②:设置日志输出级别

    ​ 日志设置好以后可以根据设置选择哪些参与记录。这里是根据日志的级别来设置的。日志的级别分为6种,分别是:

    • TRACE:运行堆栈信息,使用率低
    • DEBUG:程序员调试代码使用
    • INFO:记录运维过程数据
    • WARN:记录运维过程报警数据
    • ERROR:记录错误堆栈信息
    • FATAL:灾难信息,合并计入ERROR

    ​ 一般情况下,开发时候使用DEBUG,上线后使用INFO,运维信息记录使用WARN即可。下面就设置一下日志级别:

    # 开启debug模式,输出调试信息,常用于检查系统运行状况
    debug: true
    
    • 1
    • 2

    ​ 这么设置太简单粗暴了,日志系统通常都提供了细粒度的控制

    # 开启debug模式,输出调试信息,常用于检查系统运行状况
    debug: true
    
    # 设置日志级别,root表示根节点,即整体应用日志级别
    logging:
    	level:
        	root: debug
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    ​ 还可以再设置更细粒度的控制

    步骤③:设置日志组,控制指定包对应的日志输出级别,也可以直接控制指定包对应的日志输出级别

    logging:
    	# 设置日志组
        group:
        	# 自定义组名,设置当前组中所包含的包
            ebank: com.hashnode.controller,com.hashnode.controller2
        level:
        	root: warn
            # 为对应组设置日志级别
            ebank: debug
        	# 为对包设置日志级别
            com.hashnode.controller: debug
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11

    ​ 说白了就是总体设置一下,每个包设置一下,如果感觉设置的麻烦,就先把包分个组,对组设置,没了,就这些。

    总结

    1. 日志用于记录开发调试与运维过程消息
    2. 日志的级别共6种,通常使用4种即可,分别是DEBUG,INFO,WARN,ERROR
    3. 可以通过日志组或代码包的形式进行日志显示级别的控制

    日志输出格式控制

    ​ 日志已经能够记录了,但是目前记录的格式是SpringBoot给我们提供的,如果想自定义控制就需要自己设置了。先分析一下当前日志的记录格式。

    image-20220619192028881

    ​ 对于单条日志信息来说,日期,触发位置,记录信息是最核心的信息。级别用于做筛选过滤,PID与线程名用于做精准分析。了解这些信息后就可以DIY日志格式了。本课程不做详细的研究,有兴趣的小伙伴可以学习相关的知识。下面给出一个案例,便于大家学习。

    logging:
    	pattern:
        	console: "%d %clr(%p) --- [%16t] %clr(%-40.40c){cyan} : %m %n"
    
    • 1
    • 2
    • 3

    日志文件

    ​ 日志信息显示,记录已经控制住了,下面就要说一下日志的转存了。日志不能仅显示在控制台上,要把日志记录到文件中,方便后期维护查阅。

    ​ 对于日志文件的使用存在各种各样的策略,例如每日记录,分类记录,报警后记录等。这里主要研究日志文件如何记录。

    ​ 记录日志到文件中格式非常简单,设置日志文件名即可。

    logging:
    	file:
        	name: server.log
    
    • 1
    • 2
    • 3

    ​ 虽然使用上述格式可以将日志记录下来了,但是面对线上的复杂情况,一个文件记录肯定是不能够满足运维要求的,通常会每天记录日志文件,同时为了便于维护,还要限制每个日志文件的大小。下面给出日志文件的常用配置方式:

    logging:
    	logback:
        	rollingpolicy:
            	max-file-size: 3KB
                file-name-pattern: server.%d{yyyy-MM-dd}.%i.log
    
    • 1
    • 2
    • 3
    • 4
    • 5

    ​ 以上格式是基于logback日志技术设置每日日志文件的设置格式,要求容量到达3KB以后就转存信息到第二个文件中。文件命名规则中的%d标识日期,%i是一个递增变量,用于区分日志文件。

  • 相关阅读:
    若依前后端分离项目部署
    FastAPI 学习之路(十九)处理错误/异常
    Linux ARM平台开发系列讲解(摄像头V4L2子系统) 2.12.7 摄像头V4L2驱动开发流程总结
    【动态规划专项训练】基础篇
    软件测试面试题
    价格监测的目标
    JavaScript ES6函数触发方式,解构和class构造函数
    【网络安全】beef-xss实操以及xss修复方案
    stm32开发模板 && 建议
    uniapp webview 修改ua(UserAgent、user-agent)
  • 原文地址:https://blog.csdn.net/Learning_xzj/article/details/125432756