001/* 002 * Copyright 2012-2018 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.actuate.metrics.cache; 018 019import io.micrometer.core.instrument.Tag; 020import io.micrometer.core.instrument.binder.MeterBinder; 021 022import org.springframework.cache.Cache; 023 024/** 025 * Provide a {@link MeterBinder} based on a {@link Cache}. 026 * 027 * @param <C> the cache type 028 * @author Stephane Nicoll 029 * @since 2.0.0 030 */ 031@FunctionalInterface 032public interface CacheMeterBinderProvider<C extends Cache> { 033 034 /** 035 * Return the {@link MeterBinder} managing the specified {@link Cache} or {@code null} 036 * if the specified {@link Cache} is not supported. 037 * @param cache the cache to instrument 038 * @param tags tags to apply to all recorded metrics 039 * @return a {@link MeterBinder} handling the specified {@link Cache} or {@code null} 040 */ 041 MeterBinder getMeterBinder(C cache, Iterable<Tag> tags); 042 043}