[Spring] Spring Boot Admin Client 부가적인 메뉴 추가

Spring Boot Admin 화면에서 조회되는 Client들의 상태 정보를 추가적으로 조회할 수 있는 것들이 무엇이 있는지 알아보고 어떻게 설정해야 하는지 파악해보자.

크게 아래와 같이 구분할 수 있을것 같다.

• JMX-Bean 관리
• Logger ( Log 내용 실시간 조회 )
• Build Version정보 파악 
• Tag 정보 추가

이 기능들은 기본적으로 설정한 Spring Boot Admin 화면에서는 조회되지 않고 추가적으로 설정을 해주어야지 조회가 가능하다.

 

JMX-Bean 관리

우선 이 기능이 무엇이지 알아보도록 하자.

JMX ( Java Management eXtension ) 
-> JMX는 실행 중인 애플리케이션의 상태를 모니터링하고, 설정을 변경할 수 있게 해주는 API
-> JDK 1.5부터 포함된 사양

JConsole과 같은 미리 구현된 모니터링 도구를 이용하여 MBean 서버에 접근할 수 있다.

JMX를 통해 리소스 관리를 하려면 MBeans라는 Managed Beans를 생성해야 하고, 

생성한 MBean을 MBean Server에 등록해야 한다. 

MBean 서버는 등록된 MBeans를 관리하는 agent 역할을 수행하게 된다. 

 

이제 JMX가 무엇인지 알았으니 Spring Boot Admin에서 JMX 기능을 사용하는 방법을 알아보자.

 

pom.xml ( dependency 설정 )

		<dependency>
			<groupId>org.jolokia</groupId>
			<artifactId>jolokia-core</artifactId>
		</dependency>

 

application.yml( spring boot 설정 )

spring:
  jmx:
    enabled: true

 

이렇게 설정을 하면 Spring Boot Admin에 JVM 메뉴 하위에 JMX 메뉴가 추가된다.

여기서 추가한 jolokia라는것은 무엇인지 의문이 들었다.

해당 모듈이 무엇인지 찾아본 내역은 아래와 같다.

Jolokia
-> HTTP 프로토콜을 이용해 손쉽게 JMX 값을 JSON 형식으로 받아볼 수 있게 해주는
    일종의 JMX-HTTP 커넥터

위의 JMX를 설명하며 언급한 JConsole이 JMX를 관리하기 위한 툴이었다면, Jolokia는 JMX에서 관리하는 Bean들의 내용을 조회 및 액션을 수행하기 위한 HTTP 호출 툴(?), 커넥터라고 이해하면 될 것 같다.

 

Logger ( Log 내용 실시간 조회 )

기본으로 제공되는 Spring Boot Admin의 Logger기능은 Log Level를 변경하는 것이다.

거기에 추가적으로 로그의 내용들을 조회하고 싶은경우에는 추가적인 application.yml 파일 설정이 필요하다.

 

application.yml( spring boot 설정 )

logging:
  file:
    name: "/var/log/sample-boot-application.log"    
  pattern:
    file: "%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx"

 

log파일의 위치를 명시적으로 지정해 주어야한다.

( 추가 적으로 log의 패턴도 지정할 수 있다) 

 

 

Build Version정보 파악 

Spring Boot의 빌드 버전 정보는 META-INF/build-info.properties 위치에서 쉽게 파악할 수 있다.

해당 정보를 생성하기 위해서는 추가적인 설정이 필요하다.

 

pom.xml ( dependency 설정 )

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>build-info</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

해당 정보를 추가해 주면 Spring Boot Admin 화면에서 실행 중인 Appliation의 빌드 버전 조회가 가능해진다.

 

Tag 정보 추가

Tag 정보는 단순히 해당 Application에 대한 정보를 추가적으로 표시하기 위한 용도이다.

관리하는 Appliation의 종류가 많아지는 경우에는 해당 Tag를 통해 좀 더 쉽게 Application들의 관리가 이루어질 수도 있을 것 같다.

 

application.yml( spring boot 설정 )

spring:
  boot:
    admin:
      client:
        instance:
          metadata:
            tags:
              environment: "tag-test1"
info:
  tags:
    environment: "tag-test1"