카운터 메트릭 등록 및 모니터링 (스프링, 프로메테우스, 그라파나)

 

스프링 & 프로메테우스 & 그라파나 (그라파나 설치, 연동, 사용 방법) (tistory.com)

스프링 & 프로메테우스 & 그라파나 (그라파나 설치, 연동, 사용 방법)

 

이전 글을 보면 cpu 사용량, 메모리 사용량, db 커넥션 풀 등 같은 공통으로 사용되는 기술 메트릭들은 이미 등록되어 있어서 이 메트릭을 사용해서 대시보드를 구성하고 모니터링할 수 있었다. 

 

그런데 cpu 사용량, 메모리 사용량 등을 넘어서 비지니스에 특화된 부분(주문 수, 취소 수 등..)을 모니터링 하고 싶다면? 

이런 부분들은 cpu 사용량이나 메모리 사용량으로는 알 수 없기 때문에 이런 비지니스 메트릭은 직접 등록하고 확인해야 한다. 

 

 

0️⃣ 예제 프로젝트 

* 주문 수, 취소 수 

: 상품을 주문하면 주문수가 증가하고, 상품을 취소하면 주문 수는 유지되고, 취소수가 증가한다. 

 

* 재고수량 

: 상품을 주문하면 재고 수량이 감소하고, 상품을 취소하면 재고 수량이 증가한다. 

 

* 주문 수, 취소 수는 계속 증가하는 값이기 때문에 카운터를 사용한다. 

  재고 수량은 증가하거나 감소하기 때문에 게이지를 사용한다. 

 

 

OrderService

public interface OrderService
{
   void order();
   
   void cancel();
   
   // AtomicInteger : 멀티쓰레드 환경에서 안전하게 값을 증가시킬 수 있는 Integer
   AtomicInteger getStock();
}

간단한 인터페이스로 주문, 취소, 재고수량을 확인할 수 있다. 

 

 

OrderServiceV0 

@Slf4j
public class OrderServiceV0 implements OrderService
{
   
   private AtomicInteger stock = new AtomicInteger(100);
   
   @Override
   public void order()
   {
      log.info("주문");
      stock.decrementAndGet();
   }
   
   @Override
   public void cancel()
   {
      log.info("취소");
      stock.incrementAndGet();
   }
   
   @Override
   public AtomicInteger getStock()
   {
      return stock;
   }
}

재고 초기 수량을 100으로 설정한다. 

 

 

OrderConfigV0

@Configuration
public class OrderConfigV0
{
   @Bean
   OrderService orderService()
   {
      return new OrderServiceV0();
   }
}

OrderService를 직접 빈으로 등록한다.  

 

 

OrderController

@Slf4j
@RestController
public class OrderController
{
   public final OrderService orderService;
   
   public OrderController(OrderService orderService)
   {
      this.orderService = orderService;
   }
   
   @GetMapping("/order")
   public String order()
   {
      log.info("order");
      orderService.order();
      return "order";
   }
   
   @GetMapping("/cancel")
   public String cancel()
   {
      log.info("cancel");
      orderService.cancel();
      return "cancel";
   }
   
   @GetMapping("/stock")
   public int stock()
   {
      log.info("stock");
      return orderService.getStock().get();
   }
   
}

 

ActuatorApplication

@Import(OrderConfigV0.class)
@SpringBootApplication(scanBasePackages = "hello.controller")
public class ActuatorApplication {

    public static void main(String[] args) {
        SpringApplication.run(ActuatorApplication.class, args);
    }
}

OrderServiceVx(V0, V1... 이런식으로 늘어날 예정) 가 모두 컴포넌트 스캔읜 대상이 되지 못하게 하기 위해서 컴포넌트 스캔의 대상은 hello.controller로 제한하고, import를 OrderConfigV0으로 설정 파일을 등록한다. 

 

 

(여기까지는 메트릭과 관련없는 기본 프로젝트이다.)

 

 

 

1️⃣ 메트릭 등록 1 - 카운터 

주문수와 취소수는 계속 증가하는 값으로 카운터를 사용할 것인데 마이크로미터를 사용해서 메트릭을 직접 등록할 수 있다. 

 

MeterRegistry

: 마이크로미터 기능을 제공하는 핵심 컴포넌트로 스프링을 통해서 주입받고 이곳에 카운터, 게이지 등을 등록할 수 있다. 

 

Counter 카운터 

: 단조롭게 증가하는 단일 누적 측정항목 -> 누적이므로 전체 값을 포함한다.  

카운터는 값을 증가하거나 0으로 초기화하는 것만 가능하다. 

ex) HTTP 요청수 

 

 

OrderServiceV1 

@Slf4j
public class OrderServiceV1 implements OrderService
{
   private final MeterRegistry meterRegistry;
   private AtomicInteger stock = new AtomicInteger(100);
   
   public OrderServiceV1(MeterRegistry meterRegistry)
   {
      this.meterRegistry = meterRegistry;
   }
   
   @Override
   public void order()
   {
      log.info("주문");
      stock.decrementAndGet();
      
      Counter.builder("my.order")
            .tag("class", this.getClass().getName())
            .tag("method", "order")
            .description("order")
            .register(meterRegistry).increment();
   }
   
   @Override
   public void cancel()
   {
      log.info("취소");
      stock.incrementAndGet();
      
      Counter.builder("my.order")
            .tag("class", this.getClass().getName())
            .tag("method", "cancel")
            .description("cancel")
            .register(meterRegistry).increment();
   }
   
   @Override
   public AtomicInteger getStock()
   {
      return stock;
   }
}

Counter.builder(name) 을 통해서 카운터를 생성하고 name에는 메트릭 이름을 지정해준다. 

tag를 사용해서 프로메테우스에서 필터할 수 있는 레이블로 사용한다. -> 주문과 취소의 메트릭 이름은 같고, tag을 통해서 구분하도록 설정 

register(meterRegistry) 만든 카운터를 이제 MeterRegistry에 등록해주면 실제 동작한다. 

increment() 를 하면 해당 메서드를 실행할 때 마다 카운터 값이 하나 증가한다. 

 

 

OrderConfigV1

@Configuration
public class OrderConfigV1
{
   @Bean
   OrderService orderService(MeterRegistry meterRegistry)
   {
      return new OrderServiceV1(meterRegistry);
   }
}

 

ActuatorApplication

@Import(OrderConfigV1.class)
@SpringBootApplication(scanBasePackages = "hello.controller")
public class ActuatorApplication {

    public static void main(String[] args) {
        SpringApplication.run(ActuatorApplication.class, args);
    }
    
}

 

 

* 실행

http://localhost:8080/order

http://localhost:8080/cancel 

 

주문과 취소를 실행한 다음에 메트릭을 확인해보면 

http://localhost:8080/actuator/metrics/my.order 

my.order 검색 

 

http://localhost:8080/actuator/prometheus

my_order 검색 

 

주문수, 취소수 메트릭이 등록된 것을 확인할 수 있다. 

 

http://localhost:8080/actuator/metrics/my.order?tag=method:order

이런식으로 태그를 통해 특정 메서드만 필터해서 조회할 수 있다. 

 

 

* 그라파나 등록 : 주문수, 취소수

(/order, /cancel 몇번 호출한 다음, 확인 가능) 

 

카운터는 저번글에서도 배웠듯이 계속 증가하는 값이기 때문에 단순히 값만 쿼리하면 계속 증가하기만 하는 그래프를 확인할 수 있다. 

따라서 언제 얼마나 증가했는지 확인하기 위해서는 increase(), rate() 같은 함수를 같이 사용하는 것이 좋다. 

 

 

 

2️⃣ 메트릭 등록 2 - @Counted 

위에서 메트릭 등록 하는 걸 보면 중복되는 코드도 많고, 비지니스 로직에 보면 메트릭 등록 코드가 더 많이 차지하고 있다. 

이럴때 바로 AOP 를 사용하는 것이다..!!! 

직접 AOP를 만들고 등록해서 적용해도 되지만 마이크로미터는 이미 AOP 구성요소를 모두 갖춰놨기 때문에 우리는 사용하기만 하면 된다. ㅎㅎ 

 

 

OrderServiceV2

@Slf4j
public class OrderServiceV2 implements OrderService
{
   private AtomicInteger stock = new AtomicInteger(100);
   
   @Counted("my.order")
   @Override
   public void order()
   {
      log.info("주문");
      stock.decrementAndGet();
   }
   
   @Counted("my.order")
   @Override
   public void cancel()
   {
      log.info("취소");
      stock.incrementAndGet();
      
   }
   
   @Override
   public AtomicInteger getStock()
   {
      return stock;
   }
}

@Counted 애노테이션을 측정을 원하는 메서드에 적용하면 된다. 

예제에서는 주문과 취소 메서드에 지정해줬고, 메트릭 이름 "my.order"를 지정해줬다. 

이렇게 사용하면 tag에 method 를 기준으로 분류해서 적용한다. 

 

 

OrderConfigV2

@Configuration
public class OrderConfigV2
{
   @Bean
   public OrderService orderService()
   {
      return new OrderServiceV2();
   }
   
   // CountedAspect를 빈으로 등록하지 않으면 AOP가 동작하지 않는다!
   @Bean
   public CountedAspect countedAspect(MeterRegistry meterRegistry)
   {
      return new CountedAspect(meterRegistry);
   }
}

❗ 주의할 점은 CountedAspect 를 빈으로 등록하지 않으면 AOP가 동작하지 않으니 반드시 등록하자! 

 

 

ActuatorApplication 

@Import(OrderConfigV2.class)
@SpringBootApplication(scanBasePackages = "hello.controller")
public class ActuatorApplication {

    public static void main(String[] args) {
        SpringApplication.run(ActuatorApplication.class, args);
    }

}

 

 

* 실행

http://localhost:8080/order

http://localhost:8080/cancel

주문과 취소를 여러번 실행해주자...(최소 1번 이상은 실행되어야 메트릭확인 가능하다..!) 

 

http://localhost:8080/actuator/metrics/my.order

@Counted를 사용할 때는 태그 같은 걸 적용하지 않았는데도 result, exception, method, class와 같은 다양한 tag들이 자동으로 적용된 것을 확인할 수 있다.