로깅과 Logback에 대해 알아보아요.

로깅

로깅이란

정보를 제공하는 일련의 기록인 로그(log)를 생성하도록 시스템을 작성하는 활동

즉, 우리 애플리케이션의 정보를 알 수 있는 기록을 남기는 것이라고 생각할 수 있습니다.

🔥 로그가 필요한 이유

어느 날 제가 몸이 아파서 팀 회의를 참가하지 못했다고 해봅시다. 몸이 괜찮아진 몰리는 전날 회의에 정해진 사항을 확인하기 위해 회의록을 학인합니다.

그런데, 우리의 서기 켬미가 그날 따라 회의록을 작성하지 못했네요. 몰리는 회의록이 없기 때문에 팀의 진행 사항이 어떻게 흘러갔는데 확인할 수 없습니다.

우리 애플리케이션이 다운되거나 문제가 발생했을 때 이를 파악할 수 있는 정보가 필요합니다.

갑자기 어느날 서버가 죽었는데 아무런 정보도 확인할 수 없다면, 백엔드 개발자들은 문제 파악을 할 수 없습니다. 문제를 해결했다고 해도, 문제가 무엇인지도 모르는 상태이니 정말 해결한 건지 확신할 수도 없구요.

따라서 효과적인 시스템 파악 및 디버깅을 위해 자세한 로깅이 필요합니다.

🤔 System.out.println 으로 콘솔에 출력해서 확인하면 되는 거 아니야?

로그는 레벨이 존재합니다. 쉽게 말하면 기록에 등급을 정할 수 있다는 것이죠.

System.out.println과 같은 출력문은 모든 메시지가 출력되지만 로그는 환경에 따라 높은 등급만 보거나, 낮은 등급까지 확인하는 등 조정할 수 있습니다. 운영 환경별 로깅 레벨 수준이 달라야 하는 이유

---

로깅 프레임워크

로깅 프레임워크는 애플리케이션에서 발생하는 로그를 생성해주는 도구입니다.

로깅 프레임워크를 통해 우리는 로그 기록(생성), 로그 레벨 관리, 로그 형식 및 출력 대상 지정 할 수 있습니다.

그전에, SLF4J (Simple Logging Facade for Java)

SLF4J에 대해 알아봅시다. SLF4J는 자바에서 다양한 로깅 프레임워크에 대한 Facade, 즉 추상화 계층을 제공하는 인터페이스입니다.

이게 뭔말이야? 저는 "JPA가 자바 ORM에 대한 명세(인터페이스)인 것처럼 SLF4J도 자바 logging system에 대한 인터페이스다" 라고 이해했습니다.

Spring Boot Starter 라이브러리를 사용하면 기본으로 ‘ spring-boot-starter-logging ‘가 포함되고 여기에 SLF4J도 포함되어 있습니다.

따라서 우리는 SLF4J의 구현체인 로그 프레임워크 중 하나를 선택하여 사용하면 됩니다.

---

Logback

Logback은 우리가 로그를 효과적으로 관리하기 위해 사용할 수 있는 로깅 프레임워크 중 하나입니다. 예상하셨듯 SLF4J의 구현체입니다. 우리 서비스에서는 Logback 을 사용해서 로깅을 했습니다.

Logback을 사용한 이유는 SLF4J과 함께 Spring Booter Start가 기본적으로 Logback을 포함하고 있기 때문입니다. 고려한 로깅 프레임워크

사용법

Logback은 xml 또는 yml 파일로 작성할 수 있습니다.

xml이 더 자세히 커스텀하고 관리하기에 좋아서 xml을 사용했습니다.

먼저 logback-spring.xml을 통해 logback을 어떻게 사용할 건지 작성해줍니다.

Logback은 Logger, Appender 그리고 Layout의 세 가지 주요 클래스를 기반으로 설정할 수 있습니다.

로깅 설정

# 예시 
<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  
  <root level="INFO">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

• Logger: 로깅을 수행 ➡️ 로그 "기록(생성)"
• Appender: 로그 이벤트의 출력 대상을 정의 ➡️ "어디에" 저장 또는 출력할 것인지
• Layout: 로그 메시지의 형식을 지정 ➡️ 로그가 "어떻게 생겼는지"