What is default CONSOLE_LOG_PATTERN used for Spring Boot logging and where to find it?

Question

The Spring Boot reference documentation 4.6. Custom Log Configuration states about the default system properties representing a default logging pattern to use on the console (only supported with the default Logback setup).

Spring Environment: logging.pattern.console
System Property: CONSOLE_LOG_PATTERN

I guess the default log line look is familiar for all the Spring Boot framework users:

2020-08-04 12:00:00.000  INFO 24568 --- [           main] c.c.MyWonderfulSpringApplication          : The following profiles are active: local

As long as I want to take look on how it looks and get inspired for defining my own one, where can I find this default value for a currently used version of Spring Boot?

Nikolas Charalambidis · Accepted Answer · 2023-07-12T06:15:11.480

I have just found out this configuration is available at the DefaultLogbackConfiguration file under Spring Boot project:

private static final String CONSOLE_LOG_PATTERN = "%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} "
            + "%clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} "
            + "%clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} "
            + "%clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}";

To find the pattern for a certain Spring Boot version, either:

Browse the source file available at GitHub: Spring Boot 2.3.x.
In IntelliJ Idea press 2x Left Shift and search in the Classes tab for DefaultLogbackConfiguration.

The source of my finding is https://www.logicbig.com/tutorials/spring-framework/spring-boot/logging-console-pattern.html.

Here's the full string without being split up: `%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}` — blacktide, Sep 25 '21 at 05:27

score 10 · Answer 2 · edited Jan 11 '22 at 13:14

If you are using logback-spring.xml, then adding the following to your xml would automatically pick up spring's default logback configuration for console appender.

<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<root level="INFO">
    <appender-ref ref="CONSOLE" />
</root>

Reference: https://docs.spring.io/spring-boot/docs/2.2.6.RELEASE/reference/html/howto.html#howto-configure-logback-for-logging

What is default CONSOLE_LOG_PATTERN used for Spring Boot logging and where to find it?

2 Answers2