Spring Boot와 Prometheus 연동하기

Spring Boot와 Prometheus 연동하기

Overview

Spring Boot 애플리케이션에 Prometheus를 통합하는 과정은 애플리케이션의 성능 모니터링과 메트릭 수집을 효율적으로 처리할 수 있도록 돕습니다. Prometheus는 오픈 소스 모니터링 및 경고 도구로, 다양한 메트릭을 수집하고 시계열 데이터를 저장하며, Grafana와 함께 대시보드 시각화를 제공하는 강력한 도구입니다. 이 문서에서는 Spring Boot 애플리케이션을 Prometheus와 통합하는 방법을 상세히 설명하고, 구현 시 발생할 수 있는 문제와 그 해결 방법에 대해서도 다루겠습니다.

1. Spring Boot 애플리케이션 설정

Spring Boot 애플리케이션에서 Prometheus 메트릭을 수집하기 위해서는 micrometer 라이브러리와 prometheus 스크래퍼를 설정해야 합니다. Micrometer는 Spring Boot 애플리케이션에서 메트릭을 수집하고 다양한 모니터링 시스템으로 전달하는 라이브러리입니다.

1.1. Gradle 의존성 추가

Gradle을 사용하는 경우, build.gradle 파일에 Prometheus 관련 의존성을 추가해야 합니다. 아래의 코드를 dependencies 블록에 추가합니다:

dependencies {
implementation 'io.micrometer:micrometer-registry-prometheus'
}

Maven을 사용하는 경우, pom.xml 파일에 다음 의존성을 추가합니다:

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

1.2. Spring Boot 애플리케이션 설정

application.properties 또는 application.yml 파일에 Prometheus 메트릭 수집을 위한 설정을 추가합니다.

application.properties 예시:

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

application.yml 예시:

management:
endpoints:
web:
exposure:
include: prometheus
endpoint:
prometheus:
enabled: true

이 설정은 Spring Boot 애플리케이션의 /actuator/prometheus 엔드포인트를 통해 Prometheus 메트릭을 노출합니다.

2. Prometheus 서버 설정

Prometheus 서버가 Spring Boot 애플리케이션에서 메트릭을 수집하려면 prometheus.yml 파일을 설정해야 합니다.

2.1. Prometheus 설정 파일

Prometheus의 설정 파일인 prometheus.yml 파일을 다음과 같이 작성합니다:

global:
scrape_interval: 15s

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

여기서 targets는 Spring Boot 애플리케이션이 실행 중인 호스트와 포트를 지정합니다. 기본적으로는 localhost:8080으로 설정되어 있습니다.

2.2. Prometheus 서버 실행

설정이 완료되면 Prometheus 서버를 실행합니다. Prometheus 바이너리를 다운로드하고, 다음 명령어로 서버를 시작할 수 있습니다:

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

Prometheus 서버는 기본적으로 localhost:9090에서 실행됩니다.

3. Grafana와 통합

Prometheus와 함께 Grafana를 사용하면 시각적으로 메트릭을 모니터링하고 대시보드를 만들 수 있습니다.

3.1. Grafana 설치

Grafana를 설치하고 실행합니다. Grafana의 공식 웹사이트에서 적절한 패키지를 다운로드할 수 있습니다. 설치 후, Grafana 서버를 실행합니다.

3.2. Grafana에 Prometheus 데이터 소스 추가

1. Grafana에 로그인 후, 왼쪽 사이드바에서 "Configuration"을 클릭합니다.
2. "Data Sources"를 선택한 후, "Add data source" 버튼을 클릭합니다.
3. "Prometheus"를 선택하고, URL 필드에 Prometheus 서버의 주소(예: http://localhost:9090)를 입력합니다.
4. "Save & Test" 버튼을 클릭하여 데이터 소스를 저장하고 테스트합니다.

3.3. Grafana 대시보드 설정

1. "Create" 버튼을 클릭한 후, "Dashboard"를 선택합니다.
2. "Add new panel"을 클릭하고, 쿼리 입력란에 Prometheus 쿼리를 작성하여 데이터를 시각화합니다. 예를 들어, http_requests_total 메트릭을 기반으로 그래프를 만들 수 있습니다.
3. 필요한 대시보드를 구성한 후, "Save" 버튼을 클릭하여 대시보드를 저장합니다.

4. 문제 해결

4.1. Prometheus 메트릭 수집 실패

• 문제: Prometheus가 Spring Boot 애플리케이션의 메트릭을 수집하지 못하는 경우가 있습니다.
• 해결 방법: 애플리케이션 로그를 확인하여 Actuator 관련 설정이 올바른지 확인하고, localhost:8080/actuator/prometheus 엔드포인트에 직접 접근해 봅니다. 문제가 지속된다면, 방화벽 설정이나 네트워크 문제를 점검해 볼 필요가 있습니다.

4.2. Grafana 대시보드에 데이터 표시 안 됨

• 문제: Grafana에서 Prometheus 데이터를 쿼리해도 결과가 나타나지 않는 경우가 있습니다.
• 해결 방법: Grafana의 데이터 소스 설정을 확인하고, Prometheus 쿼리가 올바른지 검토합니다. 또한, Grafana와 Prometheus 간의 네트워크 연결이 정상인지 확인합니다.

참고문서

• Spring Boot Actuator Documentation
• Micrometer Prometheus Registry Documentation
• Prometheus Documentation
• Grafana Documentation

위의 문서들은 Spring Boot와 Prometheus 통합에 대한 추가 정보를 제공하며, 각 단계에서 발생할 수 있는 문제를 해결하는 데 도움을 줄 수 있습니다.