Cache 를 Actuator에서 확인하기 (Caffein 예)

Actuator를 통해 CaffeinCache 뿐 아니라, 다른 캐시 모니터링도 가능하다. 

정리해보면, 

• 캐시 사용 설정 (매니저 등록 등)
• Actuator 설정
• 확인

이렇게 볼 수 있기 때문에, 어떤 캐시를 사용하느냐 에 따라서 캐시 사용 설정은 달라질 수 있고 Actuator 설정은 공통이다.

여기서는 Caffein 캐시를 볼 수 있는 내용을 정리 하였다.

 

Actuator 연동

이 부분은 로컬, 글로벌 상관없이 캐시를 actuator와 연동하는 부분이다.

build.gradle 추가

implementation 'org.springframework.boot:spring-boot-starter-actuator'
implementation 'io.micrometer:micrometer-core'

 

application.yaml 추가

management:
  endpoints:
    web:
      exposure:
        include: metrics, caches

• caches는 필수는 아니다.  추가할 경우, GET /actuator/caches 요청시 Cache Manager 정보를 볼 수 있다.
  
  

Caffein CacheManager 등록

@Configuration
@EnableCaching
public class CacheConfig {

    @Bean
    public CacheManager cacheManager() {
        CaffeineCacheManager caffeineCacheManager = new CaffeineCacheManager();
        caffeineCacheManager.setCacheNames(List.of("users"));
        caffeineCacheManager.setCaffeine(Caffeine.newBuilder()
                .maximumSize(1000)
                .expireAfterWrite(10, TimeUnit.SECONDS)
                .recordStats()
        );


        return caffeineCacheManager;
    }
}

• 반드시 setCacheNames 에 캐시 이름을 미리 등록 해주어야 한다.
  • 또는, CaffeinCacheManager 생성시 인자값으로 cache 이름을 적어주어도 된다.
  • 그렇지 않으면 metrics 에서 cache 항목이 안보인다.

요청 Uri

• GET /actuator/metrics/cache.gets 로 요청시 정보를 확인 할 수 있다. 
  • cache.puts
  • cache.evictions
  • cache.size 등 요청 가능하다. 

 

특정 캐시 + 결과 필터링 요청

• GET /actuator/metrics/cache.gets?tag=result:hit 를 통해 hit 한 갯수만 알 수 있다. 
  • GET /actuator/metrics/cache.gets 로 확인시 전체 요청갯수를 알 수 있다.
• GET /actuator/metrics/cache.gets?tag=result:miss 를 통해 miss 한 갯수를 알 수 있다.