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

 

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

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

 

 

0️⃣ Timer 란? 

: Timer 는 좀 특별한 메트릭 측정 도구로, 시간을 측정하는데 사용된다. 

카운터와 유사하며, Timer를 사용하면 실행시간도 함께 측정할 수 있다. 

 

seconds_count : 누적 실행 수  (카운터)

seconds_sum : 실행 시간 의 합 

seconds_max : 최대 실행 시간(가장 오래걸린 실행 시간)  (게이지)  -> 내부에 타임 윈도우라는 개념이 있기 때문에 1 ~ 3 분 마다 최대 실행 시간이 다시 계산된다. 

 

 

1️⃣ 메트릭 등록 3 - Timer 

 

OrderServiceV3 

@Slf4j
public class OrderServiceV3 implements OrderService
{
   private final MeterRegistry meterRegistry;
   private AtomicInteger stock = new AtomicInteger(100);
   
   public OrderServiceV3(MeterRegistry meterRegistry)
   {
      this.meterRegistry = meterRegistry;
   }
   
   @Override
   public void order()
   {
      Timer timer = Timer.builder("my.order")
            .tag("class", this.getClass().getName())
            .tag("method", "order")
            .description("order")
            .register(meterRegistry);
      
      timer.record(() -> {
         log.info("주문");
         stock.decrementAndGet();
         sleep(500);
      });
   }
   
   
   @Override
   public void cancel()
   {
      Timer timer = Timer.builder("my.order")
            .tag("class", this.getClass().getName())
            .tag("method", "cancel")
            .description("cancel")
            .register(meterRegistry);
      
      timer.record(() -> {
         log.info("취소");
         stock.incrementAndGet();
         sleep(200);
      });
   }
   
   @Override
   public AtomicInteger getStock()
   {
      return stock;
   }
   
   private static void sleep(int l)
   {
      try
      {
         Thread.sleep(l + new Random().nextInt(200));
      }
      catch (InterruptedException e)
      {
         throw new RuntimeException(e);
      }
   }
}

Timer 생성하고 등록하는 것도 Timer와 비슷하다. 

Timer.builder(name) 을 통해서 타이머를 생성하고 name에 메트릭 이름을 지정해준다. 

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

register(registry) 를 통해 만든 MeterRegistry에 등록하면 실제로 등록한다. 

 

Timer를 생성한 다음에 타이머를 사용할 때는 timer.record()를 사용하면 된다. 그리고 그 안에 시간을 측정하고 싶은 내용을 함수로 포함하면 된다. 

 

(그리고 이때 주문 or 취소할 때 걸리는 시간을 확인하기 위해서 0.5, 0.2 초 대기하도록 했다. 그리고 최대 실행시간을 확인하기 위해서 랜덤으로 값을 더해줬다. )

 

 

OrderConfigV3

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

 

 

ActuatorApplication 

@Import(OrderConfigV3.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

COUNT : 누적 실행 시간 (카운터) 

TOTAL_TIME : 실행 시간의 합 (각각의 실행 시간 누적 합) 

MAX : 최대 실행 시간 (가장 오래 걸린 실행시간) 

 

 

* 그라파나 등록 

 

* 주문수 

 

* 최대 실행시간

 

 

* 평균 실행시간 

 

 

2️⃣ 메트릭 등록 4 - @Timed 

 

OrderServiceV4

@Timed(value = "my.order")
@Slf4j
public class OrderServiceV4 implements OrderService
{
   private AtomicInteger stock = new AtomicInteger(100);
   
   @Override
   public void order()
   {
      log.info("주문");
      stock.decrementAndGet();
      sleep(500);
   }
   
   @Override
   public void cancel()
   {
      log.info("취소");
      stock.incrementAndGet();
      sleep(200);
   }
   
   @Override
   public AtomicInteger getStock()
   {
      return stock;
   }
   
   private static void sleep(int l)
   {
      try
      {
         Thread.sleep(l + new Random().nextInt(200));
      }
      catch (InterruptedException e)
      {
         throw new RuntimeException(e);
      }
   }
}

@Timed("my.order") 어노테이션을 사용해주면 힘들게(?) 코드를 여러번 작성하지 않아도 시간 측정을 할 수 있다. 

이때 꼭 클래스가 아닌 타입이나 메서드에도 적용할 수 있다. 

(지금은 클래스에 적용하고 있기 때문에 이 경우에는 getStock() 에도 타이머가 적용된다. )

 

 

OrderConfigV4

 @Configuration
public class OrderConfigV4
{
   @Bean
   OrderService orderService()
   {
      return new OrderServiceV4();
   }
   
   @Bean
   public TimedAspect timedAspect(MeterRegistry meterRegistry)
   {
      return new TimedAspect(meterRegistry);
   }
}

전에 @Counted와 동일하게 @Timed도 TimeAspect를 빈으로 등록해주지 않으면 AOP가 적용되지 않는다. 

 

 

ActuatorApplication

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

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

 

 

* 실행

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

 

 

http://localhost:8080/actuator/prometheus