로그 레벨 및 로그 작성 기준

운영중인 솔루션에서 문제가 발생해 원인을 파악하려는데, 에러를 제외한 debug나 info 로그가 하나도 찍히지 않아 원인을 파악할 수 없는 일이 발생하였다. 그래서 이번에 로그 찍는 소스를 추가해 패치를 하게 되었는데 어떻게 로그를 찍어야 운영할 때 상태를 잘 모니터링 할 수 있을지 고민하게 되었고, 이번 글을 작성하게 되었다.

---

📖 로그(Log)의 목적

로그는 시스템이나 애플리케이션에서 발생하는 모든 이벤트의 기록으로, 개발자와 운영 팀이 시스템의 성능을 분석하고 문제를 해결하는 데 중요한 정보를 제공한다.

• 서비스 동작 상태 파악
• 장애 파악 및 알림
• 로그 분석을 통한 서비스 지표의 확인, 트랜잭션, 성능 파악

하지만 대규모 시스템에서는 매일 수십 GB에 달하는 로그 데이터가 생성될 수 있어 이를 효율적으로 관리하지 않으면 중요한 정보를 놓치거나 문제 해결에 필요한 시간이 길어질 수 있다.

따라서 로그를 생성할 때에는 꼭 필요한 로그인지 확인하고, 시스템 상태 파악을 위해 놓치는 부분은 없는지 생각해가며 생성해야 한다.

 

📖 로그 레벨(Log Level)

로그 레벨은 로그 메시지의 중요도를 나타내는 수준으로 ALL에서 OFF를 포함하여 8개의 레벨이 있다. 하지만 보통은 ALL, OFF를 제외한 6단계를 이야기 한다.

• TRACE
  • 가장 상세한 로그 레벨로, 애플리케이션의 실행 흐름과 디버깅 정보를 상세히 기록한다. 주로 디버깅 시 사용한다.
• DEBUG
  • 디버깅 목적으로 사용되며, 개발 단계에서 상세한 정보를 기록한다.
  • 애플리케이션의 내부 동작을 이해하고 문제를 분석하는 데 도움을 준다.
• INFO
  • 정보성 메시지를 기록한다.
  • 애플리케이션의 주요 이벤트나 실행 상태에 대한 정보를 전달한다.
• WARN
  • 경고성 메시지를 기록한다.
  • 예상치 못한 문제나 잠재적인 오류 상황을 알리는 메시지이다.
  • 애플리케이션이 정상적으로 동작하지만 주의가 필요한 상황을 알려준다.
• ERROR
  • 오류 메시지를 기록한다.
  • 심각한 문제 또는 예외 상황을 나타내며, 애플리케이션의 정상적인 동작에 영향을 미칠 수 있는 문제를 알린다.
• FETAL
  • 가장 심각한 오류 메시지를 기록한다.
  • 애플리케이션의 동작을 중단시킬 수 있는 치명적인 오류를 나타낸다.
  • 일반적으로 이러한 오류는 복구가 불가능하거나 매우 어려운 상황을 의미한다.

 

🔎 MVC 패턴에서의 로그 적용

위에서 각 로그 레벨에 대해 알아보았는데, 실제로는 어떻게 적용해야 하는지 와닿지 않았다. 따라서 현재 운영 서버에 적용된 디자인 패턴인 MVC 패턴에서 각 계층별로 어떻게 로그를 적용하는 것이 좋을지 알아보았다.

 

1. Controller 계층

• INFO: 각 요청의 시작과 끝에 대한 로그를 기록하는 것이 유용함
• WARN: 입력 값이 예상 범위를 벗어났을 때 혹은 권한이 부족한 경우
• ERROR: 실제 오류가 발생했을 때

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/users")
public class UserController {
    private static final Logger logger = LogManager.getLogger(UserController.class);
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable Long id) {
        logger.info("User request received for ID: {}", id);
        try {
            User user = userService.getUserById(id);
            logger.info("User retrieved successfully for ID: {}", id);
            return ResponseEntity.ok(user);
        } catch (UserNotFoundException e) {
            logger.warn("User not found for ID: {}", id);
            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
        } catch (Exception e) {
            logger.error("An error occurred while retrieving user for ID: {}. Error: {}", id, e.getMessage());
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
        }
    }
}

 

2. Service 계층

• DEBUG: 특정 조건을 만족했을 때 분기되는 로직이나 복잡한 연산을 수행할 때 중간 결과 기록
• INFO: 비즈니스 프로세스 완료시(ex. 회원가입 완료, 주문 생성 완료 등)
• WARN: 잠재적 문제 상황
• ERROR: 예외 발생시

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.stereotype.Service;

@Service
public class UserService {
    private static final Logger logger = LogManager.getLogger(UserService.class);
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public User getUserById(Long id) throws UserNotFoundException {
        logger.debug("Looking up user with ID: {}", id);
        User user = userRepository.findById(id).orElseThrow(() -> {
            logger.warn("User with ID {} not found in the database.", id);
            return new UserNotFoundException("User not found");
        });
        logger.info("User found: {}", user.getUsername());
        return user;
    }
}

 

3. Repository 계층

• TRACE: 데이터베이스 쿼리와 관련된 상세 정보 기록할 때
• DEBUG: 쿼리 실행 결과 혹은 데이터베이스와의 상호작용 기록
• ERROR: 데이터베이스와의 상호작용에서 실제 에러가 발생한 경우

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

public class UserRepositoryImpl {
    private static final Logger logger = LogManager.getLogger(UserRepositoryImpl.class);

    public User findUserById(Long id) {
        try {
            logger.trace("Executing SQL query to find user with ID: {}", id);
            User user = findById(id); // Assume findById is implemented to get User from DB
            logger.debug("User data retrieved from database: {}", user);
            return user;
        } catch (Exception e) {
            logger.error("Database error while fetching user with ID: {}. Error: {}", id, e.getMessage());
            throw e;
        }
    }
}

 

📖 참고자료

https://velog.io/@ykh9759/%EB%A1%9C%EA%B7%B8-%EB%A0%88%EB%B2%A8Logging-Level

로그 레벨(Logging Level)

https://developsd.tistory.com/132

Log 로그는 왜 사용하는 것인가? 로그 레벨 정리

https://chatgpt.com/