Spring Boot : Spring Boot Starter Actuator 개념, 예제, 설명

Spring Boot : Spring Boot Starter Actuator 개념, 예제, 설명

 

 

스프링 부트 액추에이터

스프링 부트 액추에이터는 스프링 부트 프레임워크의 하위 프로젝트입니다. 여기에는 스프링 부트 애플리케이션을 모니터링하고 관리하는 데 도움이 되는 여러 가지 추가 기능이 포함되어 있습니다. 여기에는 액추에이터 끝점(리소스가 상주하는 위치)이 포함됩니다. HTTP 및 JMX 엔드포인트를 사용하여 Spring Boot 애플리케이션을 관리하고 모니터링할 수 있습니다. 애플리케이션에서 생산 가능한 기능을 얻으려면 스프링 부트 액추에이터를 사용해야 합니다.

 

 

스프링 부트 액추에이터의 특징

스프링 부트 액추에이터의 세 가지 주요 기능은 다음과 같습니다.

- Endpoints

- Metrics

- Audit

 

 

Endpoints: 액추에이터 끝점을 통해 응용 프로그램을 모니터링하고 상호 작용할 수 있습니다. 스프링 부팅은 여러 개의 기본 제공 엔드포인트를 제공합니다. 또한 엔드포인트를 직접 생성할 수도 있습니다. 각 끝점을 개별적으로 사용하거나 사용하지 않도록 설정할 수 있습니다. 대부분의 응용프로그램은 /actuator 접두사와 함께 끝점의 Id가 URL에 매핑되는 HTTP를 선택합니다.

예를 들어 /health 끝점은 애플리케이션의 기본 상태 정보를 제공합니다. 기본적으로 액추에이터는 이를 /actuator/health에 매핑했습니다. 

 

Endpoint: 스프링 부트 액추에이터는 마이크로미터와 통합되어 치수 측정 기준을 제공합니다. 마이크로미터는 스프링 부트에 통합되어 있습니다. 봄부터 애플리케이션 메트릭스를 제공하는 계측 라이브러리입니다. 치수 데이터 모델을 사용하여 타이머, 게이지, 카운터, 분포 요약 및 긴 작업 타이머를 위한 벤더 중립 인터페이스를 제공합니다.

 

Audit: Spring Boot은 이벤트를 AuditEventRepository에 게시하는 유연한 감사 프레임워크를 제공합니다. 스프링 보안이 실행 중인 경우 인증 이벤트를 자동으로 게시합니다.

 

 

 

스프링 부트 액추에이터 활성화

종속성 spring-boot-starter-actuator를 pom.xml 파일에 주입하여 액추에이터를 활성화할 수 있습니다.

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-actuator</artifactId>  
    <version>2.2.2.RELEASE</version>  
</dependency>

 

 

 

스프링 부트 액추에이터 엔드포인트

액추에이터 엔드포인트를 통해 스프링 부트 응용 프로그램을 모니터링하고 상호 작용할 수 있습니다. Spring Boot에는 기본 제공 엔드포인트 수가 포함되어 있으며 Spring Boot 애플리케이션에서 사용자 지정 엔드포인트를 추가할 수도 있습니다.

다음 표에서는 널리 사용되는 엔드포인트에 대해 설명합니다.

Id	Usage	Default
actuator	다른 엔드포인트에 대한 하이퍼미디어 기반 검색 페이지를 제공합니다. Spring HATOAS가 클래스 경로에 있어야 합니다.	True
auditevents	현재 응용 프로그램에 대한 감사 이벤트 정보를 표시합니다.	True
autoconfig	모든 자동 구성 후보와 'with' 또는 'withnot'이 적용된 이유를 보여주는 자동 구성 보고서를 표시하는 데 사용됩니다.	True
beans	응용 프로그램에 있는 모든 봄 콩의 전체 목록을 표시하기 위해 사용됩니다.	True
configprops	모든 @Configuration Properties의 정렬된 목록을 표시하는 데 사용됩니다.	True
dump	이것은 스레드 덤프를 수행하는 데 사용됩니다.	True
env	스프링의 구성 가능한 환경에서 속성을 노출하는 데 사용됩니다.	True
flyway	적용된 Flyway 데이터베이스 마이그레이션을 표시하는 데 사용됩니다.	True
health	응용 프로그램 상태 정보를 표시하는 데 사용됩니다.	False
info	임의 응용 프로그램 정보를 표시하는 데 사용됩니다.	False
loggers	응용 프로그램에서 로거의 구성을 표시하고 수정하는 데 사용됩니다.	True
liquibase	적용된 모든 Liquibase 데이터베이스 마이그레이션을 표시하는 데 사용됩니다.	True
metrics	메트릭 현재 응용 프로그램에 대한 메트릭 정보를 표시하는 데 사용됩니다.	True
mappings	모든 @RequestMapping 경로의 정렬된 목록을 표시하는 데 사용됩니다.	True
shutdown	응용 프로그램을 정상적으로 종료하는 데 사용됩니다.	True
trace	추적 정보를 표시하는 데 사용됩니다.	True

 

 

Spring MVC의 경우 다음과 같은 추가 엔드포인트가 사용됩니다. 

Id	Description	Default
docs	액추에이터의 엔드포인트에 대한 예제 요청 및 응답을 포함한 문서를 표시하는 데 사용됩니다.	False
heapdump	GZip 압축 hprof 힙 덤프 파일을 반환하는 데 사용됩니다.	True
jolokia	HTTP를 통해 JMX 콩을 노출하는 데 사용됩니다(Jolokia가 클래스 경로에 있을 때).	True
logfile	로그 파일의 내용을 반환하는 데 사용됩니다.	True
prometheus	prometheus 서버에서 스크랩할 수 있는 형식으로 메트릭을 노출하는 데 사용됩니다. 마이크로미터-레지스트리-프로메테우스에 의존해야 합니다.	True

 

 

 

스프링 부트 액추에이터 속성

스프링 부트는 모든 액추에이터 엔드포인트에 보안을 적용합니다. 사용자 ID와 임의로 생성된 비밀번호를 제공하는 양식 기반 인증을 사용합니다. 또한 엔드포인트에 대한 기본 인증 보안을 사용자 지정하여 액추에이터로 제한된 엔드포인트에 액세스할 수 있습니다. management.security.roles 속성을 통해 이 구성을 재정의해야 합니다. 예를 들어 다음과 같습니다.

management.security.enabled=true  
management.security.roles=ADMIN  
security.basic.enabled=true  
security.user.name=admin  
security.user.passowrd=admin

 

 

 

스프링 부트 액추에이터의 예

예제를 통해 액추에이터의 개념을 이해하겠습니다.

 

1단계: Spring Initializr https://start.spring.io/을 열고 메이븐 프로젝트를 만듭니다.

2단계: 그룹 이름을 입력합니다.

3단계: 아티팩트 ID를 제공합니다. spring-boot-actuator-예시를 제공했습니다.

4단계: 스프링 웹, 스프링 부트 스타터 액추에이터 및 스프링 데이터 REST HAL 브라우저를 추가합니다. 

5단계: Generate 버튼을 클릭합니다. Generate 버튼을 클릭하면 프로젝트와 관련된 모든 사양을 Jar 파일로 정리하여 로컬 시스템에 다운로드합니다.

Spring Boot : Spring Boot Starter Actuator 개념, 예제, 설명 1

 

 

6단계: Jar 파일을 추출하여 STS 작업 공간에 붙여넣습니다.

7단계: 프로젝트 폴더를 가져옵니다.

파일 -> 가져오기 -> 기존 메이븐 프로젝트 -> 찾아보기 -> spring-boot-actuator-example -> finish 폴더를 선택합니다.

Spring Boot : Spring Boot Starter Actuator 개념, 예제, 설명 2

 

 

8단계: 컨트롤러 클래스를 만듭니다. DemoRestController라는 이름으로 컨트롤러 클래스를 만들었습니다.

package com.xxx;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoRestController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello User!";
    }
}

 

 

9단계: application.properties 파일을 열고 다음 문을 추가하여 액추에이터의 보안 기능을 비활성화합니다. 

management.security.enabled=false

 

 

10단계: SpringBootActuatorExampleApplication.java 파일을 실행합니다.

 11단계: 브라우저를 열고 URL http://localhost:8080/actuator를 호출합니다. 다음 페이지를 반환합니다.

{
    "_links": {
        "self": {
            "href": "http://localhost:8080/actuator",
            "templated": false
        },
        "health": {
            "href": "http://localhost:8080/actuator/health",
            "templated": false
        },
        "health-path": {
            "href": "http://localhost:8080/actuator/health/{*path}",
            "templated": true
        },
        "info": {
            "href": "http://localhost:8080/actuator/info",
            "templated": false
        }
    }
}

 

 

응용 프로그램은 기본적으로 포트 8080에서 실행됩니다. 액추에이터가 시작되면 HTTP를 통해 노출된 모든 엔드포인트 목록을 볼 수 있습니다.

URL http://localhost:8080/actuator/health를 호출하여 상태 끝점을 호출하겠습니다. UP 상태를 나타냅니다. 즉, 응용프로그램이 정상이고 중단 없이 실행 중임을 의미합니다.

Spring Boot : Spring Boot Starter Actuator 개념, 예제, 설명 3

 

 

마찬가지로 Spring Boot 애플리케이션을 모니터링하고 관리하는 데 도움이 되는 다른 엔드포인트를 호출할 수 있습니다.