Springboot 프로젝트에 micrometer + actuator + prometheus + grafana 설치는 방법

by

현재 맡고 있는 솔루션에 monitoring system을 추가하고 있다.

monitoring tool은 다양하지만 유연한 endpoint설정이 가능하고 단독으로 진행하는 작업이기 때문에

간편한 setup, 커뮤니티 지원도 활발한 prometheus + grafana로 정했다. 

image 3

1. Requirements

  • Prometheus 
  • Grafana
  • Spring actuator : application에서 수집한 metric을 endpoint로 제공하는 라이브러리
  • CadVisor : docker container resources 체크 
  • Node Exporter : server의 hardware, kernel states 체크 
  • Micrometer prometheus : spring application에서 사용하는 metric을 prometheus format으로 변환하는 라이브러리

2. Setup

우선 monitoring server의 docker에 Prometheus(default port : 9090), Grafana(port: 3000) 설치하고

monitoring 대상이 되는 모든 server에 cadVisor, node exporter를 설치한다.

설치는 각 framwork, module 공식 문서 참조.

모든 설치를 마치고 prometheus.yml에서 endpoint 등 설정만 제대로 하면 container 실행시 

monitoring server의 9090포트 접근 시 연동 상태를 바로 확인 할 수 있다. (http://{server-ip}:9090/targets)

3. Spring actuator 연동

다음으로 metric 수집 대상이 되는 spring application에 다음 dependency를 추가하자

spring-boot-starter-actuator 

spring-boot-starter-web (web application이 아니더라도 http endpoint 사용시 필요하다)

micrometer-registry-prometheus

이제 application을 실행하면 default url로 actuator가 제공하는 기본 정보들을 볼 수 있다. 

(http://{server-ip}:8080/actuator)

다음으로,

application.yml에 management 설정을 해주면 (http://{server-ip}:8080/actuator/prometheus) 에서 다양한 metric 정보를 확인 할 수 있다.

management:
  server.port: {port} // actuator 포트 변경 가능
  endpoint:
    prometheus:
      enabled: true
    web:
      exposure:
        include: prometheus

4. Custum Metric 

물론 솔루션 기능에 따라 기본적으로 제공하는 metric 외에 필요한 custum metric이 필요하다.

다양한 방법이 있었지만 현재 솔루션 특성상 필요한 custum metric을 모두 단일 객체에서 관리하고

count의 경우 AtomicInteger를 사용해 동시성 보장을 했다.

@Component(value = "metricsProps")
public class MetricProps {
    private final Counter totalCount;
    private final AtomicInteger currentCount;
    
    public MetricProps(MeterRegistry registry) {
    	this.totalCount = registry.counter("labelName1");
        this.currentCount =registry.gauge("labelName2", new AtomicInteger(0));
    }
    
    //getCurrentCount
}

5. Visualization (Grafana)

위 설정이 모두 완료되었다면 (http://{monitoring-server-ip:3000))로 가서 grafana 관리자 페이지로 간다.

(초기 id, pwd는 admin)

먼저 DataSource에 위에서 설정한 prometheus endpoint를 등록하고

dashboard에 원하는 panel들을 추가하면 되는데 너무 많다..

dashboard 설정값은 json파일로 export, import가 가능하기 때문에

이미 spring project에 알맞는 json 설정 파일이 존재한다.

마음에 드는걸로 import하면 default meric에 대한 panel들이 추가되고 

추가적으로 custum metric panel만 직접 추가하면 된다.