Spring Actuator로 Property 변경하기

서비스 가동중에 프로퍼티를 변경할 수 있으면, 서비스를 배포하지 않아도 되기 때문에 빠르고 유연한 서비스를 운영할 수 있다. 스프링에서 제공하는 spring actuator를 의존하는 것만으로도 쉽게 적용할 수 있다.

---

설정

의존성 추가

# build.gradle
dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

 

프로퍼티 설정

# application.yml
management:
  endpoints:
    web:
      exposure:
        include: refresh

 

이렇게만 설정하면 끝이다. 프로퍼티를 변경할 일이 생기면 application.yml을 변경하고 actuator에서 제공하는 엔드포인트를 호출하기만 하면 적용된다.

---

테스트

기존 프로퍼티

# application.yml
jwt:
  token:
    expiration-minutes: 120m
    secret: user-secret-secure-token-more-than-256-user-service​

 

변경 프로퍼티

# application.yml
jwt:
  token:
    expiration-minutes: 10m
    secret: user-secret-secure-token-more-than-256-user-service

http POST localhost:8000/actuator/refresh

 

예를 들어 JWT 정책에 변경이 필요해 유효시간을 10분으로 줄이고 싶은 상황이라 해보자. 프로퍼티를 변경 후 위의 refresh 엔드포인트를 호출하면 어플리케이션 재배포없이 런타임 중에 성공적으로 JWT 정책을 변경할 수 있다.

 

@RestController
@RequiredArgsConstructor
@Slf4j
public class Controller {

  private final Environment environment;

  @GetMapping("/properties")
  public String healthCheck() {
    return """
       ===this application with properties===
       jwt-token-expiration-minutes: %s
       jwt-token-secret: %s
      """
      .formatted(
        environment.getProperty("jwt.token.expiration-minutes"),
        environment.getProperty("jwt.token.secret"),
      );
  }
}
/*
...
===this application with properties===
jwt-token-expiration-minutes: 10m
jwt-token-secret: user-secret-secure-token-more-than-256-user-service
*/

---

유의사항

@ConfigurationProperties

@ConfigurationProperties(prefix = "jwt")
public record JwtProperty(Token token) {

  public JwtProperty(Token token) {
    this.token = Objects.requireNonNullElse(token, new Token(null, null));
  }

  public record Token(@DurationUnit(ChronoUnit.MINUTES) Duration expirationMinutes, String secret) {

    @ConstructorBinding
    public Token(Duration expirationMinutes, String secret) {
      this.expirationMinutes = Objects.requireNonNullElse(expirationMinutes, Duration.ofDays(1L));
      this.secret = Objects.requireNonNullElse(secret, "secret");
    }
  }
}

 

 

사실 현업에 가면 프로퍼티를 직접 꺼내쓰기보다는 자바 프로퍼티 객체를 별도로 정의하고 사용할 것이다. 나도 스프링에서 제공해주는 @ConfigurationProperties를 사용해 개발자들이 함부로 변경하지 못하도록 record 불변 객체로 정의했었다.

프로퍼티 바인딩까지는 잘 동작했지만, 프로퍼티 변경 후 refresh 했을 때 객체의 값이 변경되지 않았다.

 

스프링이 알아서 변경해주지 못하는가 싶어서 @RefreshScope도 선언해봤지만 효과는 없었다.

찾아보니 불변 프로퍼티 객체는 actuator refresh 대상이 아니라는 것이다. 만약 필요하다면 Bean으로 등록해 사용하라고 권장한다.

We have no plans to support refresh of read only properties (ie constructor binding)
 If you want a refresh scope configuration properties, use an @Bean method in configuration.

https://github.com/spring-cloud/spring-cloud-commons/issues/846