Introduce PushRegistry abstraction
This commit introduces a separate layer between PushRegistry and StepRegistry-based implementations. See gh-17699pull/17742/head
Stephane Nicoll
5 years ago
parent
e52d398771
commit
b405f8ecf2
@ -0,0 +1,111 @@
|
||||
/*
|
||||
* 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.autoconfigure.metrics.export.properties;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
/**
|
||||
* Base class for properties that configure a metrics registry that pushes aggregated
|
||||
* metrics on a regular interval.
|
||||
*
|
||||
* @author Jon Schneider
|
||||
* @author Andy Wilkinson
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.2.0
|
||||
*/
|
||||
public abstract class PushRegistryProperties {
|
||||
|
||||
/**
|
||||
* Step size (i.e. reporting frequency) to use.
|
||||
*/
|
||||
private Duration step = Duration.ofMinutes(1);
|
||||
|
||||
/**
|
||||
* Whether exporting of metrics to this backend is enabled.
|
||||
*/
|
||||
private boolean enabled = true;
|
||||
|
||||
/**
|
||||
* Connection timeout for requests to this backend.
|
||||
*/
|
||||
private Duration connectTimeout = Duration.ofSeconds(1);
|
||||
|
||||
/**
|
||||
* Read timeout for requests to this backend.
|
||||
*/
|
||||
private Duration readTimeout = Duration.ofSeconds(10);
|
||||
|
||||
/**
|
||||
* Number of threads to use with the metrics publishing scheduler.
|
||||
*/
|
||||
private Integer numThreads = 2;
|
||||
|
||||
/**
|
||||
* Number of measurements per request to use for this backend. If more measurements
|
||||
* are found, then multiple requests will be made.
|
||||
*/
|
||||
private Integer batchSize = 10000;
|
||||
|
||||
public Duration getStep() {
|
||||
return this.step;
|
||||
}
|
||||
|
||||
public void setStep(Duration step) {
|
||||
this.step = step;
|
||||
}
|
||||
|
||||
public boolean isEnabled() {
|
||||
return this.enabled;
|
||||
}
|
||||
|
||||
public void setEnabled(boolean enabled) {
|
||||
this.enabled = enabled;
|
||||
}
|
||||
|
||||
public Duration getConnectTimeout() {
|
||||
return this.connectTimeout;
|
||||
}
|
||||
|
||||
public void setConnectTimeout(Duration connectTimeout) {
|
||||
this.connectTimeout = connectTimeout;
|
||||
}
|
||||
|
||||
public Duration getReadTimeout() {
|
||||
return this.readTimeout;
|
||||
}
|
||||
|
||||
public void setReadTimeout(Duration readTimeout) {
|
||||
this.readTimeout = readTimeout;
|
||||
}
|
||||
|
||||
public Integer getNumThreads() {
|
||||
return this.numThreads;
|
||||
}
|
||||
|
||||
public void setNumThreads(Integer numThreads) {
|
||||
this.numThreads = numThreads;
|
||||
}
|
||||
|
||||
public Integer getBatchSize() {
|
||||
return this.batchSize;
|
||||
}
|
||||
|
||||
public void setBatchSize(Integer batchSize) {
|
||||
this.batchSize = batchSize;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,69 @@
|
||||
/*
|
||||
* 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.autoconfigure.metrics.export.properties;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import io.micrometer.core.instrument.push.PushRegistryConfig;
|
||||
|
||||
/**
|
||||
* Base class for {@link PushRegistryProperties} to {@link PushRegistryConfig} adapters.
|
||||
*
|
||||
* @param <T> the properties type
|
||||
* @author Jon Schneider
|
||||
* @author Phillip Webb
|
||||
* @author Artsiom Yudovin
|
||||
* @since 2.2.0
|
||||
*/
|
||||
public abstract class PushRegistryPropertiesConfigAdapter<T extends PushRegistryProperties>
|
||||
extends PropertiesConfigAdapter<T> implements PushRegistryConfig {
|
||||
|
||||
public PushRegistryPropertiesConfigAdapter(T properties) {
|
||||
super(properties);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String prefix() {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String get(String k) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Duration step() {
|
||||
return get(T::getStep, PushRegistryConfig.super::step);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean enabled() {
|
||||
return get(T::isEnabled, PushRegistryConfig.super::enabled);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int numThreads() {
|
||||
return get(T::getNumThreads, PushRegistryConfig.super::numThreads);
|
||||
}
|
||||
|
||||
@Override
|
||||
public int batchSize() {
|
||||
return get(T::getBatchSize, PushRegistryConfig.super::batchSize);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
/*
|
||||
* 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.autoconfigure.metrics.export.properties;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Base test for {@link PushRegistryPropertiesConfigAdapter} implementations.
|
||||
*
|
||||
* @param <P> properties used by the tests
|
||||
* @param <A> adapter used by the tests
|
||||
* @author Stephane Nicoll
|
||||
* @author Artsiom Yudovin
|
||||
*/
|
||||
public abstract class PushRegistryPropertiesConfigAdapterTests<P extends PushRegistryProperties, A extends PushRegistryPropertiesConfigAdapter<P>> {
|
||||
|
||||
protected abstract P createProperties();
|
||||
|
||||
protected abstract A createConfigAdapter(P properties);
|
||||
|
||||
@Test
|
||||
void whenPropertiesStepIsSetAdapterStepReturnsIt() {
|
||||
P properties = createProperties();
|
||||
properties.setStep(Duration.ofSeconds(42));
|
||||
assertThat(createConfigAdapter(properties).step()).isEqualTo(Duration.ofSeconds(42));
|
||||
}
|
||||
|
||||
@Test
|
||||
void whenPropertiesEnabledIsSetAdapterEnabledReturnsIt() {
|
||||
P properties = createProperties();
|
||||
properties.setEnabled(false);
|
||||
assertThat(createConfigAdapter(properties).enabled()).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
void whenPropertiesNumThreadsIsSetAdapterNumThreadsReturnsIt() {
|
||||
P properties = createProperties();
|
||||
properties.setNumThreads(42);
|
||||
assertThat(createConfigAdapter(properties).numThreads()).isEqualTo(42);
|
||||
}
|
||||
|
||||
@Test
|
||||
void whenPropertiesBatchSizeIsSetAdapterBatchSizeReturnsIt() {
|
||||
P properties = createProperties();
|
||||
properties.setBatchSize(10042);
|
||||
assertThat(createConfigAdapter(properties).batchSize()).isEqualTo(10042);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,40 @@
|
||||
/*
|
||||
* 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.autoconfigure.metrics.export.properties;
|
||||
|
||||
import io.micrometer.core.instrument.push.PushRegistryConfig;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Base tests for {@link PushRegistryProperties} implementation.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public abstract class PushRegistryPropertiesTests {
|
||||
|
||||
@SuppressWarnings("deprecation")
|
||||
protected void assertStepRegistryDefaultValues(PushRegistryProperties properties, PushRegistryConfig config) {
|
||||
assertThat(properties.getStep()).isEqualTo(config.step());
|
||||
assertThat(properties.isEnabled()).isEqualTo(config.enabled());
|
||||
assertThat(properties.getConnectTimeout()).isEqualTo(config.connectTimeout());
|
||||
assertThat(properties.getReadTimeout()).isEqualTo(config.readTimeout());
|
||||
assertThat(properties.getNumThreads()).isEqualTo(config.numThreads());
|
||||
assertThat(properties.getBatchSize()).isEqualTo(config.batchSize());
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue