Spring Boot Actuator - 환경설정하기(IntelliJ), health, info

Spring Boot Actuator는 Spring Boot 애플리케이션의 운영 중인 상태와 행동을 모니터링하고 관리하는 기능을 제공하는 라이브러리이다. 

 

| Spring Boot Actuator 의 장점

• 애플리케이션을 모니터링하고 관리하기 위한 엔드포인트를 제공한다.
• 추가적인 설정이나 조정, 수정없이  DevOps 기능을 사용할 수 있다.
• POM 파일에 의존성을 간단하게 추가함으로써 사용할 수 있다.
• REST 엔드포인트가 애플리케이션에 자동으로 추가된다.

 

| Spring Boot Actuator 설정하기

• POM 파일에 의존성을 간단하게 추가한다.
• 기본적으로 "/health"만 설정되어 있다.
• 아래 application.properties에서는 /health, /info를 추가했다.
• 모든 endpoints를 추가하려면 와일드카드인 "*"를 사용해서 모든 endpoints를 사용할 수 있도록 설정해야한다. (application.properties) 

management.endpoints.web.exposure.include=*

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

실행시 2개의 endpoints를 제공한다는 설명을  볼 수 있다.

 

 

| /health

•  이 엔드포인트는 데이터베이스 연결, 메시지 큐, 외부 서비스 등과 같은 애플리케이션의 여러 구성 요소의 상태를 확인한다. 
• 외부 모니터링 도구나 시스템에 의해 주로 사용되며, 해당 엔드포인트는 애플리케이션이 현재 정상적으로 작동("UP") 중인지, 아니면 문제가 발생하여 다운("DOWN") 상태인지를 판단하는 데 사용된다. 
• 이는 서비스의 비즈니스 로직에 의해 커스터마이징이 가능하다.

 

| /info

• 엔드포인트를 통해 애플리케이션의 메타 정보, 버전, 설명 등의 사용자 정의 정보를 제공할 수 한다.
• application.properties에서 제공하는 메타정보를 설정할 수 있다. 해당 파일에서 info로 시작하는 properties는 /info에 노출된다.

application.properties 설정 전

application.properties 설정 후

 

크롬에서 JSON 형식으로 출력할 수도 있음!

 

💻 크롬에서 JSON으로 출력하기 위한 방법 참고

https://sharonprogress.tistory.com/manage/posts/

 

 

 

 

 

** 그 외의 여러 endpoints들..