Extract AutoTimer interface for metrics
Refactor `Autotime` from a properties object to an interface and change the existing metric recording implementations. The `AutoTimer` interface is a general purpose callback that can be applied to a `Timer.Builder` to configure it. Autotime properties are now located in `spring-boot-actuator-autoconfigure` and have become an implementation of the interface. Closes gh-17026pull/17010/head
Phillip Webb
6 years ago
parent
ad5e905bd7
commit
68a3fbd7a0
@ -0,0 +1,100 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* https://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.springframework.boot.actuate.metrics;
|
||||
/**
|
||||
* @author pwebb
|
||||
*/
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
import io.micrometer.core.annotation.Timed;
|
||||
import io.micrometer.core.instrument.Timer;
|
||||
import io.micrometer.core.instrument.Timer.Builder;
|
||||
|
||||
/**
|
||||
* Strategy that can be used to apply {@link Timer Timers} automatically instead of using
|
||||
* {@link Timed @Timed}.
|
||||
*
|
||||
* @author Tadaya Tsuyukubo
|
||||
* @author Stephane Nicoll
|
||||
* @author Phillip Webb
|
||||
* @since 2.2.0
|
||||
*/
|
||||
@FunctionalInterface
|
||||
public interface AutoTimer {
|
||||
|
||||
/**
|
||||
* An {@link AutoTimer} implementation that is enabled but applies no additional
|
||||
* customizations.
|
||||
*/
|
||||
AutoTimer ENABLED = (builder) -> {
|
||||
};
|
||||
|
||||
/**
|
||||
* An {@link AutoTimer} implementation that is disabled and will not record metrics.
|
||||
*/
|
||||
AutoTimer DISABLED = new AutoTimer() {
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void apply(Builder builder) {
|
||||
throw new IllegalStateException("AutoTimer is disabled");
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
* Return if the auto-timer is enabled and metrics should be recorded.
|
||||
* @return if the auto-timer is enabled
|
||||
*/
|
||||
default boolean isEnabled() {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory method to create a new {@link Builder Timer.Builder} with auto-timer
|
||||
* settings {@link #apply(Builder) applied}.
|
||||
* @param name the name of the timer
|
||||
* @return a new builder instance with auto-settings applied
|
||||
*/
|
||||
default Timer.Builder builder(String name) {
|
||||
return builder(() -> Timer.builder(name));
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory method to create a new {@link Builder Timer.Builder} with auto-timer
|
||||
* settings {@link #apply(Builder) applied}.
|
||||
* @param supplier the builder supplier
|
||||
* @return a new builder instance with auto-settings applied
|
||||
*/
|
||||
default Timer.Builder builder(Supplier<Timer.Builder> supplier) {
|
||||
Timer.Builder builder = supplier.get();
|
||||
apply(builder);
|
||||
return builder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to apply any auto-timer settings to the given {@link Builder Timer.Builder}.
|
||||
* @param builder the builder to apply settings to
|
||||
*/
|
||||
void apply(Timer.Builder builder);
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue