org.redisson.spring.cache.RedissonCacheMetrics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2

Show newest version

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.spring.cache;

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.binder.cache.CacheMeterBinder;

/**
 * 
 * @author Nikita Koksharov
 *
 */
public class RedissonCacheMetrics extends CacheMeterBinder {

    private final RedissonCache cache;
    
    public RedissonCacheMetrics(RedissonCache cache, Iterable tags) {
        super(cache, cache.getName(), tags);
        this.cache = cache;
    }
    
    /**
     * Record metrics on a Redisson cache.
     *
     * @param registry - registry to bind metrics to
     * @param cache - cache to instrument
     * @param tags - tags to apply to all recorded metrics
     * @return cache
     */
    public static RedissonCache monitor(MeterRegistry registry, RedissonCache cache, Iterable tags) {
        new RedissonCacheMetrics(cache, tags).bindTo(registry);
        return cache;
    }

    @Override
    protected Long size() {
        return (long) cache.getNativeCache().size();
    }

    @Override
    protected long hitCount() {
        return cache.getCacheHits();
    }

    @Override
    protected Long missCount() {
        return cache.getCacheMisses();
    }

    @Override
    protected Long evictionCount() {
        return cache.getCacheEvictions();
    }

    @Override
    protected long putCount() {
        return cache.getCachePuts();
    }

    @Override
    protected void bindImplementationSpecificMetrics(MeterRegistry registry) {
    }

}