Logging기능

• 운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고,
• 별도의 로깅 라이브러리를 사용해서 로그를 출력한다

 

1. Logging라이브러리

---

•  
• 스프링 부트 라이브러리를 사용하면  spring-boot-starter-logging가 포함
• 스프링 부트 로깅 라이브러리는 라이브러리를 사용
  인터페이스 : SLF4J - http://www.slf4j.org
  구현체 : Logback - http://logback.qos.ch

 

 

2. 사용 예시

---

• @RestController의 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력
• @Controller의 반환 값이 String 이면 뷰 이름으로 인식. --> String으로 뷰 찾고 랜더링
• Logger는 slf4j사용

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
//@Controller는 반환되는 String은 view이름을 나타냄.
@RestController //RestController는 String반환 시 STring이 그대로 반환됨.
public class LogTestController {

    private final Logger log = LoggerFactory.getLogger(LogTestController.class); //getClass()현재 클래스 지정.

    @GetMapping("/log-test")
    public String logTest(){
        String name = "spring";
        log.trace("trace log={}", name); // f
        log.debug("debug log={}", name);
        log.info("info log={}", name);
        log.warn("warn log={}", name);
        log.error("error log={}", name);

        return "ok";
    }
}

• log는 다음과 같이 남는다.
  

  

• 로그 포멧
  • 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지

 

 

 

3. Log Level

---

• 로그 레벨 설정을 변경해서 출력 결과를 보자.
  
  • LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
  • 개발 서버는 debug 출력
  • 운영 서버는 info 출력
  • 모든 log를 보고싶은 경우 레벨 설정법
    • application.properties
    • logging.level.hello.springmvc=trace
      

      

  • 즉, level을 지정하여 원하는 level만 log를 남길 수 있음. ㅋㅋㅋ
  • 기본이 info임 ㅋㅋㅋㅋ

    • #전체 로그 레벨 설정(기본 info)
      logging.level.root=info
      
      #hello.springmvc 패키지와 그 하위 로그 레벨 설정
      logging.level.hello.springmvc=debug

 

 

 

4. @Slf4j

---

@Slf4j 로 변경

• 매 번 Logger생성하기 귀찮음....
• Lombok이 제공하는 @Slf4j 사용

@Slf4j
@RestController //RestController는 String반환 시 STring이 그대로 반환됨.
public class LogTestController {

   // private final Logger log = LoggerFactory.getLogger(LogTestController.class); //getClass()현재 클래스 지정.

    @GetMapping("/log-test")
    public String logTest(){
        String name = "spring";
        log.trace("trace log={}", name); // f
        log.debug("debug log={}", name);
        log.info("info log={}", name);
        log.warn("warn log={}", name);
        log.error("error log={}", name);

        return "ok";
    }
}

 

 

 

5. 올바른 log 사용법

---

• log.debug("data="+data)
  
  • 로그 출력 레벨을 info로 설정해도 해당 코드에 있는 "data="+data가 실제 실행이 되어 버린다.
  • 결과적으로 문자 더하기 연산이 발생한다.
  • 메모리, cpu 사용함. 필요없는 resource사용 가능성 있음.
  • log level : info 설정한 경우,
    • log.trace("trace  log = " + name)은 "trace log" + name 문자열을 더하는 연산이 일어남.
    • 하지만 trace level은 로그 남기지도 않음. 남기질 않을 log에 대해 resource사용함.. ㅜ
• log.debug("data={}", data)
  
  • 로그 출력 레벨을 info로 설정하면 아무일도 발생하지 않는다. 
  • 따라서 앞과 같은 의미없는 연산이 발생하지 않는다.
  • log level : info 설정한 경우
    • log.trace("trace log = {}", name)은 파라미터를 넘김.
    • level 이 info이기 때문에 trace level은 남길 필요가 없다.
    • 따라서 해당 method가 실행되지 않음
    • 불필요한 resource낭비 줄임.

 

 

6. log 사용 시 장점

---

• Thread 정보, Class 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있음.
• Log level에 따라 개발 서버에서는 모든 로그를 출력하고, 
• 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
• 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.
• 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
• 성능도 일반 System.out보다 좋음 ~~(내부 버퍼링, 멀티 쓰레드 등등) 
• 그래서 실무에서는 꼭 로그를 사용해야 한다..

 

 

7.  GitHub : 210913 Logging

---

GitHub - bsh6463/MVC2