Spring Boot logging pattern

Question

I have a problem with configuration on Logback in a Spring Boot application. I want my consoleAppender to look like the default Spring Boot console appender. How to inherit pattern from Spring Boot default console appender?

Below is my consoleAppender configuration

<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.classic.PatternLayout">
        <Pattern class="org.">
            %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
        </Pattern>
    </layout>
</appender>

Maybe you should follow issue github.com/spring-projects/spring-boot/issues/1788 - this may give you a solution when closed. — Bertrand Renuart
– Bertrand Renuart, Commented Jun 2, 2015 at 21:54

Michael Piefel · Accepted Answer · 2017-02-13 16:14:57Z

130

Once you have included the default configuration, you can use its values in your own logback-spring.xml configuration:

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
    <!-- use Spring default values -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>
    …
</configuration>

answered Feb 13, 2017 at 16:14

Michael Piefel

20.2k13 gold badges93 silver badges124 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

jediz Over a year ago

Don't forget adding <root level="INFO"><appender-ref ref="CONSOLE"/></root>, otherwise you won't get anything logged

Michael Piefel Over a year ago

That’s what you put instead of the ellipsis.

fethe Over a year ago

as jediz said above, this solution logs nothing unless you add <root level="INFO"><appender-ref ref="CONSOLE"/></root>

Niklas Peter Over a year ago

Probably you also want to add packagingData="true" in <configuration> for package names in exception log messages as it is the default with Spring Boot logging.

Camellia Nacheva Over a year ago

If the desire is to use the Spring default values, then instead of utf8 the default value CONSOLE_LOG_CHARSET can be used as well

lapaczo · Accepted Answer · 2017-02-24 13:23:44Z

51

You can find Spring Boot logback console logging pattern in defaults.xml file:

spring-boot-1.5.0.RELEASE.jar/org/springframework/boot/logging/logback/defaults.xml

Console pattern:

<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{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}}"/>

edited Feb 24, 2017 at 13:23

answered Feb 2, 2017 at 8:41

lapaczo

7967 silver badges11 bronze badges

5 Comments

Kalpesh Soni Over a year ago

what does LOG_EXCEPTION_CONVERSION_WORD do?

cdalxndr Over a year ago

This pattern goes through some variable substitution resulting in a different pattern

Jason Law Over a year ago

github.com/spring-projects/spring-boot/blob/main/…

Alexander Taylor Over a year ago

^^ I had to replace :- with : when I copied the latest log pattern from above Spring defaults.xml in order for it to work in my application.properties file (as logging.pattern.console and logging.pattern.file). :- is a Logback thing and : is a Spring thing.

Henrik Steudel Over a year ago

@AlexanderTaylor you, sir, are a literal lifesaver. Kudos, I would have never found this really ugly prerequisite. If this is not done, all log lines were prepended with "--" (SpringBoot 2.7.12)

Joman68 · Accepted Answer · 2022-03-09 02:34:20Z

25

If you are using application.yml for your config, you can set the logging pattern this way:

logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} | %-5level | %logger{1.} | %msg%n"
  level:
    org.springframework: WARN
    com.ulisesbocchio.jasyptspringboot: WARN
    com.example.test: DEBUG

You can override the logging level on the command line. For example:

$ java -Dlogging.level.com.example.test=TRACE -jar my-example.jar

answered Mar 9, 2022 at 2:34

Joman68

3,0105 gold badges42 silver badges40 bronze badges

1 Comment

Sherwin F Over a year ago

Thank you, I needed to update this without creating a whole logback config file so this is exactly what I was looking for.

Lukasz Frankowski · Accepted Answer · 2017-12-14 07:02:29Z

16

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>
                %clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx
            </Pattern>
        </layout>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>

</configuration>

edited Dec 14, 2017 at 7:02

answered Dec 14, 2017 at 6:54

Lukasz Frankowski

3,1831 gold badge37 silver badges33 bronze badges

1 Comment

jediz Over a year ago

are those conversion rules supposed to bring spring-defined colouring to logback? It's not working for me

wypieprz · Accepted Answer · 2017-08-17 14:44:28Z

10

It's been some time since this question was asked but since I had the problem myself recently and couldn't find an answer I started digging a bit deeper and found a solution that worked for me.

I ended up using the debugger and take a look at the default appenders attached to the logger.

I found this pattern to be working as desired for me:

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %5p 18737 --- [%t] %-40.40logger{39} : %m%n%wEx</pattern>

EDIT: The pattern is not entirely correct, I saw that runtime some values had already been instantiated (in this case 18737 ---) i will look into the proper variable to substitute there. It does contain the format for fixed length columns though

EDIT 2: Ok, I took another look at the debugger contents. This you can also do yourself by looking at the contents of a logger instance: Debugger(eclipse) Logger Contents

So I ended up using the pattern used in the consoleAppender:

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(18971){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx

As can be seen here:

Debugger: detailed contents of the encoder pattern

edited Aug 17, 2017 at 14:44

wypieprz

8,2494 gold badges50 silver badges50 bronze badges

answered Aug 11, 2016 at 11:52

Edvaaart

1222 silver badges12 bronze badges

2 Comments

Lukasz Frankowski Over a year ago

Thanks, in other answer I added full working logback.xml with this pattern. It requires conversionRules elements from spring default.xml to work.

Snackoverflow Over a year ago

Why do you have the value 18971 explicitly in the pattern? Isn't this a meaningful variable which changes between different launches?

DV Singh · Accepted Answer · 2018-12-16 12:00:43Z

10

Logging pattern can be configured using application.properties file

Example :

# Logging pattern for the console
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} - %msg%n

answered Dec 16, 2018 at 12:00

DV Singh

1,08811 silver badges17 bronze badges

Comments

Mark · Accepted Answer · 2023-02-21 18:01:10Z

3

The spring documentation has an example of the logback.xml that defines the default.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <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>
    <logger name="org.springframework.web" level="DEBUG"/>
</configuration>

answered Feb 21, 2023 at 18:01

Mark

2,10332 silver badges41 bronze badges

Comments

EzLo · Accepted Answer · 2019-04-26 06:34:29Z

2

You can use below pattern :

%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${sys:PID} --- [%15.15t] %-40.40logger{1.} : %m%n%wEx

edited Apr 26, 2019 at 6:34

EzLo

14.2k10 gold badges38 silver badges40 bronze badges

answered Apr 26, 2019 at 6:10

shrey

334 bronze badges

Comments

riskop · Accepted Answer · 2019-07-03 08:45:32Z

Note that you can also customize the imported properties.

But beware that at least with spring boot 1.4.3 if you want to customize the properties imported from the defaults.xml, then the customization should be placed BEFORE the include.

For example this customizes the priority to 100 character wide:

<configuration scan="true">
    <property name="LOG_LEVEL_PATTERN" value="%100p" />

    <!-- use Spring default values -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
        </layout>
    </appender>

    <logger name="hu" level="debug" additivity="false">
        <appender-ref ref="CONSOLE" />
    </logger>

    <root level="warn">
        <appender-ref ref="CONSOLE" />
    </root>

</configuration>

But this is NOT:

<configuration scan="true">
    <!-- use Spring default values -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <property name="LOG_LEVEL_PATTERN" value="%100p" />

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
        </layout>
    </appender>

    <logger name="hu" level="debug" additivity="false">
        <appender-ref ref="CONSOLE" />
    </logger>

    <root level="warn">
        <appender-ref ref="CONSOLE" />
    </root>

</configuration>

Solar Fiber · Accepted Answer · 2018-03-13 15:52:56Z

For those who'd like to use Łukasz Frankowski's answer (which looks like the cleanest solution here), but in a groovy version, the "problematic" {$PID:- } part can be expanded like in the following:

logback-spring.groovy

import ch.qos.logback.classic.PatternLayout
import ch.qos.logback.core.ConsoleAppender
import org.springframework.boot.logging.logback.ColorConverter
import org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter
import org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter

import static ch.qos.logback.classic.Level.INFO

conversionRule("clr", ColorConverter)
conversionRule("wex", WhitespaceThrowableProxyConverter)
conversionRule("wEx", ExtendedWhitespaceThrowableProxyConverter)

appender("STDOUT", ConsoleAppender) {
    layout(PatternLayout) {
        def PID = System.getProperty("PID") ?: ''
        pattern = "%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx"
    }

}
root(INFO, ["STDOUT"])

Nishan B · Accepted Answer · 2022-11-09 16:10:27Z

0

This worked for me, adding following line to resources/log4j2.properties file

appender.console.layout.pattern = %d{ISO8601} - info: %msg%n ( your custom pattern goes here )

answered Nov 9, 2022 at 16:10

Nishan B

89311 silver badges13 bronze badges

Collectives™ on Stack Overflow

Spring Boot logging pattern

11 Answers 11

5 Comments

5 Comments

1 Comment

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

11 Answers 11

5 Comments

5 Comments

1 Comment

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related