日志

Spring Boot 对所有内部日志记录使用 Commons Logging,但底层日志实现是开放的。为 Java Util LoggingLog4j2Logback 提供了默认配置。在每种情况下,日志记录器都预配置为使用控制台输出,并可选地提供文件输出。

默认情况下,如果你使用 starter,会使用 Logback 进行日志记录。还包括适当的 Logback 路由,以确保使用 Java Util Logging、Commons Logging、Log4J 或 SLF4J 的依赖库都能正常工作。

Java 有许多可用的日志框架。如果上面的列表让你感到困惑,请不用担心。通常情况下,你无需更改日志依赖项,Spring Boot 的默认设置就能很好地工作。
当你将应用部署到 Servlet 容器或应用服务器时,使用 Java Util Logging API 执行的日志不会路由到你的应用日志中。这可以防止由容器或部署到其中的其他应用执行的日志出现在你的应用日志中。

日志格式

Spring Boot 的默认日志输出类似于以下示例

2025-04-24T13:04:32.244Z  INFO 127615 --- [myapp] [           main] o.s.b.d.f.logexample.MyApplication       : Starting MyApplication using Java 17.0.15 with PID 127615 (/opt/apps/myapp.jar started by myuser in /opt/apps/)
2025-04-24T13:04:32.277Z  INFO 127615 --- [myapp] [           main] o.s.b.d.f.logexample.MyApplication       : No active profile set, falling back to 1 default profile: "default"
2025-04-24T13:04:37.586Z  INFO 127615 --- [myapp] [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port 8080 (http)
2025-04-24T13:04:37.655Z  INFO 127615 --- [myapp] [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2025-04-24T13:04:37.657Z  INFO 127615 --- [myapp] [           main] o.apache.catalina.core.StandardEngine    : Starting Servlet engine: [Apache Tomcat/10.1.40]
2025-04-24T13:04:37.818Z  INFO 127615 --- [myapp] [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2025-04-24T13:04:37.820Z  INFO 127615 --- [myapp] [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 5186 ms
2025-04-24T13:04:39.165Z  INFO 127615 --- [myapp] [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port 8080 (http) with context path '/'
2025-04-24T13:04:39.199Z  INFO 127615 --- [myapp] [           main] o.s.b.d.f.logexample.MyApplication       : Started MyApplication in 9.336 seconds (process running for 10.225)
2025-04-24T13:04:39.250Z  INFO 127615 --- [myapp] [ionShutdownHook] o.s.b.w.e.tomcat.GracefulShutdown        : Commencing graceful shutdown. Waiting for active requests to complete
2025-04-24T13:04:39.268Z  INFO 127615 --- [myapp] [tomcat-shutdown] o.s.b.w.e.tomcat.GracefulShutdown        : Graceful shutdown complete

输出以下项

  • 日期和时间:精确到毫秒,易于排序。

  • 日志级别:ERRORWARNINFODEBUGTRACE

  • 进程 ID。

  • 一个 --- 分隔符,用于区分实际日志消息的开始。

  • 应用名称:用方括号括起来(仅在设置了 spring.application.name 时默认记录)

  • 应用分组:用方括号括起来(仅在设置了 spring.application.group 时默认记录)

  • 线程名称:用方括号括起来(在控制台输出中可能会被截断)。

  • 关联 ID:如果启用了跟踪(未在上面的示例中显示)

  • 日志记录器名称:通常是源类名(经常缩写)。

  • 日志消息。

Logback 没有 FATAL 级别。它被映射到 ERROR
如果你设置了 spring.application.name 属性但不想记录它,可以将 logging.include-application-name 设置为 false
如果你设置了 spring.application.group 属性但不想记录它,可以将 logging.include-application-group 设置为 false
有关关联 ID 的更多详细信息,请参阅此文档

控制台输出

默认日志配置会将消息写入控制台时进行回显。默认情况下,会记录 ERROR 级别、WARN 级别和 INFO 级别的消息。你还可以通过使用 --debug 标志启动应用来启用“调试”模式。

$ java -jar myapp.jar --debug
你也可以在你的 application.properties 中指定 debug=true

启用调试模式后,会配置一部分核心日志记录器(嵌入式容器、Hibernate 和 Spring Boot)输出更多信息。启用调试模式并不会配置你的应用以 DEBUG 级别记录所有消息。

或者,你可以通过使用 --trace 标志(或在你的 application.properties 中设置 trace=true)启动应用来启用“跟踪”模式。这样做会为一部分核心日志记录器(嵌入式容器、Hibernate 模式生成以及整个 Spring 体系)启用跟踪日志记录。

彩色输出

如果你的终端支持 ANSI,会使用彩色输出以提高可读性。你可以将 spring.output.ansi.enabled 设置为支持的值来覆盖自动检测。

通过使用 %clr 转换词来配置颜色编码。在最简单的形式下,转换器会根据日志级别为输出着色,如下例所示

%clr(%5p)

下表描述了日志级别到颜色的映射

级别 颜色

FATAL

红色

ERROR

红色

WARN

黄色

INFO

绿色

DEBUG

绿色

TRACE

绿色

或者,你可以通过将颜色或样式作为转换的选项来指定应使用的颜色或样式。例如,要使文本显示为黄色,使用以下设置

%clr(%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}){yellow}

支持以下颜色和样式

  • 蓝色

  • 青色

  • 暗淡

  • 绿色

  • 洋红色

  • 红色

  • 黄色

文件输出

默认情况下,Spring Boot 只将日志输出到控制台,不写入日志文件。如果你想除了控制台输出外还写入日志文件,你需要设置 logging.file.namelogging.file.path 属性(例如,在你的 application.properties 中)。如果这两个属性都设置了,logging.file.path 将被忽略,只使用 logging.file.name

下表显示了如何一起使用 logging.* 属性

表 1. 日志属性
logging.file.name logging.file.path 描述

(无)

(无)

仅控制台日志记录。

特定文件(例如,my.log

(无)

写入 logging.file.name 指定的位置。位置可以是绝对路径或相对于当前目录的相对路径。

(无)

特定目录(例如,/var/log

spring.log 写入 logging.file.path 指定的目录。目录可以是绝对路径或相对于当前目录的相对路径。

特定文件

特定目录

写入 logging.file.name 指定的位置,忽略 logging.file.path。位置可以是绝对路径或相对于当前目录的相对路径。

日志文件达到 10 MB 时会轮转,与控制台输出一样,默认情况下会记录 ERROR 级别、WARN 级别和 INFO 级别的消息。

日志属性独立于实际的日志基础设施。因此,特定的配置键(例如 Logback 的 logback.configurationFile)不由 Spring Boot 管理。

文件轮转

如果你使用 Logback,可以使用你的 application.propertiesapplication.yaml 文件微调日志轮转设置。对于所有其他日志系统,你需要自己直接配置轮转设置(例如,如果你使用 Log4j2,可以添加 log4j2.xmllog4j2-spring.xml 文件)。

支持以下轮转策略属性

名称 描述

logging.logback.rollingpolicy.file-name-pattern

用于创建日志归档的文件名模式。

logging.logback.rollingpolicy.clean-history-on-start

应用启动时是否应清理日志归档。

logging.logback.rollingpolicy.max-file-size

在日志文件被归档前的最大大小。

logging.logback.rollingpolicy.total-size-cap

日志归档在被删除前的最大总大小。

logging.logback.rollingpolicy.max-history

保留的归档日志文件的最大数量(默认为 7)。

日志级别

所有支持的日志系统都可以通过在 Spring Environment 中设置日志记录器级别(例如,在 application.properties 中),使用 logging.level.<logger-name>=<level> 格式,其中 level 是 TRACE、DEBUG、INFO、WARN、ERROR、FATAL 或 OFF 中的一个。root 日志记录器可以使用 logging.level.root 进行配置。

以下示例显示了 application.properties 中可能的日志设置

  • Properties

  • YAML

logging.level.root=warn
logging.level.org.springframework.web=debug
logging.level.org.hibernate=error
logging:
  level:
    root: "warn"
    org.springframework.web: "debug"
    org.hibernate: "error"

也可以使用环境变量设置日志级别。例如,LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG 会将 org.springframework.web 的级别设置为 DEBUG

上述方法只适用于包级别的日志记录。由于 relaxed binding 总是将环境变量转换为小写,因此无法通过这种方式配置单个类的日志记录。如果你需要配置某个类的日志记录,可以使用 SPRING_APPLICATION_JSON 变量。

日志分组

通常将相关的日志记录器分组在一起非常有用,这样可以同时配置它们。例如,你可能经常需要更改所有与 Tomcat 相关的日志记录器的日志级别,但你可能无法轻松记住顶层包名。

为了提供帮助,Spring Boot 允许你在 Spring Environment 中定义日志分组。例如,你可以通过将其添加到你的 application.properties 来定义一个名为“tomcat”的分组

  • Properties

  • YAML

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
logging:
  group:
    tomcat: "org.apache.catalina,org.apache.coyote,org.apache.tomcat"

定义后,你可以通过一行代码更改分组中所有日志记录器的级别

  • Properties

  • YAML

logging.level.tomcat=trace
logging:
  level:
    tomcat: "trace"

Spring Boot 包括以下预定义的日志分组,可以直接使用

名称 日志记录器

web

org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans

sql

org.springframework.jdbc.core, org.hibernate.SQL, LoggerListener

使用日志关闭钩子

为了在应用终止时释放日志资源,提供了一个关闭钩子,它会在 JVM 退出时触发日志系统清理。除非你的应用部署为 war 文件,否则此关闭钩子会自动注册。如果你的应用具有复杂的上下文层次结构,则关闭钩子可能无法满足你的需求。如果不能满足,请禁用关闭钩子并研究底层日志系统直接提供的选项。例如,Logback 提供了上下文选择器,允许在自己的上下文中创建每个 Logger。你可以使用 logging.register-shutdown-hook 属性禁用关闭钩子。将其设置为 false 将禁用注册。你可以在你的 application.propertiesapplication.yaml 文件中设置此属性

  • Properties

  • YAML

logging.register-shutdown-hook=false
logging:
  register-shutdown-hook: false

自定义日志配置

通过在类路径中包含相应的库,可以激活各种日志系统,并且可以通过在类路径的根目录或由以下 Spring Environment 属性指定的位置提供合适的配置文件来进一步定制:logging.config

你可以通过使用 org.springframework.boot.logging.LoggingSystem 系统属性强制 Spring Boot 使用特定的日志系统。该值应是 LoggingSystem 实现的完全限定类名。你也可以通过使用值 none 完全禁用 Spring Boot 的日志配置。

由于日志记录在 ApplicationContext 创建之前初始化,因此无法通过 Spring @Configuration 文件中的 @PropertySources 控制日志记录。更改日志系统或完全禁用它的唯一方法是通过 System properties。

根据你的日志系统,会加载以下文件

日志系统 定制

Logback

logback-spring.xmllogback-spring.groovylogback.xmllogback.groovy

Log4j2

log4j2-spring.xmllog4j2.xml

JDK (Java Util Logging)

logging.properties

如果可能,我们建议你对日志配置使用 -spring 变体(例如,使用 logback-spring.xml 而不是 logback.xml)。如果你使用标准配置位置,Spring 无法完全控制日志初始化。
Java Util Logging 存在已知的类加载问题,在从“可执行 jar”运行时会导致问题。如果可能,我们建议你在从“可执行 jar”运行时避免使用它。

为了帮助定制,一些其他属性从 Spring Environment 转移到 System properties。这使得日志系统配置可以消费这些属性。例如,在 application.properties 中设置 logging.file.name 或将 LOGGING_FILE_NAME 设置为环境变量,将导致 LOG_FILE 系统属性被设置。转移的属性如下表所示

Spring Environment System Property 注释

logging.exception-conversion-word

LOG_EXCEPTION_CONVERSION_WORD

记录异常时使用的转换词。

logging.file.name

LOG_FILE

如果定义,将在默认日志配置中使用。

logging.file.path

LOG_PATH

如果定义,将在默认日志配置中使用。

logging.pattern.console

CONSOLE_LOG_PATTERN

在控制台 (stdout) 上使用的日志模式。

logging.pattern.dateformat

LOG_DATEFORMAT_PATTERN

日志日期格式的 Appender 模式。

logging.charset.console

CONSOLE_LOG_CHARSET

控制台日志记录使用的字符集。

logging.threshold.console

CONSOLE_LOG_THRESHOLD

控制台日志记录使用的日志级别阈值。

logging.pattern.file

FILE_LOG_PATTERN

在文件中使用的日志模式(如果 LOG_FILE 启用)。

logging.charset.file

FILE_LOG_CHARSET

文件日志记录使用的字符集(如果 LOG_FILE 启用)。

logging.threshold.file

FILE_LOG_THRESHOLD

文件日志记录使用的日志级别阈值。

logging.pattern.level

LOG_LEVEL_PATTERN

渲染日志级别时使用的格式(默认 %5p)。

logging.structured.format.console

CONSOLE_LOG_STRUCTURED_FORMAT

控制台日志记录使用的结构化日志格式。

logging.structured.format.file

FILE_LOG_STRUCTURED_FORMAT

文件日志记录使用的结构化日志格式。

PID

PID

当前进程 ID(如果可能则发现,并且在未作为 OS 环境变量定义时)。

如果你使用 Logback,也会转移以下属性

Spring Environment System Property 注释

logging.logback.rollingpolicy.file-name-pattern

LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN

轮转日志文件名的模式(默认 ${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz)。

logging.logback.rollingpolicy.clean-history-on-start

LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START

启动时是否清理归档日志文件。

logging.logback.rollingpolicy.max-file-size

LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE

最大日志文件大小。

logging.logback.rollingpolicy.total-size-cap

LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP

保留的日志备份总大小。

logging.logback.rollingpolicy.max-history

LOGBACK_ROLLINGPOLICY_MAX_HISTORY

保留的归档日志文件最大数量。

所有支持的日志系统在解析其配置文件时都可以参考 System properties。请参阅 spring-boot.jar 中的默认配置示例

如果你想在日志属性中使用占位符,应该使用 Spring Boot 的语法,而不是底层框架的语法。特别是,如果你使用 Logback,你应该使用 : 作为属性名及其默认值之间的分隔符,而不是使用 :-

你可以通过仅覆盖 LOG_LEVEL_PATTERN(或与 Logback 一起使用的 logging.pattern.level)向日志行添加 MDC 和其他临时内容。例如,如果你使用 logging.pattern.level=user:%X{user} %5p,则默认日志格式将包含一个名为 "user" 的 MDC 条目(如果存在),如下例所示。

2019-08-30 12:30:04.031 user:someone INFO 22174 --- [  nio-8080-exec-0] demo.Controller
Handling authenticated request

结构化日志记录

结构化日志记录是一种将日志输出写入定义明确、通常机器可读的格式的技术。Spring Boot 支持结构化日志记录,并开箱即用支持以下 JSON 格式

要启用结构化日志记录,请将属性 logging.structured.format.console(用于控制台输出)或 logging.structured.format.file(用于文件输出)设置为你要使用的格式 ID。

如果你正在使用自定义日志配置,请更新你的配置以遵循 CONSOLE_LOG_STRUCTURED_FORMATFILE_LOG_STRUCTURED_FORMAT 系统属性。以 CONSOLE_LOG_STRUCTURED_FORMAT 为例

  • Logback

  • Log4j2

<!-- replace your encoder with StructuredLogEncoder -->
<encoder class="org.springframework.boot.logging.logback.StructuredLogEncoder">
	<format>${CONSOLE_LOG_STRUCTURED_FORMAT}</format>
	<charset>${CONSOLE_LOG_CHARSET}</charset>
</encoder>

你也可以参考 Spring Boot 中包含的默认配置

<!-- replace your PatternLayout with StructuredLogLayout -->
<StructuredLogLayout format="${sys:CONSOLE_LOG_STRUCTURED_FORMAT}" charset="${sys:CONSOLE_LOG_CHARSET}"/>

你也可以参考 Spring Boot 中包含的默认配置

Elastic Common Schema

Elastic Common Schema 是一种基于 JSON 的日志格式。

要启用 Elastic Common Schema 日志格式,请将相应的 format 属性设置为 ecs

  • Properties

  • YAML

logging.structured.format.console=ecs
logging.structured.format.file=ecs
logging:
  structured:
    format:
      console: ecs
      file: ecs

日志行看起来像这样

{"@timestamp":"2024-01-01T10:15:00.067462556Z","log.level":"INFO","process.pid":39599,"process.thread.name":"main","service.name":"simple","log.logger":"org.example.Application","message":"No active profile set, falling back to 1 default profile: \"default\"","ecs.version":"8.11"}

此格式还会将 MDC 中包含的每个键值对添加到 JSON 对象。你也可以使用SLF4J 流式日志 API 通过 addKeyValue 方法将键值对添加到日志 JSON 对象中。

可以使用 logging.structured.ecs.service 属性自定义 service

  • Properties

  • YAML

logging.structured.ecs.service.name=MyService
logging.structured.ecs.service.version=1
logging.structured.ecs.service.environment=Production
logging.structured.ecs.service.node-name=Primary
logging:
  structured:
    ecs:
      service:
        name: MyService
        version: 1.0
        environment: Production
        node-name: Primary
如果未指定 logging.structured.ecs.service.name,则默认为 spring.application.name
如果未指定 logging.structured.ecs.service.version,则默认为 spring.application.version

Graylog Extended Log Format (GELF)

Graylog Extended Log Format 是一种基于 JSON 的日志格式,用于 Graylog 日志分析平台。

要启用 Graylog Extended Log Format,请将相应的 format 属性设置为 gelf

  • Properties

  • YAML

logging.structured.format.console=gelf
logging.structured.format.file=gelf
logging:
  structured:
    format:
      console: gelf
      file: gelf

日志行看起来像这样

{"version":"1.1","short_message":"No active profile set, falling back to 1 default profile: \"default\"","timestamp":1725958035.857,"level":6,"_level_name":"INFO","_process_pid":47649,"_process_thread_name":"main","_log_logger":"org.example.Application"}

此格式还会将 MDC 中包含的每个键值对添加到 JSON 对象。你也可以使用SLF4J 流式日志 API 通过 addKeyValue 方法将键值对添加到日志 JSON 对象中。

可以使用 logging.structured.gelf 属性自定义一些字段

  • Properties

  • YAML

logging.structured.gelf.host=MyService
logging.structured.gelf.service.version=1
logging:
  structured:
    gelf:
      host: MyService
      service:
        version: 1.0
如果未指定 logging.structured.gelf.host,则默认为 spring.application.name
如果未指定 logging.structured.gelf.service.version,则默认为 spring.application.version

Logstash JSON 格式

Logstash JSON 格式 是一个基于 JSON 的日志格式。

要启用 Logstash JSON 日志格式,请将相应的 format 属性设置为 logstash

  • Properties

  • YAML

logging.structured.format.console=logstash
logging.structured.format.file=logstash
logging:
  structured:
    format:
      console: logstash
      file: logstash

日志行看起来像这样

{"@timestamp":"2024-01-01T10:15:00.111037681+02:00","@version":"1","message":"No active profile set, falling back to 1 default profile: \"default\"","logger_name":"org.example.Application","thread_name":"main","level":"INFO","level_value":20000}

此格式还会将 MDC 中包含的每个键值对添加到 JSON 对象。你也可以使用SLF4J 流式日志 API 通过 addKeyValue 方法将键值对添加到日志 JSON 对象中。

如果你添加 标记,它们将以一个 tags 字符串数组的形式出现在 JSON 中。

自定义结构化日志 JSON

Spring Boot 会为结构化日志输出的 JSON 名称和值选择合理的默认值。然而,有时你可能需要根据自己的需求对 JSON 进行一些微调。例如,你可能想要更改某些名称以匹配你的日志摄取系统的预期。你可能还想过滤掉某些成员,因为你觉得它们没用。

以下属性允许你更改结构化日志 JSON 的写入方式

属性 描述

logging.structured.json.includelogging.structured.json.exclude

从 JSON 中过滤掉特定路径

logging.structured.json.rename

重命名 JSON 中的特定成员

logging.structured.json.add

向 JSON 中添加额外的成员

例如,以下设置将排除 log.level,将 process.id 重命名为 procid,并添加一个固定的 corpname 字段

  • Properties

  • YAML

logging.structured.json.exclude=log.level
logging.structured.json.rename.process.id=procid
logging.structured.json.add.corpname=mycorp
logging:
  structured:
    json:
      exclude: log.level
      rename:
        process.id: procid
      add:
        corpname: mycorp
对于更高级的自定义,你可以编写自己的类来实现 StructuredLoggingJsonMembersCustomizer 接口,并使用 logging.structured.json.customizer 属性声明它。你还可以通过将实现列在 META-INF/spring.factories 文件中来声明它们。

支持其他结构化日志格式

Spring Boot 中的结构化日志支持是可扩展的,允许你定义自己的自定义格式。为此,请实现 StructuredLogFormatter 接口。使用 Logback 时,泛型类型参数必须是 ILoggingEvent;使用 Log4j2 时,必须是 LogEvent(这意味着你的实现与特定的日志系统绑定)。然后,你的实现将通过日志事件被调用,并返回要记录的 String,如本例所示

  • Java

  • Kotlin

import ch.qos.logback.classic.spi.ILoggingEvent;

import org.springframework.boot.logging.structured.StructuredLogFormatter;

class MyCustomFormat implements StructuredLogFormatter<ILoggingEvent> {

	@Override
	public String format(ILoggingEvent event) {
		return "time=" + event.getInstant() + " level=" + event.getLevel() + " message=" + event.getMessage() + "\n";
	}

}
import ch.qos.logback.classic.spi.ILoggingEvent
import org.springframework.boot.logging.structured.StructuredLogFormatter

class MyCustomFormat : StructuredLogFormatter<ILoggingEvent> {

	override fun format(event: ILoggingEvent): String {
		return "time=${event.instant} level=${event.level} message=${event.message}\n"
	}

}

如示例所示,你可以返回任何格式,不一定非要是 JSON。

要启用你的自定义格式,请将属性 logging.structured.format.consolelogging.structured.format.file 设置为你实现的完全限定类名。

你的实现可以使用一些构造函数参数,这些参数会自动注入。更多详细信息,请参阅 StructuredLogFormatter 的 JavaDoc。

Logback 扩展

Spring Boot 包含一些 Logback 扩展,可以帮助进行高级配置。你可以在 logback-spring.xml 配置文件中使用这些扩展。

由于标准的 logback.xml 配置文件加载得太早,你无法在其中使用扩展。你需要使用 logback-spring.xml 或定义一个 logging.config 属性。
这些扩展不能与 Logback 的配置扫描一起使用。如果你尝试这样做,更改配置文件会导致记录类似于以下内容之一的错误
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]

特定配置文件的配置

<springProfile> 标签允许你根据活跃的 Spring profiles 选择性地包含或排除配置部分。Profile 部分可以在 <configuration> 元素内的任何地方使用。使用 name 属性指定哪个 profile 接受该配置。 标签可以包含 profile 名称(例如 staging)或 profile 表达式。Profile 表达式允许表达更复杂的 profile 逻辑,例如 production & (eu-central | eu-west)。更多详细信息,请查阅 Spring Framework 参考指南。以下列表显示了三个示例 profile

<springProfile name="staging">
	<!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev | staging">
	<!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
	<!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

环境属性

<springProperty> 标签允许你从 Spring Environment 中暴露属性供 Logback 使用。如果你想在 Logback 配置中访问 application.properties 文件中的值,这样做会很有用。该标签的工作方式类似于 Logback 标准的 <property> 标签。然而,与其指定直接的 value,你指定属性的 source(来自 Environment)。如果你需要将属性存储在 local 范围之外的地方,可以使用 scope 属性。如果你需要一个备用值(以防属性在 Environment 中未设置),可以使用 defaultValue 属性。以下示例展示了如何在 Logback 中暴露属性供使用

<springProperty scope="context" name="fluentHost" source="myapp.fluentd.host"
		defaultValue="localhost"/>
<appender name="FLUENT" class="ch.qos.logback.more.appenders.DataFluentAppender">
	<remoteHost>${fluentHost}</remoteHost>
	...
</appender>
source 必须以 kebab-case 形式指定(例如 my.property-name)。然而,可以使用宽松规则将属性添加到 Environment 中。

Log4j2 扩展

Spring Boot 包含一些 Log4j2 扩展,可以帮助进行高级配置。你可以在任何 log4j2-spring.xml 配置文件中使用这些扩展。

由于标准的 log4j2.xml 配置文件加载得太早,你无法在其中使用扩展。你需要使用 log4j2-spring.xml 或定义一个 logging.config 属性。
这些扩展取代了 Log4J 提供的 Spring Boot 支持。你应该确保在构建中不包含 org.apache.logging.log4j:log4j-spring-boot 模块。

特定配置文件的配置

<SpringProfile> 标签允许你根据活跃的 Spring profiles 选择性地包含或排除配置部分。Profile 部分可以在 <Configuration> 元素内的任何地方使用。使用 name 属性指定哪个 profile 接受该配置。 标签可以包含 profile 名称(例如 staging)或 profile 表达式。Profile 表达式允许表达更复杂的 profile 逻辑,例如 production & (eu-central | eu-west)。更多详细信息,请查阅 Spring Framework 参考指南。以下列表显示了三个示例 profile

<SpringProfile name="staging">
	<!-- configuration to be enabled when the "staging" profile is active -->
</SpringProfile>

<SpringProfile name="dev | staging">
	<!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</SpringProfile>

<SpringProfile name="!production">
	<!-- configuration to be enabled when the "production" profile is not active -->
</SpringProfile>

环境属性查找

如果你想在 Log4j2 配置中引用 Spring Environment 中的属性,可以使用带有 spring: 前缀的查找。如果你想在 Log4j2 配置中访问 application.properties 文件中的值,这样做会很有用。

以下示例展示了如何设置名为 applicationNameapplicationGroup 的 Log4j2 属性,它们从 Spring Environment 读取 spring.application.namespring.application.group

<Properties>
	<Property name="applicationName">${spring:spring.application.name}</Property>
	<Property name="applicationGroup">${spring:spring.application.group}</Property>
</Properties>
查找键应以 kebab-case 形式指定(例如 my.property-name)。

Log4j2 系统属性

Log4j2 支持许多系统属性,可用于配置各种项。例如,log4j2.skipJansi 系统属性可用于配置 ConsoleAppender 是否会在 Windows 上尝试使用 Jansi 输出流。

Log4j2 初始化后加载的所有系统属性都可以从 Spring Environment 中获取。例如,你可以在 application.properties 文件中添加 log4j2.skipJansi=false,以便 ConsoleAppender 在 Windows 上使用 Jansi。

只有当系统属性和操作系统环境变量不包含要加载的值时,才会考虑 Spring Environment
Log4j2 早期初始化期间加载的系统属性无法引用 Spring Environment。例如,Log4j2 用于选择默认 Log4j2 实现的属性在使用时,Spring Environment 尚未可用。