효과적인 로그 작성 가이드

✅ 트러블 슈팅에 도움이 되는 로그 작성

• 트러블 슈팅에 필요한 정보를 포함하는 로그를 남긴다.
  • 단, 법적으로 필요한 로그는 반드시 남겨야 한다.
• 서비스의 특성에 따라 어떤 로그를 남길지 판단해야 한다.

🛠 로그를 남길 때 @Slf4j 사용 권장

@Slf4j
public class ExampleService {
    public void exampleMethod(String param1) {
        log.info("test {}", param1); // 올바른 로그 사용 예제
    }
}

• 가독성 및 유지보수성이 좋다.
• 문자열 연결(+)보다 성능상 유리하다.

📝 어떤 로그를 남기는 것이 좋은가?

❌ 좋지 않은 예제

log.info("createParamUrl");

• 어떤 요청이 실행되었는지는 알 수 있지만, 입력된 정보나 실패 원인을 분석하기 어렵다.

✅ 좋은 예제

log.info("createParamUrl {}", dto.param);

• 사용자가 입력한 정보가 포함되어 있어 원인 분석이 용이하다.