SpringBoot运维实用篇三（日志）

SpringBoot运维实用篇三（日志）

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

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

1、日志基础

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

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

package com.zcl.Controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 项目名称：SpringBootProject
 * 描述：入门控制器
 *
 * @author zhong
 * @date 2022-05-23 20:14
 */
@RestController
@RequestMapping("/books")
public class BootController{
    // 开启日志【不要导错包了】
    private static final Logger log = LoggerFactory.getLogger(BootController.class);
    @GetMapping
    public String selectById(){
        System.out.println("springboot被访问了.....");
        log.debug("debug...");
        log.info("info...");
        log.warn("warn...");
        log.error("error...");
        return "springboot run......";
    }
}

启动访问之后控制台输出

springboot被访问了.....
2022-05-25 20:57:04.679  INFO 14612 --- [nio-8080-exec-1] com.zcl.Controller.BootController        : info...
2022-05-25 20:57:04.679  WARN 14612 --- [nio-8080-exec-1] com.zcl.Controller.BootController        : warn...
2022-05-25 20:57:04.679 ERROR 14612 --- [nio-8080-exec-1] com.zcl.Controller.BootController        : error...

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

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

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

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

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

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

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

# 设置日志级别，root表示根节点，即整体应用日志级别
logging:
	level:
    	root: debug

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

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

logging:
	# 设置日志组
    group:
    	# 自定义组名，设置当前组中所包含的包
        ebank: com.itheima.controller
    level:
    	root: warn
        # 为对应组设置日志级别
        ebank: debug
    	# 为对包设置日志级别
        com.itheima.controller: debug

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

总结

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

使用lombok优化日志对象创建代码

前提是引入坐标才可以使用@Slf4j

<dependency>
    <groupId>org.projectlombokgroupId>
    <artifactId>lombokartifactId>
dependency>

package com.zcl.Controller;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 项目名称：SpringBootProject
 * 描述：入门控制器
 *
 * @author zhong
 * @date 2022-05-23 20:14
 */
@Slf4j
@RestController
@RequestMapping("/books")
public class BootController{
    // 开启日志【不要导错包了】
    // private static final Logger log = LoggerFactory.getLogger(BootController.class);
    @GetMapping
    public String selectById(){
        System.out.println("springboot被访问了.....");
        log.debug("debug...");
        log.info("info...");
        log.warn("warn...");
        log.error("error...");
        return "springboot run......";
    }
}

2、日志输出合适控制

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

对于单条日志信息来说，日期，触发位置，记录信息是最核心的信息。级别用于做筛选过滤，PID与线程名用于做精准分析。

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

1. %d：时间
2. %clr(%p)：带颜色的日志级别
3. %16t：占有16位字符的线程名称，
4. %c：类名
5. %clr(%-40.40c){cyan} ：-40是左对齐，.40是超出40截取，{cyan}是字体颜色
6. %m：消息
7. %n：换行

3、日志文件

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

logging:
	file:
    	name: server.log

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

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

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