首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >springboot超级详细的日志配置(基于logback)

springboot超级详细的日志配置(基于logback)

作者头像
用户2038589
发布于 2019-06-13 10:59:10
发布于 2019-06-13 10:59:10
26.5K01
代码可运行
举报
文章被收录于专栏:青青天空树青青天空树
运行总次数:1
代码可运行

前言

  java web 下有好几种日志框架,比如:logback,log4j,log4j2(slj4f 并不是一种日志框架,它相当于定义了规范,实现了这个规范的日志框架就能够用 slj4f 调用)。其中性能最高的应该使 logback 了,而且 springboot 默认使用的也是 logback 日志,所以本篇将会详细的讲解 logback 的日志配置方案。

本篇主要内容如下:

  • logback 配置文件的构成
  • 如何将日志输出到文件
  • 如何按时间,按大小切分日志
  • 如何将让一个日志文件中只有一种日志级别
  • 如何将指定包下的日志输出到指定的日志文件中

简单使用

  如果无需复杂的日志配置,执行简单设置日志打印级别,打印方式可直接再 application.yml 中配置。

  默认情况下 Spring Boot 将 info 级别的日志输出到控制台中,不会写到日志文件,且不能进行复杂配置。

打印到文件中

  想要将日志输出到文件中,可通过如下两个配置:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
logging:
  # 配置输出额日志文件名,可以带路径
  #  file: out.log
  # 配置日志存放路径,日志文件名为:spring.log
  path: ./log
  file:
    # 设置日志文件大小
    max-size: 10MB

注意:file 和 path 是不能同时配置的,如果同时配置path不会生效。

打印级别控制

  可通过配置控制日志打印级别,格式如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
logging.level.*=TRACE/DEBUG/INFO/...

*可以为包名或 Logger 名,如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
logging:
  level:
    # root日志以WARN级别输出
    root: info
    # 此包下所有classDEBUG级别输出
    com.example.log_demo.log1: warn

logback 详细配置

  接下来说明如何通过独立的 xml 配置文件来配置日志打印。虽然 springboot 是要消灭 xml 的,但是有些复杂功能还是得编写 xml。使用 xml 后要将 application.yml 中的配置去掉,避免冲突.

  根据不同的日志系统,按照指定的规则组织配置文件名,并放在 resources 目录下,就能自动被 spring boot 加载:

  • Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j: log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2: log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging): logging.properties

想要自定义文件名的可配置:logging.config指定配置文件名:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
logging.config=classpath:logging-config.xml

Spring Boot 官方推荐优先使用带有 -spring 的文件名作为你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml ),命名为 logback-spring.xml 的日志配置文件, spring boot 可以为它添加一些 spring boot 特有的配置项(下面会提到)。

logback 配置文件的组成

  根节点<configuration>有 5 个子节点,下面来进行一一介绍。

<root>节点

  root 节点是必选节点,用来指定最基础的日志输出级别,只有一个 level 属性,用于设置打印级别,可选如下:TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF

  root 节点可以包含 0 个或多个元素,将appender添加进来。如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<root level="debug">
 <appender-ref ref="console" />
 <appender-ref ref="file" />
</root>

appender 也是子节点之一,将会在后面说明。

<contextName>节点

  设置上下文名称,默认为default,可通过%contextName来打印上下文名称,一般不使用此属性。

<property>节点

  用于定义变量,方便使用。有两个属性:name,value。定义变量后,可以使用${}来使用变量。如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<property name="path" value="./log"/>
<property name="appname" value="app"/>

<appender>节点

  appender 用来格式化日志输出的节点,这个最重要。有两个属性:

  • name:该本 appender 命名
  • class:指定输出策略,通常有两种:控制台输出,文件输出

下面通过例子来说明这个怎么用:

  1. 输出到控制台/按时间输出日志
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--设置存储路径变量-->
    <property name="LOG_HOME" value="./log"/>

    <!--控制台输出appender-->
    <appender name="console" 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>
            <!--设置编码-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--文件输出,时间窗口滚动-->
    <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志名,指定最新的文件名,其他文件名使用FileNamePattern -->
        <File>${LOG_HOME}/timeFile/out.log</File>
        <!--文件滚动模式-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名,可设置文件类型为gz,开启文件压缩-->
            <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <!--按大小分割同一天的-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </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{50} - %msg%n</pattern>
            <!--设置编码-->
            <charset>UTF-8</charset>
        </encoder>

    </appender>

    <!--指定基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="console"/>
        <appender-ref ref="timeFileOutput"/>
    </root>
</configuration>
  1. 设置只输出单个级别

  在 appender 中设置,filter 子节点,在默认级别上再此过滤,配置 onMatch,onMismatch 可实现只输出单个级别

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<appender ...>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <!--接受匹配-->
        <onMatch>ACCEPT</onMatch>
        <!--拒绝不匹配的-->
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<logger>节点

构成

  此节点用来设置一个包或具体的某一个类的日志打印级别、以及指定<appender>,有以下三个属性:

  • name: 必须。用来指定受此 loger 约束的某个包或者某个具体的类
  • level:可选。设置打印级别。默认为 root 的级别。
  • addtivity: 可选。是否向上级 loger(也就是 root 节点)传递打印信息。默认为 true。

使用示例如下:

  1. 不指定级别,不指定 appender
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<!-- 控制com.example.service下类的打印,使用root的level和appender -->
<logger name="com.example.service"/>

2.指定级别,不指定 appender

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<!-- 控制com.example.service下类的打印,使用root的appender打印warn级别日志 -->
<logger name="com.example.service" level="WARN"/>

3.指定级别,指定 appender

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<!-- 控制com.example.service下类的打印,使用console打印warn级别日志 -->
<!-- 设置addtivity是因为这里已经指定了appender,如果再向上传递就会被root下的appender再次打印 -->
<logger name="com.example.service" level="WARN" addtivity="false">
    <appender-ref ref="console">
</logger>

通过指定 appender 就能将指定的包下的日志打印到指定的文件中。

多环境日志输出

  通过设置文件名为-spring 结尾,可分环境配置 logger,示例如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
<configuration>
    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="console"/>
        </logger>
    </springProfile>
    <!-- 生产环境. -->
    <springProfile name="prod">
        <logger name="com.example.demo" level="INFO" additivity="false">
            <appender-ref ref="timeFileOutput"/>
        </logger>
    </springProfile>
</configuration>

通过配置spring.profiles.active也能做到切换上面的 logger 打印设置

结束

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019-06-06 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Knative 入门系列1:knative 概述
Knative 是一个基于 Kubernetes 的,用于构建、部署和管理现代 serverless 应用的平台。Getting Started with Knative 是一本由 Pivotal 公司赞助 O’Reilly 出品的电子书,公众号后台回复”knative“获取下载地址。本书中文版由 ServiceMesher 社区自发翻译,从今天起 ServiceMesher 社区将陆续为大家推出本书的中文译文。
崔秀龙
2019/07/23
2.5K0
Knative 入门系列1:knative 概述
Knative入门系列6:Knative的使用
Knative 是一个基于 Kubernetes 的,用于构建、部署和管理现代 serverless 应用的平台。Getting Started with Knative 是一本由 Pivotal 公司赞助 O’Reilly 出品的电子书,公众号后台回复“knative”获取英文版下载地址。本书中文版由 ServiceMesher 社区自发翻译系列文章,这是该系列的第6章。
崔秀龙
2019/07/23
3.9K0
Isito 入门(二):Istio 的部署
本教程已加入 Istio 系列:https://istio.whuanle.cn
痴者工良
2023/07/21
1.7K0
Isito 入门(二):Istio 的部署
Knative 入门系列8:拓展与展望
Knative 是一个基于 Kubernetes 的,用于构建、部署和管理现代 serverless 应用的平台。Getting Started with Knative 是一本由 Pivotal 公司赞助 O’Reilly 出品的电子书,公众号后台回复“knative”获取英文版下载地址。本书中文版由 ServiceMesher 社区自发翻译系列文章,这是该系列的第8章,至此全书翻译完毕,我们将后续为大家提供PDF。
崔秀龙
2019/07/23
1.1K0
外包精通--Istio Ingress Gateway
在kubernetes环境中,kubernetes Ingress Resource常用来指定应该暴露给集群外部的服务。在一个Istio的服务网格中,最好的办法就是使用不同的配置模型,也就是Istio Gateway。一个gateway允许Istio的功能,比如监控和路由规则去应用到进入集群的流量 。
Godev
2023/06/22
8300
Knative 入门系列7:实战演练
Knative 是一个基于 Kubernetes 的,用于构建、部署和管理现代 serverless 应用的平台。Getting Started with Knative 是一本由 Pivotal 公司赞助 O’Reilly 出品的电子书,公众号后台回复“knative”获取英文版下载地址。本书中文版由 ServiceMesher 社区自发翻译系列文章,这是该系列的第7章。
崔秀龙
2019/07/23
1.8K0
Knative 入门系列7:实战演练
Knative 入门系列3:Build 介绍
Knative 的 Serving(服务)组件是解决如何从容器到 URL 的,而 Build 组件是解决如何从源代码到容器的。Build resource 允许您定义如何编译代码和构建容器,而不是指向预构建的容器镜像。这确保了在将代码发送到容器镜像库之前以一致的方式编译和打包代码。在本章中将会向你介绍一些新的组件:
崔秀龙
2019/07/23
2.6K0
Istio 系列篇二 | Istio 的安装以及入门使用
前面的 Istio 系列篇一 | 服务网格和 Istio ,主要让大家对 服务网格和 Istio 有个大概的了解。
gopher云原生
2022/02/23
4.6K0
Istio 系列篇二 | Istio 的安装以及入门使用
Knative 入门系列2:Serving 介绍
即便使用无服务器架构,处理和响应 HTTP 请求的能力依然重要。在开始写代码使用事件触发一个函数之前,您需要有地方来运行代码。
崔秀龙
2019/07/23
1.9K0
Knative 入门系列2:Serving 介绍
mac 上学习k8s系列(34)knative part I
knative是google基于k8s crd打造的serverless平台,knative 把整个系统分成了三个部分:
golangLeetcode
2022/08/02
3320
istio(1) - 安装测试
1. istio 版本选择 - 最新版 istio,参考 istio官网; - 历史版 istio,参考 istio 历史版本归档档案; - kubernetes 与 istio版本适配 最新版 (1.4.3), 由下图可知, 其支持kubernetes 1.13, 1.14, 1.15 三个版本. 5eb1edfc1dd642c095920a79a4184126-0338d77a7b9a4b9faa3ea8d09d47e089.png 历史版 (1.1.9), 由下图可知, 其支持kubernetes
惊羽-布壳儿
2022/06/15
8150
istio(1) - 安装测试
Istio 入门(三):体验 Istio、微服务部署、可观测性
在本章中,我们正式迈入学习 Istio 的第一步。因为 Istio 的知识体系是较为庞大的,因此我们可以先通过本章的入门教程快速了解如何使用 Istio 部署一套微服务,以及 Istio 核心功能的使用方法,了解 Istio 可以为微服务解决什么问题。
痴者工良
2023/07/24
2.1K0
Istio 入门(三):体验 Istio、微服务部署、可观测性
Knative快速入门与实践
Knative服务模块提供了简化的部署语法来使服务在Kubernetes集群中运行,并且这些服务具备根据HTTP负载自动扩容或者缩容到零的能力
yeedomliu
2022/03/29
1.6K0
Knative快速入门与实践
迈向 serverless 开发的第一步[每日前端夜话0xEE]
在本文的第一部分中,我们将讨论设置适合 Knative 0.6.0 版的开发环境。第二部分介绍第一个 serverless 微服务的部署。使用 Knative 创建 serverless 应用程序的基本要求是对 Kubernetes 的扎实知识。如果你没有经验,则应该学习官方的基本 Kubernetes 教程[1]。
疯狂的技术宅
2019/11/25
9120
istio-ingressgateway 学习
除了支持 Kubernetes Ingress,Istio还提供了另一种配置模式,Istio Gateway。与Ingress相比,Gateway提供了更广泛的自定义和灵活性,并允许将 Istio 功能(例如监控和路由规则)应用于进入集群的流量。
tanmx
2023/10/18
1.2K0
istio-ingressgateway 学习
Mesh1# istio安装与部署
Istio作为service mesh控制面的实施标准,先部署起来。然而会有一个坑要注意,否则无法访问到页面。这个坑是个示例的bug,已被人提了issue,我也被坑了一把。
瓜农老梁
2021/09/23
7670
Mesh1# istio安装与部署
(译)Knative:在 Kubernetes 上构建可移植 Serverless 平台
Kubernetes 目前如日中天,这一项目不仅在容器编排方面独占鳌头,还给基础设施自动化进程提供了可实践的原语。
崔秀龙
2019/07/23
1.7K0
(译)Knative:在 Kubernetes 上构建可移植 Serverless 平台
Service Mesh - Istio安装与部署
在当前版本Istio的安装与部署已经变得非常简单了,只需要几个简单的步骤就能将Istio环境搭建起来。首先要做的是下载Istio(在文档中核对Istio支持的k8s版本):
端碗吹水
2020/12/23
1.4K0
Service Mesh - Istio安装与部署
istio-4:使用istioctl方式部署istio-1.8.3全组件
2.2.2.安装grafana/jaeger/kiali/prometheus组件
千里行走
2021/03/18
1.4K0
istio 部署
下载地址:https://github.com/istio/istio/releases
星哥玩云
2022/09/15
1.1K0
istio 部署
相关推荐
Knative 入门系列1:knative 概述
更多 >
交个朋友
加入行业数字化趋势交流群
解读转型政策方向 参考企业落地案例
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档