소개

이 포스트는 어플리케이션 매트릭 툴인 micometer와 Elastic Search, Kibana를 이용한 대시보드 구축에 대한 소개를 하려고 합니다.

Micrometer란?

micrometer는 Spring 5부터 메트릭을 처리하기 위해 포함된 프레임워크입니다. Think SLF4J, but for metrics 라는 설명과 같이 slf4j와 같이 밴더 중립적 API를 제공해서 실제 매트릭 집계를 위한 도구와 관계 없이 코드를 작성 할 수 있습니다.

아래와 같은 API를 통해 밴더 중립적인 Metrics 집계 코드를 작성 할 수 있도록 도와줍니다.

public interface MeterBinder {
    void bindTo(@NonNull MeterRegistry registry);
}

기본적으로 Jvm, JDBC, db, disk, logback, webflux, tomcat, web mvc등을 포함하고 있으며 resillience4j, armeria등과 같이 spring 생태계에서 많이 사용되는 라이브러리의 경우에는 MeterBinder를 포함하고 있으며 없더라도 손쉽게 작성할 수 있어 원하는 데이터를 쉽게 모니터링할 수 있습니다.

왜 ElasticSearch를 사용했는가?

최근 클라우드환경 모니터링에서 많이 사용되고있는 prometheus와 grafana의 조합이 있고 많은 장점을 가지고 있지만 팀의 규모가 크지 않고 팀내에서 추가적인 인프라를 관리하는대 들어가는 부담감으로 기존에 팀내에서 운영중이던 ElasticSearch를 사용하였습니다.

Micrometer ElasticSearch Registry 추가하기

dependencies {
    // web
    compile group: 'org.springframework.boot', name: 'spring-boot-starter-web'

    // actuator
    compile group: 'org.springframework.boot', name: 'spring-boot-starter-actuator'
    runtimeOnly group: 'io.micrometer', name: 'micrometer-registry-elastic', version: "$micrometerVersion"
}

위 코드와 같이 micrometer-registry-elastic 의존성을 추가해줍니다.

management:
  metrics:
    export:
      elastic:
        enabled: true
        index: metrics
        host: http://{elastic-search-host}

application.yml 파일에 elastic export를 enabled true로 설정하고 인덱스와 호스트를 설정 해줍니다.

설정까지 끝마쳤다면 kibana에서 다음과 같이 문서가 생성된 것을 볼 수 있습니다.

어플리케이션 구분을 위한 태그 추가하기

대략적으로 모든 설정을 끝마쳤지만 여러가지 어플리케이션을 사용하는 환경에서는 각각의 인스턴스를 구분하기 위한 태그가 필요합니다.

management.metrics.tags.{tagName} 설정을 통해서 각 metric에 추가적인 태그를 설정 할 수 있는데 인스턴스 구분을 위한 host와 어플리케이션 구분을 위한 application 태그를 추가하였습니다.

설정을 하는 여러가지 방법이 있겠지만 저희는 aws ec2위에 docker 배포를 사용하기때문에 -Dmanagement.metrics.tags.host=${EC2_AGENT_ID} -Dmanagement.metrics.tags.application=${APPLICATION_NAME}와 같이 외부 설정을 사용하였습니다.

키바나 대시보드 추가하기

다양한 템플릿이 존재하는 grafana와 달리 spring boot와 micrometer 데이터를 보여주기위한 kibana 대시보드 데이터는 극히 적었습니다. 그중에서 가장 보기좋게 구성된 https://github.com/acroquest/micrometer-kibana-dashboard 를 기반으로 대시보드를 구축하였습니다.

kibana가 세팅되어있다면 해당 레포지토리의 kibana_setup.sh를 이용하여 손쉽게 기본적인 대시보드를 구축 할 수 있습니다.