SpringBoot Part1-5

 

1. logging

 

로깅이란?

 

시스템을 작동할 때 시스템의 작동 상태의 기록과 보존, 이용자의 습성 조사 및 시스템 동작의 분석 등을 하기 위해 작동 중의 각종 정보를 기록해 둘 필요가 있다. 이 기록을 만드는 것을 로깅이라 한다.

즉, 로그 시스템의 사용에 관계된 일련의 「사건」을 시간의 경과에 따라 기록하는 것이다.

 

println()으로 로깅이 불가능한 이유

 

상황 별로 로그를 조정할 수 없고 별도로 처리하기 어렵다.

대량의 로그가 발생할 때, 큰 성능 문제를 야기시킨다. => 오버헤드 발생 가능성 존재

운영 상태에서는 절대! 쓰면 안된다.

 

Java Logging Framework

 

- java.util.logging (표준 로깅 API)

- Apache Commons logging

- Log4J

- Logback

- SLF4J(Simple Logging Facade for Java)

 

SLF4J

 

Logging Framework들을 추상화해 놓은 것

Facade Pattern을 이용한 Logging Framework이다.

 

💡 Facade Pattern

프랑스어 Façade에서 유래된 단어로 건물의 외관이라는 뜻을 가지고 있다.
건물의 외벽에서 보면 안의 구조는 보이지 않는 것처럼 많은 서브시스템(내부 구조)을 거대한 클래스(외벽)로 만들어 감싸서 편리한 인터페이스를 제공한다.

https://refactoring.guru/design-patterns/facade

 

SLF4J의 Binding 모듈

 

SLF4J는 바인딩 모듈을 통해서 다양한 로깅 프레임워크를 지원한다.

바인딩 모듈은 로깅 프레임워크를 연결하는 역할을 한다.

 

=> 로깅 라이브러리가 어떤 것이든 같은 방법으로 로그를 남길 수 있게 해 준다.

 

Log Level

 

로그 메시지의 중요도를 나타내는 기준

 

1. trace

매우 상세한 디버그 정보 

개발 중에 주로 사용되며, 시스템의 동작을 추적하고 문제를 진단하기 위한 정보를 제공한다.

 

2. debug

디버그 정보

애플리케이션의 내부 상태와 실행 흐름에 대한 정보를 기록한다.

 

3. info

정보성 메시지 제공

애플리케이션의 주요 이벤트 및 상태에 대한 정보를 기록한다.

 

4. warn

경고성 메시지를 제공

잠재적인 문제 상황을 나타내지만 심각한 오류로 간주되지는 않는 상태를 기록한다.

시스템은 계속 작동하지만 주의가 필요한 상황을 나타낸다.

 

5. error

오류 상황을 나타냄

시스템의 기능에 문제가 발생했음을 나타내며, 해당 오류에 대한 정보를 기록한다.

시스템이 오작동 상태에 있을 수 있다.

 

https://logback.qos.ch/manual/architecture.html

 

Logger

 

로깅 작업을 수행하는 데 사용되는 객체 또는 클래스

 

import org.slf4j.Logger;

class OrderTest {
    private static final Logger logger = LoggerFactory.getLogger(OrderTester.class);    
}

구현체 말고 slf4j에서 제공하는 Logger를 사용해라!

 

+)

logger.info("logger name => {} {}", logger.getName(), logger.getName());

자유롭게 placeholder를 이용해서 log를 출력할 수 있다.

---

2. logback

 

logback 설정파일 찾는 순서

 

1. logback-test.xml 파일을 먼저 찾는다

2. 없다면 logback.groovy을 찾는다.

3. 그래도 없다면 logback.xml을 찾는다.

4. 모두 없다면 기본 설정 전략을 따른다. => BasicConfiguration

 

logback.xml 형식

 

<configuration>
  <appender name = "STDOUT" class = "ch.qos.logback.core.ConsoleAppender">
  </appender>
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  <logger name="org.prgms.kdt.springorder" level="info"/>

  <root level="debug">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

 

- appender: 로그 이벤트의 출력 대상인 Appender를 정의한다.

- encode: 로그 메시지의 출력 형식을 지정한다.

- logger: 특정 로거(logger)의 로그 레벨을 설정한다.

  => 해당 패키지 내에서 발생하는 로그 이벤트 설정

- root: 최상위(root) 로거를 설정한다.

 

+) appender-ref를 통해 해당 Appender를 로거에 연결해야만 출력이 된다.

-> 위에서 지정한 appender name 사용

 

Appender 종류

 

- ConsoleAppender: 로그를 콘솔에 출력

- FileAppender: 로그를 파일에 출력

- RollingFileAppender: 로그를 롤링 파일 형식으로 출력, 일정 크기 또는 시간 단위로 파일을 분할하여 로그를 기록

 

PatternLayout

 

Logback에서 사용되는 로그 메시지의 출력 형식을 지정하는 데 사용되는 클래스

 

로그 메시지의 날짜, 시간, 로그 레벨, 로거 이름 등을 포함한 원하는 형식으로 출력할 수 있다.
<encoder> 요소 내에서 사용되며, <pattern> 요소를 통해 출력 형식을 정의한다. 

 

💡 Conversion Word

Logback의 PatternLayout에서 사용되는 특수한 문자열

%d: 날짜와 시간을 출력한다. 다양한 날짜 및 시간 형식 지정 옵션을 사용할 수 있다.
%t, %thread: 로그를 생성한 스레드의 이름을 출력한다.
%logger{length}: 일정 길이 이상의 로거 이름을 잘라내어 length만큼 출력한다.
%p, %level: 로그 레벨을 출력한다.
%c: 로거의 이름을 출력한다.
%m: 로그 메시지 자체를 출력한다.
%n: 줄 바꿈 문자를 출력한다.

자세한 건 아래 링크 참고
https://logback.qos.ch/manual/layouts.html

 

ConversionRule

 

Logback에서 로그 이벤트를 문자열로 변환하는 방법을 정의하는 구성 요소

이를 통해 사용자 정의 패턴 변환자를 등록하거나 기본 변환자를 재정의할 수 있다.

 

<conversionRule conversionWord="변환자" converterClass="변환자 클래스" />

conversionWord: 로그 패턴에서 사용할 변환자를 정의한다. 이는 % 기호 뒤에 사용되는 문자로 표시된다.

converterClass: 변환자의 구현 클래스를 지정한다. 해당 클래스는 Logback에서 제공하는 기본 변환자 중 하나일 수도 있고, 사용자가 직접 구현한 변환자일 수도 있다.

 

 

예시

<ConversionRule
        conversionWord="clr"
        converterClass="org.springframework.boot.logging.logback.ColorConverter" />

<property name="LOG_PATTERN" value="%clr(%d{HH:mm:ss.SSS}){yellow} [%thread] %clr(%-5level) %logger{36} - %msg%n"/>

Logback에서 제공하는 ColorConverter를 사용하여 로그 메시지에 색상을 적용했다.

%conversionWord() 형식을 통해 로그 이벤트의 출력 패턴에 변환자를 적용하고 있다.

---

3. SpringBoot

 

SpringBoot Application의 의존성

 

 

👆 spring-boot-starter

Spring Boot 애플리케이션을 개발하기 위한 기본 의존성을 제공한다.
Spring MVC, Spring Data JPA, Spring Security, Thymeleaf 등과 같은 주요 기술들의 의존성을 자동으로 추가해 준다.
애플리케이션 개발에 필요한 기본적인 설정과 빈(Bean) 설정 등이 자동으로 처리된다.

 

👆 spring-boot-starter-test:

Spring Boot 애플리케이션의 테스트를 위한 의존성을 제공한다.
JUnit, Mockito, AssertJ 등과 같은 테스트 관련 라이브러리들의 의존성을 자동으로 추가해 준다.
Spring Boot 테스트 기능을 사용하여 단위 테스트, 통합 테스트, 슬라이스 테스트 등을 간편하게 작성할 수 있다.
테스트 실행 환경 설정과 테스트 유틸리티 클래스 등이 포함되어 있다.

 

 

 

Reference

네이버 지식백과 - 로깅