[MSA] Spring Cloud로 개발하는 마이크로서비스 애플리케이션(MSA) - 분산 추적(Zipkin)

 

 

💡 Zipkin
홈페이지 링크
분산 추적을 하기 위해서 추적 정보 즉 트레이싱 정보를 저장하기 위한 서비스가 Zipkin이다.

- Twitter에서 사용하는 분산 환경의 Timing 데이터 수집, 추적 시스템 (오픈소스)
- Google Drapper에서 발전하였으며, 분산 환경에서의 시스템 병목 현상 파악
- collerctor, Query Service, databaem WebUI로 구성

Span
- 하나의 요청에 사용되는 작업 단위
- 64 bit unique ID

Trace
- 트리 구조로 이루어진 Span set
- 하나의 요청에 대한 같은 Trace ID 발급

 

 

💡 Spring Cloud Sleuth
홈페이지 링크
마이크로 서비스가 여녈되어 있는 상태 값을 추적해서 누가 누구를 호출했고 시간이 얼마나 걸렸으면 정상 상태인지 비정상 상태인지를 알려주고 시각화 시켜주는 도구

- 스프링 부트 애플리케이션을 Zipkin과 연동
- 요청 값에 따른 Trace ID, Span ID 부여
- Trace와 Span IDs를 로그에 추가 가능
    - servlet filter
    - rest template
    - scheduled actions
    - message channels
    - feign client

 

Zipkin은 마이크로 서비스 간의 순차적인 데이터 호출관계에 대해 데이터 이력을 보관(트레이싱)하고
Sluth라이브러리는 스프링 부트에서 발생했던 로그 데이터 값을 직행 서버로 전달시켜주는 역할

 

 

 

---

 

 

Zipkin 설치

• Zipkin 설치

Zipkin 설치방법 링크

curl -sSL https://zipkin.io/quickstart.sh | bash -s

 

zipkin.jar 파일이 설치되었다.

 

• 파일 실행

 java -jar zipkin.jar

 

• 포트번호 9411로 들어가 보자.

 

---

 

 

Spring Cloud Sleuth + Zipkin을 이용한 Microservice의 분산 추적

User Service

• pom.xml

<!-- zipkin -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
            <version>2.2.3.RELEASE</version>
        </dependency>

 

• application.yml

spring:
  application:
    name: user-service
  zipkin:
    base-url: http://localhost:9411
    enabled: true #zipkin 서버 작동 O
  sleuth:
    sampler:
      probability: 1.0 # 발생한 로그를 100%보여주겠다.

 

• UserServiceImpl

circuitBreaker 작성한 곳에 log 추가(@Slf4j 사용)

@Override
public UserDto getUserByUserId(String userId) {
    UserEntity userEntity = userRepository.findAllByUserId(userId);

    if (userEntity == null)
        throw new UsernameNotFoundException("User not found");

    UserDto userDto = new ModelMapper().map(userEntity, UserDto.class); // (바꾸고 싶은 변수, 바꾸고 싶은 "클래스")

// 	...생략...

/* ErrorDecoder */
        log.info("Before call orders microservice"); 👀 여기! log 추가!!
        CircuitBreaker circuitbreaker = circuitBreakerFactory.create("circuitbreaker"); // circuitbreaker 생성
        List<ResponseOrder> orderList = circuitbreaker.run(() -> orderServiceClient.getOrder(userId), throwable -> new ArrayList<>()); // circuitbreaker 실행
        // run(() -> 정상작동할 경우 반환값, 문제 생겼을 경우 반환값)
        log.info("After call orders microservice"); 👀 여기! log 추가!!
        userDto.setOrders(orderList);

        return userDto;
    }

 

 

 

Order Service

User Service 와 비슷하게 세팅해준다.

• pom.xml

<!-- zipkin -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
            <version>2.2.3.RELEASE</version>
        </dependency>

 

• application.yml

spring:
  application:
    name: user-service
  zipkin:
    base-url: http://localhost:9411
    enabled: true #zipkin 서버 작동 O
  sleuth:
    sampler:
      probability: 1.0 # 발생한 로그를 100%보여주겠다.

 

• OrderServiceImpl

log 추가(@Slf4j 사용)

@PostMapping("/{userId}/orders")
public ResponseEntity<ResponseOrder> createOrder(@PathVariable("userId") String userId, @RequestBody RequestOrder orderDetails) {
    log.info("Before add orders data"); 👀 여기! log 추가!!

    ModelMapper mapper = new ModelMapper();
    mapper.getConfiguration().setMatchingStrategy(MatchingStrategies.STRICT);


    OrderDto orderDto = mapper.map(orderDetails, OrderDto.class);
    orderDto.setUserId(userId);
    /* jpa */
    OrderDto createdOrder = orderService.createOrder(orderDto);
    ResponseOrder responseOrder = mapper.map(createdOrder, ResponseOrder.class);
    
    log.info("After add orders data"); 👀 여기! log 추가!!
    return ResponseEntity.status(HttpStatus.CREATED).body(responseOrder);
    }

 

 

 

---

 

 

 

Test 1

PostMan에서 회원가입과 로그인 후 회원정보 조회 실행

 

 

회원정보를 조회하는 하나의 요청이므로 하나의 trace ID이다.

동일한 trace ID와 다른 span ID인 것을 확인할 수 있다.

 

Zipkin server에서 확인해보자(port : 9411)

검색방법 ①

trace ID를 검색해서 정보를 확인할 수 있다.

 

 

Zipkin은 마이크로 서비스 간의 순차적인 데이터 호출관계에 대해 데이터 이력을 보관(트레이싱)하고
Sluth라이브러리는 스프링 부트에서 발생했던 로그 데이터 값을 직행 서버로 전달시켜주는 역할

 

 

검색방법 ②

ServiceName으로도 검색할 수 있다.

 

 

검색방법 ③

Dependencies를 볼 수 있다. 날짜별로 호출정보를 시각화해서 보여준다.

에러여부가 있었는지도 확인 가능한 대쉬보드이다.

 

 

 

 

Test 2 오류 가정

강제로 오류 발생했을 때를 가정해보자!

Order Serivce

• OrderController

@SneakyThrows
@GetMapping("/{userId}/orders")
public ResponseEntity<List<ResponseOrder>> getOrder(@PathVariable("userId") String userId) {
    log.info("Before retrieve orders data");
    Iterable<OrderEntity> orderList = orderService.getOrdersByUserId(userId);

    List<ResponseOrder> result = new ArrayList<>();
    orderList.forEach(v -> result.add(new ModelMapper().map(v, ResponseOrder.class)));

    try {   // 👀 여기! 오류 추가
        Thread.sleep(1000);
        throw new Exception("장애 발생");
    } catch(InterruptedException ex) {
        log.warn(ex.getMessage());
    }

    log.info("After retrieve orders data");
    return ResponseEntity.status(HttpStatus.OK).body(result);
}

 

 

Zipkin 서버에서 확인해보자

적용했던 오류를 확인 할 수 있다.

 

Dependencies 확인

 

 

 

 

 

 

 

 

 

마무리

zipkin을 활용하면 어느 기능에서 문제가 발생했는지 콘솔에 하나하나 찍어 확인하지 않아도, 쉽게 추적할 수 있어서 좋다.

1. 에러가 어디서 발생했는지 알 수 있어서도 좋지만(분산추적)

2. 호출 내에서 종속성을 확인 할 수 있어서도 좋다! 한개의 호출에 해당하는 관계를 trace ID로 알 수 있다.(서비스 매핑)

3. 이를 시각화해서 볼 수 있다는 점에서 이해하기 더욱 좋다!(시각화)

이 외의 장점도 존재한다.

 

 

 

 

한 발 더 나아가 마이크로 서비스가 현재 가지고 있는 메모리 상태나 호출도니 정확한 횟수는 추가적으로 모니터링이 기능을 넣어야 한다! 다음 게시물 참고!

 

 

 

---

 

 

 

🔥 Spring Boot 3.2 + Spring Cloud 2023.0.0 버전 이슈

버전을 높아진 상태에서는 Dendency 등 많은게 바뀐 듯 하다.

위에 설정은 예전 버전으로 최신 버전을 사용하기 위해서는 아래 링크를 확인해서 다시 진행해야한다.

 

참고링크 1

참고링크 2

참고링크 3