✏️ BE LOGGING

로그 전략

ERROR → RuntimeException 예상치 못한 서버 에러를 handler 함수 실행 전 기록한다

WARN → BanggoodException, MethodArgumenthotValidException, OauthException 등 사용자 입력 에러를 포함한 서버에서 코드상으로 예외 처리를 한 에러를 handler 함수 실행 전 기록한다

INFO → Service 클래스 안 Public 메서드 작업 완료 시점, 즉 함수가 끝나는 시점에 기록한다

⇒ 가장 보편적인 로그 전략을 수립하였다 추후 추가하거나 필요 없는 로그가 있을 경우 변경한다

---

로그 템플릿

BASE

• 요청 시간(timestamp)
• 로그 식별자 (UUID)
• 요청 URL (type 포함)

public abstract class BaseLog {

    private final LocalDateTime requestTime;
    private final String requestUrl;
    private final String uuid;

ERROR

• 에러 메시지
• stackTrace

public class ErrorLog extends BaseLog {

    private final String errorMessage;
    private final String stackTrace;

WARN

• 경고 메시지

public class WarnLog extends BaseLog {

    private final String warnMessage;

INFO

• 호출 메서드 이름

public class InfoLog extends BaseLog {

    private final String infoMethodName;

---

로그 구축

로그의 기능과 서비스의 기능을 구분하기 위해 스프링 AOP를 도입하였다.

AOP의 경우, 관심사 중심의 프로그래밍을 뜻한다. 즉, 비즈니스 로직과 외의 관심사를 구분할 수 있다.

• Logback.xml

  <?xml version="1.0" encoding="UTF-8"?> 
  <configuration> // 설정 파일과 관련된 구문이다
      <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
      // defaults.xml 파일은 일반적으로 기본 레벨의 로거 설정, 패턴 레이아웃, 로거의 전역 수준 등을 포함한다
      <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
  		//  콘솔에 로그를 출력하기 위한 Appender 구성을 포함한다
      <appender name="INFO" class="ch.qos.logback.core.ConsoleAppender">
      // appender란 로그 메시지를 실제로 출력할 대상(예: 콘솔, 파일, 원격 서버 등)을 지정하는 객체이다
      // 콘솔로 로그 메시지를 출력하는 역할을 하는 클래스
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
          // 특정 로그 레벨에 따라 로그 메시지를 필터링하는 기능을 제공하는 클래스
              <level>INFO</level> // 필터링할 대상 로그 레벨을 지정
              <onMatch>ACCEPT</onMatch> // 일치할 경우 해야 되는 걸 지정
              <onMismatch>DENY</onMismatch> // 일치하지 않을 경우 해야 되는 걸 지정
          </filter>
          <encoder>
              <pattern>%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5level){BLUE} [%thread] %logger{36} - %msg%n</pattern>
              // %d{yyyy-MM-dd HH:mm:ss}: 로그가 기록된 날짜와 시간
  						//  %highlight(%-5level){BLUE}: 로그의 레벨(INFO, WARN, ERROR 등) 로그 메시지의 특정 부분을 색상으로 강조	
  						// [%thread]: 로그를 출력한 스레드 이름.
  						// %logger{36}: 로거 이름을 최대 36글자까지 표시.
  						// %msg%n: 로그 메시지와 개행 문자.
          </encoder>
      </appender>
  
      <appender name="WARN" class="ch.qos.logback.core.ConsoleAppender">
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
              <level>WARN</level>
              <onMatch>ACCEPT</onMatch>
              <onMismatch>DENY</onMismatch>
          </filter>
          <encoder>
              <pattern>%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5level){YELLOW} [%thread] %logger{36} - %msg%n</pattern>
          </encoder>
      </appender>
  
      <appender name="ERROR" class="ch.qos.logback.core.ConsoleAppender">
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
              <level>ERROR</level>
              <onMatch>ACCEPT</onMatch>
              <onMismatch>DENY</onMismatch>
          </filter>
          <encoder>
              <pattern>%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5level){RED} [%thread] %logger{36} - %msg%n</pattern>
          </encoder>
      </appender>
  
      <root level="INFO"> // 최상위 로거는 모든 로거의 기본 설정을 정의 최상위 로거가 있는 게 권장되는 방식
          <appender-ref ref="INFO"/> // 특정 Appender를 참조하는 부분 
          <appender-ref ref="WARN"/>
          <appender-ref ref="ERROR"/>
      </root>
  </configuration>

• AOP로 기록

  Spring에서 AOP는 프록시 방식으로 동작한다. (프록시는 타겟을 감싸서 타겟의 요청을 대신 받아주는 Wrapping 오브젝트이다)

  @Aspect
  @Component
  public class LoggingAspect {
  
      private static final Logger log = LoggerFactory.getLogger(LoggingAspect.class);
  
      @AfterReturning("execution(public * com.bang_ggood..*Service.*(..)))")
      // Service 이름이 붙은 모든 클래스의 public 메서드가 실행된 후
      public void loggingInfo(JoinPoint joinPoint) {
      // joinPoint는 해당 함수를 일컫는 말
          if (RequestContextHolder.getRequestAttributes() instanceof ServletRequestAttributes) {
          // 리퀘스트 있는 맥락에 한해서만 로깅 (Service 레이어 테스트에서는 작동 X)
              HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
              // 해당 request 정보를 갖고 옴
              String methodName = joinPoint.getSignature().getName();
              // 메서드 이름을 갖고 옴
              log.info(InfoLog.of(request, methodName).toString()); //info 레벨 로깅
          }
      }
  
      @Before("execution(* com.bang_ggood.handler.GlobalExceptionHandler.*(..)) &&"
              + "!execution(* com.bang_ggood.handler.GlobalExceptionHandler.handleRuntimeException(..)))")
     // handleRuntimeException 함수를 제외하고
     // GlobalExceptionHandler의 모든 함수가 작동하기 전 실행한다
      public void loggingWarn(JoinPoint joinPoint) {
          Optional<Exception> exceptionOptional = Arrays.stream(joinPoint.getArgs())
                  .filter(arg -> arg instanceof Exception)
                  .map(arg -> (Exception) arg)
                  .findFirst();
                  // GlobalExceptionHandler 함수의 파라미터로 exception을 받기 때문에 그걸 갖고 올 수 있다
  
          if (exceptionOptional.isPresent() && RequestContextHolder.getRequestAttributes() != null) {
              // exception이 있고 request가 있는 경우에만
              Exception exception = exceptionOptional.get();
              HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  
              log.warn(WarnLog.of(exception, request).toString());
          }
      }
  
      @Before("execution(* com.bang_ggood.handler.GlobalExceptionHandler.handleRuntimeException(..)))")
      // handleRuntimeException 함수가 작동하기 전 실행한다
      public void loggingError(JoinPoint joinPoint) {
          Optional<Exception> exceptionOptional = Arrays.stream(joinPoint.getArgs())
                  .filter(arg -> arg instanceof Exception)
                  .map(arg -> (Exception) arg)
                  .findFirst();
  
          if (exceptionOptional.isPresent() && RequestContextHolder.getRequestAttributes() != null) {
              Exception exception = exceptionOptional.get();
              HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  
              log.error(ErrorLog.of(exception, request).toString());
          }
      }
  }