Spring Boot에 로그인

1. 개요

이 짧은 튜토리얼에서는 Spring Boot에서 사용할 수있는 주요 로깅 옵션을 살펴볼 것입니다.

Logback에 대한 자세한 정보는 A Guide to Logback에서 확인할 수 있으며 Log4j2는 Log4j2 소개 – Appenders, Layouts 및 Filters에 소개되어 있습니다.

2. 초기 설정

먼저 Spring Boot 모듈을 만들어 보겠습니다. 권장하는 방법은 Spring Boot Tutorial에서 다루는 Spring Initializr를 사용하는 것입니다.

이제 유일한 클래스 파일 인 LoggingController를 만들어 보겠습니다 .

@RestController public class LoggingController { Logger logger = LoggerFactory.getLogger(LoggingController.class); @RequestMapping("/") public String index() { logger.trace("A TRACE Message"); logger.debug("A DEBUG Message"); logger.info("An INFO Message"); logger.warn("A WARN Message"); logger.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } } 

웹 애플리케이션을로드하면 // localhost : 8080 /을 방문하여 로깅 라인을 트리거 할 수 있습니다 .

3. 제로 구성 로깅

Spring Boot는 매우 유용한 프레임 워크입니다. 이를 통해 대부분의 구성 설정을 잊어 버릴 수 있으며 대부분은 자동 조정됩니다.

로깅의 경우 유일한 필수 종속성은 Apache Commons Logging입니다.

Spring 5 (Spring Boot 2.x)에서 Spring Framework의 spring-jcl 모듈에서 제공하기 때문에 Spring 4.x (Spring Boot 1.x)를 사용할 때만 가져 오면 됩니다.

Spring Boot Starter (거의 항상 그렇습니다) 를 사용하는 경우 spring-jcl가져 오는 것에 대해 전혀 걱정할 필요가 없습니다 . 모든 스타터, 우리처럼 때문이다 스프링 부팅 스타터 웹 에 따라 달라 스프링 부팅 스타터 로깅, 이미 끌어 스프링 JCL 우리를 위해.

3.1. 기본 로그 백 로깅

스타터를 사용할 때 Logback은 기본적으로 로깅에 사용됩니다.

Spring Boot는 표준 출력을 더 읽기 쉽게 만들기 위해 패턴과 ANSI 색상으로 미리 구성합니다.

이제 애플리케이션을 실행하고 // localhost : 8080 / 페이지를 방문 하여 콘솔에서 어떤 일이 발생하는지 살펴 보겠습니다 .

보시다시피 Logger의 기본 로깅 수준은 INFO로 사전 설정되어 있습니다. 즉, TRACEDEBUG 메시지가 표시되지 않습니다.

구성을 변경하지 않고 활성화 하려면 명령 줄에 –debug 또는 –trace 인수를 전달할 수 있습니다 .

java -jar target/spring-boot-logging-0.0.1-SNAPSHOT.jar --trace 

3.2. 로그 수준

또한 Spring Boot는 환경 변수를 통해보다 세분화 된 로그 수준 설정에 대한 액세스를 제공합니다. 이를 달성 할 수있는 몇 가지 방법이 있습니다.

먼저 VM 옵션에서 로깅 수준을 설정할 수 있습니다.

-Dlogging.level.org.springframework=TRACE -Dlogging.level.com.baeldung=TRACE

또는 Maven을 사용 하는 경우 명령 줄을 통해 로그 설정을 정의 할 수 있습니다 .

mvn spring-boot:run -Dspring-boot.run.arguments=--logging.level.org.springframework=TRACE,--logging.level.com.baeldung=TRACE

Gradle로 작업 할 때 명령 줄을 통해 로그 설정을 전달할 수 있습니다. 이를 위해서는 bootRun 작업을 설정해야합니다 .

완료되면 애플리케이션을 실행합니다.

./gradlew bootRun -Pargs=--logging.level.org.springframework=TRACE,--logging.level.com.baeldung=TRACE

상세도를 영구적으로 변경하려면 여기에 설명 된대로 application.properties 파일 에서 변경할 수 있습니다.

logging.level.root=WARN logging.level.com.baeldung=TRACE 

마지막으로 로깅 프레임 워크 구성 파일을 사용하여 로깅 수준을 영구적으로 변경할있습니다.

Spring Boot Starter는 기본적으로 Logback을 사용한다고 언급했습니다. 두 개의 개별 패키지에 대한 수준을 설정하는 Logback 구성 파일의 일부를 정의하는 방법을 살펴 보겠습니다.

기억 패키지의 로그 수준이 여러 번 정의 된 경우 위에서 언급 한 여러 가지 옵션을 사용하여,하지만 다른 로그 수준, 가장 낮은 수준이 사용됩니다.

따라서 Logback, Spring Boot 및 환경 변수를 동시에 사용하여 로깅 수준을 설정 하면 요청 된 수준 중 가장 낮은 수준이므로 로그 수준은 TRACE 가됩니다.

4. 로그 백 구성 로깅

기본 구성이 유용하더라도 (예 : POC 또는 빠른 실험 중에 제로 시간에 시작하기 위해) 일상적인 요구 사항에 충분하지 않을 가능성이 큽니다.

콘솔파일 출력에 대한 별도의 사양 , 대용량 로그 파일 생성을 방지하기 위해 적절한 롤링 정책 을 사용하여 다른 색상 및 로깅 패턴을 사용 하여 Logback 구성을 포함하는 방법을 살펴 보겠습니다 .

먼저 다른 많은 애플리케이션 설정에 일반적으로 사용되는 application.properties 를 오염시키는 대신 로깅 설정 만 처리 할 수있는 솔루션을 찾아야합니다 .

클래스 경로의 파일에 다음 이름 중 하나가 있으면 Spring Boot는 기본 구성을 통해 파일 을 자동으로로드 합니다.

  • logback-spring.xml
  • logback.xml
  • logback-spring.groovy
  • logback.groovy

Spring recommends using the -spring variant over the plain ones whenever possible, as described here.

Let's write a simple logback-spring.xml:

      %black(%d{ISO8601}) %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable     ${LOGS}/spring-boot-logger.log  %d %p %C{1.} [%t] %m%n    ${LOGS}/archived/spring-boot-logger-%d{yyyy-MM-dd}.%i.log   10MB               

And when we run the application, here's the output:

As we can see, it now logs TRACE and DEBUG messages, and the overall console pattern is both textually and chromatically different than before.

It also now logs on a file in a /logs folder created under the current path and archives it through a rolling policy.

5. Log4j2 Configuration Logging

While Apache Commons Logging is at the core, and Logback is the reference implementation provided, all the routings to the other logging libraries are already included to make it easy to switch to them.

In order to use any logging library other than Logback, though, we need to exclude it from our dependencies.

For every starter like this one (it's the only one in our example, but we could have many of them):

 org.springframework.boot spring-boot-starter-web  

we need to turn it into a skinny version, and (only once) add our alternative library, here through a starter itself:

 org.springframework.boot spring-boot-starter-web   org.springframework.boot spring-boot-starter-logging     org.springframework.boot spring-boot-starter-log4j2  

At this point, we need to place in the classpath a file named one of the following:

  • log4j2-spring.xml
  • log4j2.xml

We'll print through Log4j2 (over SLF4J) without further modifications.

Let's write a simple log4j2-spring.xml:

        %d %p %C{1.} [%t] %m%n                    

And when we run the application, here's the output:

As we can see, the output is quite different from the Logback one — a proof that we're fully using Log4j2 now.

In addition to the XML configuration, Log4j2 allows us to use also a YAML or JSON configuration, described here.

6. Log4j2 Without SLF4J

We can also use Log4j2 natively, without passing through SLF4J.

In order to do that, we simply use the native classes:

import org.apache.logging.log4j.Logger; import org.apache.logging.log4j.LogManager; // [...] Logger logger = LogManager.getLogger(LoggingController.class); 

We don't need to perform any other modification to the standard Log4j2 Spring Boot configuration.

We can now exploit the brand-new features of Log4j2 without getting stuck with the old SLF4J interface. But we're also tied to this implementation, and we'll need to rewrite our code when switching to another logging framework.

7. Logging With Lombok

In the examples we've seen so far, we've had to declare an instance of a logger from our logging framework.

This boilerplate code can be annoying. We can avoid it using various annotations introduced by Lombok.

We'll first need to add the Lombok dependency in our build script to work with it:

 org.projectlombok lombok 1.18.4 provided 

7.1. @Slf4j and @CommonsLog

SLF4J and Apache Commons Logging APIs allow us the flexibility to change our logging framework with no impact on our code.

And we can use Lombok's @Slf4j and @CommonsLog annotations to add the right logger instance into our class: org.slf4j.Logger for SLF4J and org.apache.commons.logging.Log for Apache Commons Logging.

To see these annotations in action, let's create a class similar to LoggingController but without a logger instance. We name it as LombokLoggingController and annotate it with @Slf4j:

@RestController @Slf4j public class LombokLoggingController { @RequestMapping("/lombok") public String index() { log.trace("A TRACE Message"); log.debug("A DEBUG Message"); log.info("An INFO Message"); log.warn("A WARN Message"); log.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } }

Note that we've adjusted the snippet just a bit, using log as our logger instance. This is because adding the annotation @Slf4j automatically adds a field named log.

With Zero-Configuration Logging, the application will use underlying logging implementation Logback for logging. Similarly, Log4j2 implementation is used for logging with Log4j2-Configuration Logging.

We get the same behavior when we replace the annotation @Slf4j with @CommonsLog.

7.2. @Log4j2

We can use the annotation @Log4j2 to use Log4j2 directly. So, we make a simple change to LombokLoggingController to use @Log4j2 instead of @Slf4j or @CommonsLog:

@RestController @Log4j2 public class LombokLoggingController { @RequestMapping("/lombok") public String index() { log.trace("A TRACE Message"); log.debug("A DEBUG Message"); log.info("An INFO Message"); log.warn("A WARN Message"); log.error("An ERROR Message"); return "Howdy! Check out the Logs to see the output..."; } } 

Other than logging, there are other annotations from Lombok that help in keeping our code clean and tidy. More information about them is available in Introduction to Project Lombok, and we also have a tutorial on Setting Up Lombok With Eclipse and IntelliJ.

8. Beware of Java Util Logging

Spring Boot also supports JDK logging, through the logging.properties configuration file.

There are cases when it's not a good idea to use it, though. From the documentation:

There are known classloading issues with Java Util Logging that cause problems when running from an ‘executable jar'. We recommend that you avoid it when running from an ‘executable jar' if at all possible.

It's also a good practice when using Spring 4 to manually exclude commons-logging in pom.xml, to avoid potential clashes between the logging libraries. Spring 5 instead handles it automatically, so we don't need to do anything when using Spring Boot 2.

9. JANSI on Windows

While Unix-based operating systems such as Linux and Mac OS X support ANSI color codes by default, on a Windows console, everything will be sadly monochromatic.

Windows can obtain ANSI colors through a library called JANSI.

We should pay attention to the possible class loading drawbacks, though.

We must import and explicitly activate it in the configuration as follows:

Logback:

  true  [%thread] %highlight(%-5level) %cyan(%logger{15}) - %msg %n     

Log4j2:

ANSI escape sequences are supported natively on many platforms but are not by default on Windows. To enable ANSI support, add the Jansi jar to our application and set property log4j.skipJansi to false. This allows Log4j to use Jansi to add ANSI escape codes when writing to the console.

Note: Prior to Log4j 2.10, Jansi was enabled by default. The fact that Jansi requires native code means that Jansi can only be loaded by a single class loader. For web applications, this means the Jansi jar has to be in the web container's classpath. To avoid causing problems for web applications, Log4j no longer automatically tries to load Jansi without explicit configuration from Log4j 2.10 onward.

It's also worth noting:

  • The layout documentation page contains useful Log4j2 JANSI informations in the highlight{pattern}{style} section.
  • While JANSI can color the output, Spring Boot's Banner (native or customized through the banner.txt file) will stay monochromatic.

10. Conclusion

우리는 Spring Boot 프로젝트 내에서 주요 로깅 프레임 워크와 인터페이스하는 주요 방법을 보았습니다.

또한 각 솔루션의 주요 장점과 함정을 살펴 보았습니다.

항상 그렇듯이 전체 소스 코드는 GitHub에서 사용할 수 있습니다.