Spring Boot와 Grafana 통합 모니터링과 대시보드 구축하기

Spring Boot와 Grafana 통합: 모니터링과 대시보드 구축하기

Overview

Spring Boot와 Grafana를 통합하면 애플리케이션의 성능과 상태를 실시간으로 모니터링할 수 있는 강력한 대시보드를 구축할 수 있습니다. 이 통합은 로그, 메트릭, 애플리케이션 성능 지표를 시각화하여 운영과 문제 해결을 용이하게 해줍니다. 이번 글에서는 Spring Boot 애플리케이션에서 수집한 메트릭을 Grafana를 통해 시각화하는 방법을 단계별로 자세히 설명하겠습니다.

1. Spring Boot 애플리케이션에 Micrometer 설정하기

Micrometer란?

Micrometer는 Spring Boot 애플리케이션에서 메트릭을 수집하고, 다양한 모니터링 시스템에 데이터를 보낼 수 있도록 도와주는 라이브러리입니다. Micrometer는 애플리케이션의 메트릭을 추적하고, 이를 Graphite, Prometheus, InfluxDB 등과 같은 여러 모니터링 시스템에 전달할 수 있습니다.

Micrometer 설정

1. 의존성 추가하기

Spring Boot 애플리케이션에서 Micrometer를 사용하기 위해 pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
  <groupId>io.micrometer</groupId>
  <artifactId>micrometer-core</artifactId>
</dependency>
<dependency>
  <groupId>io.micrometer</groupId>
  <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

위의 예제에서는 Prometheus를 메트릭 수집기로 사용합니다.

2. 설정 파일 수정하기

application.properties 또는 application.yml 파일에서 Micrometer의 설정을 추가합니다. Prometheus와의 통합을 위해 다음과 같이 설정합니다:

management.endpoints.web.exposure.include=*
management.endpoint.prometheus.enabled=true

이 설정은 Prometheus 엔드포인트를 활성화하여 메트릭을 수집할 수 있게 합니다.

예제 코드

아래는 Spring Boot 애플리케이션의 메트릭을 수집하기 위한 간단한 예제입니다:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import io.micrometer.core.annotation.Counted;
import io.micrometer.core.annotation.Timed;

@SpringBootApplication
public class DemoApplication {

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

@RestController
class SampleController {

@GetMapping("/hello")
@Counted("hello.count")
@Timed("hello.time")
public String hello() {
return "Hello, World!";
}
}

위의 예제에서는 hello 엔드포인트에 대해 호출 횟수와 응답 시간을 측정하는 메트릭을 추가합니다.

2. Prometheus 설치 및 설정

Grafana는 다양한 데이터 소스와 통합되지만, 이 글에서는 Prometheus를 데이터 수집기로 사용하여 Grafana에 메트릭을 전달하는 방법을 설명합니다.

Prometheus 설치하기

1. Prometheus 다운로드

Prometheus 공식 웹사이트에서 최신 버전의 Prometheus를 다운로드합니다.

2. Prometheus 설정

다운로드한 압축 파일을 풀고, prometheus.yml 설정 파일을 수정하여 Spring Boot 애플리케이션에서 수집한 메트릭을 가져옵니다.

global:
scrape_interval: 15s

scrape_configs:
- job_name: 'spring-boot'
static_configs:
- targets: ['localhost:8080']

위 설정에서 localhost:8080은 Spring Boot 애플리케이션의 주소입니다. 실제 애플리케이션의 주소와 포트를 맞추어야 합니다.

3. Prometheus 실행

설정이 완료되면 Prometheus를 다음 명령어로 실행합니다:

./prometheus --config.file=prometheus.yml

예제 메트릭 확인

Prometheus가 제대로 설정되었는지 확인하기 위해, 웹 브라우저에서 http://localhost:9090으로 접속하여 메트릭 데이터를 조회할 수 있습니다.

3. Grafana 설치 및 설정

Grafana는 다양한 데이터 소스를 지원하며, Prometheus와의 통합을 통해 수집된 메트릭을 시각화할 수 있습니다.

Grafana 설치하기

1. Grafana 다운로드

Grafana 공식 웹사이트에서 최신 버전의 Grafana를 다운로드합니다.

2. Grafana 실행

다운로드한 패키지를 설치하고, 다음 명령어로 Grafana를 실행합니다:

./bin/grafana-server

기본적으로 Grafana는 http://localhost:3000에서 접근할 수 있습니다.

데이터 소스 추가하기

1. Grafana에 로그인

웹 브라우저에서 http://localhost:3000으로 접속하여 Grafana에 로그인합니다. 기본 로그인 정보는 사용자명 admin, 비밀번호 admin입니다.

2. 데이터 소스 설정

3. 왼쪽 사이드바에서 'Configuration' 클릭

4. 'Add data source' 클릭

5. 'Prometheus' 선택

6. Prometheus의 URL 입력 (예: http://localhost:9090)

7. 'Save & Test' 클릭하여 데이터 소스 테스트

대시보드 생성하기

1. 대시보드 생성

2. 왼쪽 사이드바에서 'Create' 클릭

3. 'Dashboard' 클릭

4. 'Add new panel' 클릭

5. 패널 구성

6. 쿼리 작성

쿼리 박스에 Prometheus 쿼리를 입력하여 원하는 메트릭을 선택합니다. 예를 들어, http_requests_total 메트릭을 선택하여 요청 수를 시각화할 수 있습니다.

2. 시각화 설정

패널에서 다양한 시각화 옵션을 사용하여 데이터를 그래프, 표 등으로 표현합니다.

3. 대시보드 저장

대시보드의 상단 바에서 'Save' 버튼을 클릭하여 대시보드를 저장합니다.

4. 에러 처리 및 해결 방법

Prometheus 관련 에러

• 에러 메시지: 503 Service Unavailable
• 해결 방법:* Prometheus가 실행되고 있는지 확인합니다. 설정 파일의 targets에 올바른 주소가 입력되었는지 점검합니다.

Grafana 관련 에러

• 에러 메시지: Data source not working
• 해결 방법:* Grafana의 데이터 소스 설정에서 Prometheus의 URL이 올바른지 확인합니다. Prometheus가 제대로 작동하고 있는지 점검합니다.

참고문서

• Spring Boot Micrometer Documentation - Micrometer의 공식 문서
• Prometheus Documentation - Prometheus의 공식 문서
• Grafana Documentation - Grafana의 공식 문서

위 문서들은 Spring Boot, Prometheus, Grafana의 설정과 사용 방법을 깊이 있게 다루고 있으니, 추가적인 참고자료로 활용하세요.