|
对于最新的稳定版本，请使用 Spring Boot 3.4.0！ |
Logging
Spring Boot 使用 Commons Logging 进行所有内部日志记录，但将底层日志实现保持开放状态。 为 Java Util Logging、Log4j2 和 Logback 提供了默认配置。 在每种情况下，记录器都预先配置为使用控制台输出，并提供可选的文件输出。
默认情况下，如果使用Starters，则使用 Logback 进行日志记录。 还包括适当的 Logback 路由，以确保使用 Java Util Logging、Commons Logging、Log4J 或 SLF4J 的依赖库都能正常工作。
| 有很多可用于 Java 的日志记录框架。 如果上面的列表看起来令人困惑，请不要担心。 通常，您不需要更改日志记录依赖项，并且 Spring Boot 默认值可以正常工作。 |
| 将应用程序部署到 servlet 容器或应用程序服务器时，使用 Java Util Logging API 执行的日志记录不会路由到应用程序的日志中。 这可以防止容器或已部署到容器的其他应用程序执行的日志记录显示在应用程序的日志中。 |
日志格式
Spring Boot 的默认日志输出类似于以下示例：
2024-11-21T11:03:38.423Z INFO 117848 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : Starting MyApplication using Java 17.0.13 with PID 117848 (/opt/apps/myapp.jar started by myuser in /opt/apps/)
2024-11-21T11:03:38.432Z INFO 117848 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : No active profile set, falling back to 1 default profile: "default"
2024-11-21T11:03:40.261Z INFO 117848 --- [myapp] [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port 8080 (http)
2024-11-21T11:03:40.277Z INFO 117848 --- [myapp] [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2024-11-21T11:03:40.278Z INFO 117848 --- [myapp] [ main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/10.1.33]
2024-11-21T11:03:40.343Z INFO 117848 --- [myapp] [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2024-11-21T11:03:40.346Z INFO 117848 --- [myapp] [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1836 ms
2024-11-21T11:03:40.931Z INFO 117848 --- [myapp] [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port 8080 (http) with context path '/'
2024-11-21T11:03:40.955Z INFO 117848 --- [myapp] [ main] o.s.b.d.f.logexample.MyApplication : Started MyApplication in 3.422 seconds (process running for 4.476)输出以下项目：
-
日期和时间：毫秒级精度，易于排序。
-
日志级别：
ERROR,WARN,INFO,DEBUG或TRACE. -
进程 ID。
-
用于区分实际日志消息的开头的分隔符。
--- -
应用程序名称：括在方括号中（默认情况下，仅当
spring.application.name已设置） -
线程名称：括在方括号中（对于控制台输出，可能会被截断）。
-
Correlation ID：如果启用了跟踪（在上面的示例中未显示）
-
Logger name：这通常是源类名称（通常缩写）。
-
日志消息。
Logback 没有FATAL水平。
它被映射到ERROR. |
如果你有spring.application.name属性，但不希望它被记录下来，你可以设置logging.include-application-name自false. |
控制台输出
默认日志配置在写入消息时将消息回显到控制台。
默认情况下，ERROR-水平WARN-level 和INFO-级别的消息。
您还可以通过使用--debug旗。
$ java -jar myapp.jar --debug您还可以指定debug=true在application.properties. |
启用调试模式后，将配置一系列核心 Logger（嵌入式容器、Hibernate 和 Spring Boot）以输出更多信息。
启用调试模式不会将应用程序配置为使用DEBUG水平。
或者，您可以通过使用--traceflag（或trace=true在application.properties).
这样做可以为选定的核心 Logger（嵌入式容器、Hibernate 模式生成和整个 Spring 产品组合）启用跟踪日志记录。
颜色编码输出
如果您的终端支持 ANSI，则使用颜色输出来提高可读性。
您可以设置spring.output.ansi.enabled设置为支持的值以覆盖自动检测。
颜色编码是使用%clr转换词。
在最简单的形式中，转换器根据对数级别为输出着色，如以下示例所示：
%clr(%5p)下表描述了对数级别到颜色的映射：
| 水平 | 颜色 |
|---|---|
|
红 |
|
红 |
|
黄色 |
|
绿 |
|
绿 |
|
绿 |
或者，您可以通过将颜色或样式作为转换选项来指定应使用的颜色或样式。 例如，要使文本变为黄色，请使用以下设置：
%clr(%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}){yellow}支持以下颜色和样式：
-
blue -
cyan -
faint -
green -
magenta -
red -
yellow
文件输出
默认情况下， Spring Boot 仅记录到控制台，不写入日志文件。
如果除了控制台输出之外还想写入日志文件，则需要设置logging.file.name或logging.file.path属性（例如，在application.properties).
如果同时设置了这两个属性，则logging.file.path被忽略，并且只有logging.file.name被使用。
下表显示了logging.*properties 可以一起使用：
logging.file.name |
logging.file.path |
描述 |
|---|---|---|
（无） |
（无） |
仅限控制台日志记录。 |
特定文件（例如 |
（无） |
写入 |
（无） |
特定目录（例如 |
写 |
特定文件 |
特定目录 |
写入 |
日志文件在达到 10 MB 时轮换，并且与控制台输出一样，ERROR-水平WARN-level 和INFO-level 消息。
日志记录属性独立于实际的日志记录基础结构。
因此，特定的配置键（例如logback.configurationFilefor Logback）不受 Spring Boot 管理。 |
文件旋转
如果您使用的是 Logback，则可以使用application.properties或application.yaml文件。
对于所有其他日志记录系统，您需要直接自己配置轮换设置（例如，如果您使用 Log4j2，则可以添加log4j2.xml或log4j2-spring.xml文件）。
支持以下轮换策略属性：
| 名字 | 描述 |
|---|---|
|
用于创建日志存档的文件名模式。 |
|
是否应在应用程序启动时进行日志存档清理。 |
|
日志文件存档前的最大大小。 |
|
日志存档在被删除之前可以占用的最大大小。 |
|
要保留的存档日志文件的最大数量（默认为 7）。 |
日志级别
所有受支持的日志记录系统都可以在 Spring 中设置 Logger 级别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=errorlogging:
level:
root: "warn"
org.springframework.web: "debug"
org.hibernate: "error"还可以使用环境变量设置日志记录级别。
例如LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG将设置org.springframework.web自DEBUG.
上述方法仅适用于包级日志记录。
由于松散绑定始终将环境变量转换为小写，因此无法以这种方式为单个类配置日志记录。
如果需要为类配置日志记录，可以使用这SPRING_APPLICATION_JSON变量。 |
日志组
能够将相关的 logger 分组在一起，以便可以同时配置它们通常很有用。 例如，您可能通常会更改所有与 Tomcat 相关的 Logger 的日志记录级别，但您无法轻松记住顶级包。
为了帮助解决这个问题，Spring Boot 允许您在 Spring 中定义日志记录组Environment.
例如，以下是如何通过将 “tomcat” 组添加到application.properties:
-
Properties
-
YAML
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcatlogging:
group:
tomcat: "org.apache.catalina,org.apache.coyote,org.apache.tomcat"定义后，您可以使用一行更改组中所有 logger 的级别：
-
Properties
-
YAML
logging.level.tomcat=tracelogging:
level:
tomcat: "trace"Spring Boot 包括以下预定义的日志记录组，这些组可以开箱即用：
| 名字 | Logging |
|---|---|
Web |
|
SQL |
|
使用日志关闭钩子
为了在应用程序终止时释放日志记录资源，提供了一个关闭钩子，该钩子将在 JVM 退出时触发日志系统清理。
除非您的应用程序部署为 war 文件，否则会自动注册此关闭钩子。
如果您的应用程序具有复杂的上下文层次结构，则 shutdown 钩子可能无法满足您的需求。
如果没有，请禁用 shutdown 钩子并调查底层日志记录系统直接提供的选项。
例如，Logback 提供了上下文选择器，允许在自己的上下文中创建每个 Logger。
您可以使用logging.register-shutdown-hook属性来禁用 shutdown 钩子。
将其设置为false将禁用注册。
您可以在application.properties或application.yaml文件：
-
Properties
-
YAML
logging.register-shutdown-hook=falselogging:
register-shutdown-hook: false自定义日志配置
可以通过在 Classpath 中包含适当的库来激活各种日志记录系统，并且可以通过在 Classpath 的根目录中或以下 Spring 指定的位置提供合适的配置文件来进一步定制Environment财产：logging.config.
您可以通过使用LoggingSystemsystem 属性。
该值应为LoggingSystem实现。
你还可以通过使用none.
由于日志记录是在ApplicationContext时，无法从@PropertySources春季@Configuration文件。
更改日志记录系统或完全禁用它的唯一方法是通过 System properties。 |
根据您的日志记录系统，将加载以下文件：
| 测井系统 | 定制 |
|---|---|
Logback （日志返回） |
|
日志 4j2 |
|
JDK（Java Util 日志记录） |
|
如果可能，我们建议您使用-spring变体（例如logback-spring.xml而不是logback.xml).
如果使用标准配置位置， Spring 则无法完全控制日志初始化。 |
| Java Util Logging 存在已知的类加载问题，这些问题会导致在从“可执行 jar”运行时出现问题。 我们建议您尽可能避免从“可执行 jar”运行时使用它。 |
为了帮助进行自定义，从 Spring 传输了一些其他属性Environment更改为 System properties。
这允许记录系统配置来使用属性。例如，将logging.file.name在application.properties或LOGGING_FILE_NAME作为环境变量将导致LOG_FILESystem 属性。
下表描述了传输的属性：
| Spring 环境 | 系统属性 | 评论 |
|---|---|---|
|
|
记录异常时使用的转换字。 |
|
|
如果已定义，则在默认日志配置中使用它。 |
|
|
如果已定义，则在默认日志配置中使用它。 |
|
|
要在控制台上使用的日志模式 （stdout）。 |
|
|
日志日期格式的 Appender 模式。 |
|
|
用于控制台日志记录的字符集。 |
|
|
用于控制台日志记录的日志级别阈值。 |
|
|
要在文件中使用的日志模式（如果 |
|
|
用于文件日志记录的字符集（如果 |
|
|
用于文件日志记录的日志级别阈值。 |
|
|
渲染日志级别（默认 |
|
|
当前进程 ID（如果可能且尚未定义为 OS 环境变量，则已发现）。 |
如果使用 Logback，则还会传输以下属性：
| Spring 环境 | 系统属性 | 评论 |
|---|---|---|
|
|
滚动日志文件名的模式（默认 |
|
|
是否在启动时清理存档日志文件。 |
|
|
最大日志文件大小。 |
|
|
要保留的日志备份的总大小。 |
|
|
要保留的存档日志文件的最大数量。 |
所有受支持的日志记录系统都可以在解析其配置文件时查阅 System properties。
请参阅spring-boot.jar例如：
|
如果要在日志记录属性中使用占位符，则应使用 Spring Boot 的语法，而不是底层框架的语法。
值得注意的是，如果您使用 Logback，则应使用 |
|
您可以通过仅覆盖 |
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>tag 允许您根据活动的 Spring 配置文件选择性地包含或排除配置部分。
Profile 部分在<configuration>元素。
使用name属性来指定哪个配置文件接受配置。
这<springProfile>标记可以包含配置文件名称（例如staging） 或配置文件表达式。
配置文件表达式允许表达更复杂的配置文件逻辑，例如production & (eu-central | eu-west).
有关更多详细信息，请查看 Spring Framework 参考指南。
以下清单显示了三个示例配置文件：
<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。
如果您想从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 大小写中指定（例如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>tag 允许您根据活动的 Spring 配置文件选择性地包含或排除配置部分。
Profile 部分在<Configuration>元素。
使用name属性来指定哪个配置文件接受配置。
这<SpringProfile>标记可以包含配置文件名称（例如staging） 或配置文件表达式。
配置文件表达式允许表达更复杂的配置文件逻辑，例如production & (eu-central | eu-west).
有关更多详细信息，请查看 Spring Framework 参考指南。
以下清单显示了三个示例配置文件：
<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>环境属性查找
如果要引用 Spring 中的属性Environment在 Log4j2 配置中，您可以使用spring:前缀查找。
如果您想从application.properties文件。
以下示例演示如何设置名为applicationName内容如下spring.application.name从Spring开始Environment:
<Properties>
<Property name="applicationName">${spring:spring.application.name}</Property>
</Properties>查找键应以 kebab 大小写指定（例如my.property-name). |
Log4j2 系统属性
Log4j2 支持许多可用于配置各种项目的系统属性。
例如，log4j2.skipJansisystem 属性可用于配置ConsoleAppender将尝试在 Windows 上使用 Jansi 输出流。
Log4j2 初始化后加载的所有系统属性都可以从 Spring 获取Environment.
例如，您可以添加log4j2.skipJansi=false发送到您的application.properties文件，将ConsoleAppender在 Windows 上使用 Jansi。
SpringEnvironment仅当系统属性和 OS 环境变量不包含正在加载的值时，才考虑。 |
在早期 Log4j2 初始化期间加载的系统属性无法引用 SpringEnvironment.
例如，在 Spring Environment 可用之前，使用了 Log4j2 用于允许选择默认 Log4j2 实现的属性。 |