[스프링 핵심 원리와 활용] 섹션9. 액츄에이터

[YuDeokRin]

섹션 9. 액츄에이터

1️⃣ 프로덕션 준비 기능이란?

전투에서 실패한 지휘관은 용서할 수 있지만 경계에서 실패하는 지휘관은 용서할 수 없다

서비스를 운영하는 개발자에게 맞추어 보면 장애는 언제든지 발생할 수 있지만, 모니터링(경계)은 잘 대응하는 것이 중요하다는 것.

• 개발자가 애플리케이션을 개발할 때 기능 요구사항만 개발하는 것은 아니다.

• 또 다른 중요한 것 : 서비스에 문제가 없는지 모니터링하고 지표들을 심어서 감시하는
  활동

• 운영 환경에서 서비스할 때 필요한 기능들을 프로덕션 준비 기능이라 한다.

  • 지표(metric), 추적(trace), 감사(auditing)
  • 모니터링

2️⃣ 프로젝트 설정

• actuator-start 폴더 이름을 actuator로 변경

• 프로젝트 임포트

• build.gradle확인

  • 가장 중요 라이브러리 : org.springframework.boot:spring-boot-starter-actuator

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-actuator' //actuator 추가
    
}

3️⃣ 액츄에이터 시작

• 액추에이터가 제공하는 프로덕션 준비 기능 사용 방법

1. 라이브러리 추가
2. 동작 확인
   1. 메인 클래스 실행
   2. http://localhost:8080/actuator 실행
3. 실행 결과

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

1. http://localhost:8080/actuator/health
   1. 실행 결과 → 현재 애플리케이션 서버가 잘 작동하는지 확인

{"status": "UP"}

✅ 액추에이터 기능을 웹에 노출

1. application.yml 생성

management:
  endpoints:
    web:
      exposure:
        include: '*'

1. 실행 결과

  "_links": {
    "self": {
      "href": "http://localhost:8080/actuator",
      "templated": false
    },
    "beans": {
      "href": "http://localhost:8080/actuator/beans",
      "templated": false
    },
    "caches-cache": {
      "href": "http://localhost:8080/actuator/caches/{cache}",
      "templated": true
    },
    "caches": {
      "href": "http://localhost:8080/actuator/caches",
      "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
    },
    "conditions": {
      "href": "http://localhost:8080/actuator/conditions",
      "templated": false
    },
    "configprops": {
      "href": "http://localhost:8080/actuator/configprops",
      "templated": false
    },
    "configprops-prefix": {
      "href": "http://localhost:8080/actuator/configprops/{prefix}",
      "templated": true
    },
    "env": {
      "href": "http://localhost:8080/actuator/env",
      "templated": false
    },
    "env-toMatch": {
      "href": "http://localhost:8080/actuator/env/{toMatch}",
      "templated": true
    },
    "loggers": {
      "href": "http://localhost:8080/actuator/loggers",
      "templated": false
    },
    "loggers-name": {
      "href": "http://localhost:8080/actuator/loggers/{name}",
      "templated": true
    },
    "heapdump": {
      "href": "http://localhost:8080/actuator/heapdump",
      "templated": false
    },
    "threaddump": {
      "href": "http://localhost:8080/actuator/threaddump",
      "templated": false
    },
    "metrics": {
      "href": "http://localhost:8080/actuator/metrics",
      "templated": false
    },
    "metrics-requiredMetricName": {
      "href": "http://localhost:8080/actuator/metrics/{requiredMetricName}",
      "templated": true
    },
    "scheduledtasks": {
      "href": "http://localhost:8080/actuator/scheduledtasks",
      "templated": false
    },
    "mappings": {
      "href": "http://localhost:8080/actuator/mappings",
      "templated": false
    }
  }
}

• 액추에이터가 제공하는 수 많은 기능을 확인
• 액추에이터가 제공하는 기능 하나하나를 엔드포인트라고 한다.
  • health → 헬스 정보
  • beans → 스프링 컨테이너에 등록된 빈 정보

4️⃣ 엔드포인트 설정

• 엔드포인트를 사용하라면 다음 2가지 과정이 필요

  • 엔드포인트 활성화 : 해당 기능 자체를 사용할지 말지 on, off를 선택하는 것
  • 엔드포인트 노출 : 노출은 활성화된 엔드포인트를 HTTP에 노출할지 혹은 JMX에 노출할지 선택하는 것

• 엔드포인트는 대부분 기본으로 활성화 되어 있음. (단, shutdown은 제외)

• application.yml - 모든 엔드포인트를 웹에 노출

  • “*” 옵션은 모든 엔드포인트를 웹에 노출하는 것 (단, shutdown 제외)

management:
  endpoints:
    web:
      exposure:
        include: '*'

• 엔드포인트 활성화
  • application.yml - shutdown 엔드포인트 활성화
  • 특정 엔드포인트를 활성화 하라면 management.endpoint.{엔드포인트명}.enabled=true 를 적용하면 된다.

management:
  endpoint:
    shutdown:
      enabled:  true
  endpoints:
    web:
      exposure:
        include: '*'

• shutdown 추가

 "shutdown": {
      "href": "http://localhost:8080/actuator/shutdown",
      "templated": false
    },

• shutdown 결과

✅ 엔드포인트 노출

• jmx 에 health,info 를 노출한다.

management:
  endpoints:
    jmx:
      exposure:
        include: "health,info"

• web에 모든 엔드포인트 노출이면서 제외 → env,beans

management:
  endpoints:
    web:
      exposure:
        include: "*"
        exclude: "env,beans"        

5️⃣ 다양한 엔드포인트

✅ 엔드포인트 목록

• beans : 스프링 컨테이너에 등록된 스프링 빈을 보여준다.
• conditions : condition 을 통해서 빈을 등록할 때 평가 조건과 일치하거나 일치하지 않는 이유를 표시한다.
• configprops : @ConfigurationProperties 를 보여준다.
• env : Environment 정보를 보여준다.
• health : 애플리케이션 헬스 정보를 보여준다.
• httpexchanges : HTTP 호출 응답 정보를 보여준다. HttpExchangeRepository 를 구현한 빈을 별도로 등록해야 한다.
• info : 애플리케이션 정보를 보여준다.
• loggers : 애플리케이션 로거 설정을 보여주고 변경도 할 수 있다.
• metrics : 애플리케이션의 메트릭 정보를 보여준다.
• mappings : @RequestMapping 정보를 보여준다.
• threaddump : 쓰레드 덤프를 실행해서 보여준다.
• shutdown : 애플리케이션을 종료한다. 이 기능은 기본으로 비활성화 ****되어 있다.

전체 엔드포인트 → 공식 메뉴얼 참고
https://docs.spring.io/spring-boot/reference/actuator/endpoints.html#actuator.endpoints

6️⃣ 헬스 정보

• http://localhost:8080/actuator/health
  • show-details: always는 헬스 정보가 자세하게 나온다.

management:
  endpoint:
    shutdown:
      enabled:  true
    health:
      show-details: always
  endpoints:
    web:
      exposure:
        include: "*"

• 결과

{
  "status": "UP",
  "components": {
    "db": {
      "status": "UP",
      "details": {
        "database": "H2",
        "validationQuery": "isValid()"
      }
    },
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 494384795648,
        "free": 267227369472,
        "threshold": 10485760,
        "path": "/Users/dante/Desktop/DanteFolder/study/actuator/.",
        "exists": true
      }
    },
    "ping": {
      "status": "UP"
    }
  }
}

• application.yml
  • show-components: always 는 간략하게 상태 정보만 노출

management:
  endpoint:
    shutdown:
      enabled:  true
    health:
      show-components: always
  endpoints:
    web:
      exposure:
        include: "*"

• 실행결과
  • components 옵션은 하나라도 문제가 있으면 전체 상태는 down이 된다.

{
  "status": "UP",
  "components": {
    "db": {
      "status": "UP"
    },
    "diskSpace": {
      "status": "UP"
    },
    "ping": {
      "status": "UP"
    }
  }
}

• 참고 - 자세한 헬스 기본 지원 기능, 공식 메뉴얼

https://docs.spring.io/spring-boot/reference/actuator/endpoints.html#actuator.endpoints.health.auto-configured-health-indicators

• 참고 - 헬스 기능 직접 구현하기

https://docs.spring.io/spring-boot/reference/actuator/endpoints.html#actuator.endpoints.health.writing-custom-health-indicators