• 시스템을 움직이거나 제어하는 데 쓰이는 기계 장치
• 프로덕션 준비기능 ( 비-기능적 요소 )
  • 모니터링
  • 지표(Metric), 추적(Trace), 감사(Auditing)

implementation 'org.springframework.boot:spring-boot-starter-actuator'

• 기본적인 기능
  • localhost:8080/actuator
  • localhost:8080/actuator/health

# 모든 엔드포인트를 웹에 노출 (shutdown 제외)
management.endpoints.web.exposure.include: "*"
# 모든 엔드포인트를 jmx에 노출
management.endpoints.jmx.exposure.include: "*"

• Actuator 모든 기능

• endpoint 설정

  • 활성화 - 기능의 On/Off (default : on, shutdown 기능만 제외)

    • shutdown 활성화

    management.endpoint.shutdown.enabled: true
    

  • 노출 - 기능의 위치 HTTP / JMX (일반적으로 HTTP 로 노출)

• endpoints (매뉴얼 링크)

  • beans : 스프링 컨테이너에 등록된 빈 조회

  • conditions : @Conditional 결과

  • configprops : @ConfigurationProperties

  • env : Environment

  • health

    • path : /actuator/health
    • 상세한 정보 필요

    management:
        endpoint:
          health:
    # 상태상세정보표시  show-details: always
    # 상태정보표시		 show-componets: always
    

  • httpexchanges : HTTP 호출 응답정보

    • HttpExchangeRepository를 구현해야 함 구현체 : ex) InmemoryHttpExchangeRepository
    • 운영용으로는 비추천 Zipkin, 핀포인트 추천

  • info : 애플리케이션 정보

    • java : 자바 runtime 정보 ( default : 비활성화 ) os: OS 정보 ( default : 비활성화 ) env : Environment 에서 info. 로 시작하는 정보 ( default : 비활성화 )

      • 활성화 방법

      managament:
      	info:
      		java:
      			enabled: true
      		os:
      			enalbed: true
      		env:
      			enabled: true
      
      # env에서 표시하는 정보
      info:
      	app:
      		name: hello-actuator
      		company: hh
      

    • git info

      • 플러그인 필요, build.gradle 내용 추가
      • /build/resources/main/git.properties 파일 생성함

      plugins {
      		...
      		id "com.gorylenko.gradle-git-properties" version "2.4.1" //git info
      }
      

    • build info

      • build.gradle 내용 추가
      • build 하면 META-INF/build-info.properties 파일 생성함

      springBoot {
      		buildInfo()
      }
      

  • loggers : 로그레벨에 대한 정보

    • 스프링 기본 로그레벨 info
    • /loggers/{package}.{classname} 으로 해당 클래스 로깅레벨 확인가능
    • 로그레벨을 실시간으로 변경 가능
      • POST /loggers/{package}.{classname} { ”configuredLevel”: “TRACE” }

  • metrics

    Production-ready Features

    • 마이크로미터(?)
    • tags filter

  • mappings

  • threaddump

  • shutdown

• Actuator와 보안

  • Actuator는 내부망에서만 사용하는 것이 안전
  • 방안1 - Actuator 포트를 별도로 사용

  management.server.port: 9292
  

  • 방안2 - 서블릿필터, 스프링 인터셉터, 스프링 시큐리티 활용 (외부망을 사용해야 할 경우)
  • 방안3 - 경로 변경

  managament.endpoints.web.base-path: "/manage"
  

• 마이크로미터

• 그라파나

• 프로메테우스

Prometheus - Monitoring system & time series database

flowchart LR

CPU --> Micrometer
JVM --> Micrometer