root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Make TaskExecution and TaskScheduling metrics unique 

Fixes gh-28536
This commit is contained in:
Scott Frederick 2021-11-10 16:49:35 -06:00
parent a1e7375fc0
commit d7f8931dd4
2 changed files with 20 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/task/TaskExecutorMetricsAutoConfiguration.java
View File

@ -19,7 +19,6 @@ package org.springframework.boot.actuate.autoconfigure.metrics.task;
import java.util.Map;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.function.Supplier;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.binder.jvm.ExecutorServiceMetrics;
@ -36,7 +35,6 @@ import org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfigurati
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.util.StringUtils;
/**
* {@link EnableAutoConfiguration Auto-configuration} for metrics on all available
@ -44,6 +42,7 @@ import org.springframework.util.StringUtils;
* schedulers}.
*
* @author Stephane Nicoll
* @author Scott Frederick
* @since 2.6.0
*/
@Configuration(proxyBeanMethods = false)
@ -53,27 +52,21 @@ import org.springframework.util.StringUtils;
@ConditionalOnBean({ Executor.class, MeterRegistry.class })
public class TaskExecutorMetricsAutoConfiguration {
private static final String TASK_EXECUTOR_SUFFIX = "taskExecutor";
private static final String TASK_SCHEDULER_SUFFIX = "taskScheduler";
@Autowired
public void bindTaskExecutorsToRegistry(Map<String, Executor> executors, MeterRegistry registry) {
executors.forEach((beanName, executor) -> {
if (executor instanceof ThreadPoolTaskExecutor) {
monitor(registry, safeGetThreadPoolExecutor((ThreadPoolTaskExecutor) executor),
() -> getTaskExecutorName(beanName));
monitor(registry, safeGetThreadPoolExecutor((ThreadPoolTaskExecutor) executor), beanName);
}
else if (executor instanceof ThreadPoolTaskScheduler) {
monitor(registry, safeGetThreadPoolExecutor((ThreadPoolTaskScheduler) executor),
() -> getTaskSchedulerName(beanName));
monitor(registry, safeGetThreadPoolExecutor((ThreadPoolTaskScheduler) executor), beanName);
}
});
}
private void monitor(MeterRegistry registry, ThreadPoolExecutor threadPoolExecutor, Supplier<String> beanName) {
private void monitor(MeterRegistry registry, ThreadPoolExecutor threadPoolExecutor, String name) {
if (threadPoolExecutor != null) {
ExecutorServiceMetrics.monitor(registry, threadPoolExecutor, beanName.get());
ExecutorServiceMetrics.monitor(registry, threadPoolExecutor, name);
}
}
@ -95,33 +88,4 @@ public class TaskExecutorMetricsAutoConfiguration {
}
}
/**
* Get the name of a {@link ThreadPoolTaskExecutor} based on its {@code beanName}.
* @param beanName the name of the {@link ThreadPoolTaskExecutor} bean
* @return a name for the given task executor
*/
private String getTaskExecutorName(String beanName) {
if (beanName.length() > TASK_EXECUTOR_SUFFIX.length()
&& StringUtils.endsWithIgnoreCase(beanName, TASK_EXECUTOR_SUFFIX)) {
return beanName.substring(0, beanName.length() - TASK_EXECUTOR_SUFFIX.length());
}
return beanName;
}
/**
* Get the name of a {@link ThreadPoolTaskScheduler} based on its {@code beanName}.
* @param beanName the name of the {@link ThreadPoolTaskScheduler} bean
* @return a name for the given task scheduler
*/
private String getTaskSchedulerName(String beanName) {
if (beanName.equals(TASK_SCHEDULER_SUFFIX)) {
return "application";
}
if (beanName.length() > TASK_SCHEDULER_SUFFIX.length()
&& StringUtils.endsWithIgnoreCase(beanName, TASK_SCHEDULER_SUFFIX)) {
return beanName.substring(0, beanName.length() - TASK_SCHEDULER_SUFFIX.length());
}
return beanName;
}
}

29
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/task/TaskExecutorMetricsAutoConfigurationTests.java
View File

@ -41,6 +41,7 @@ import static org.mockito.Mockito.mock;
* Tests for {@link TaskExecutorMetricsAutoConfiguration}.
*
* @author Stephane Nicoll
* @author Scott Frederick
*/
class TaskExecutorMetricsAutoConfigurationTests {
@ -53,8 +54,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
.run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).singleElement()
.satisfies((meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("application"));
assertThat(meters).singleElement().satisfies(
(meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("applicationTaskExecutor"));
});
}
@ -64,8 +65,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
.withBean("customName", ThreadPoolTaskExecutor.class, ThreadPoolTaskExecutor::new).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).map((meter) -> meter.getId().getTag("name")).containsExactlyInAnyOrder("first",
"customName");
assertThat(meters).map((meter) -> meter.getId().getTag("name"))
.containsExactlyInAnyOrder("firstTaskExecutor", "customName");
});
}
@ -77,8 +78,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
.withBean("customName", ThreadPoolTaskExecutor.class, () -> unavailableTaskExecutor).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).singleElement()
.satisfies((meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("first"));
assertThat(meters).singleElement().satisfies(
(meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("firstTaskExecutor"));
});
}
@ -87,8 +88,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
this.contextRunner.withPropertyValues("management.metrics.enable.executor=false")
.withConfiguration(AutoConfigurations.of(TaskExecutionAutoConfiguration.class)).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
assertThat(registry.find("executor.completed").tags("name", "application").functionCounter())
.isNull();
assertThat(registry.find("executor.completed").tags("name", "applicationTaskExecutor")
.functionCounter()).isNull();
});
}
@ -99,7 +100,7 @@ class TaskExecutorMetricsAutoConfigurationTests {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).singleElement()
.satisfies((meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("application"));
.satisfies((meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("taskScheduler"));
});
}
@ -109,8 +110,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
.withBean("customName", ThreadPoolTaskScheduler.class, ThreadPoolTaskScheduler::new).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).map((meter) -> meter.getId().getTag("name")).containsExactlyInAnyOrder("first",
"customName");
assertThat(meters).map((meter) -> meter.getId().getTag("name"))
.containsExactlyInAnyOrder("firstTaskScheduler", "customName");
});
}
@ -122,8 +123,8 @@ class TaskExecutorMetricsAutoConfigurationTests {
.withBean("customName", ThreadPoolTaskScheduler.class, () -> unavailableTaskExecutor).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
Collection<FunctionCounter> meters = registry.get("executor.completed").functionCounters();
assertThat(meters).singleElement()
.satisfies((meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("first"));
assertThat(meters).singleElement().satisfies(
(meter) -> assertThat(meter.getId().getTag("name")).isEqualTo("firstTaskScheduler"));
});
}
@ -133,7 +134,7 @@ class TaskExecutorMetricsAutoConfigurationTests {
.withConfiguration(AutoConfigurations.of(TaskSchedulingAutoConfiguration.class))
.withUserConfiguration(SchedulingTestConfiguration.class).run((context) -> {
MeterRegistry registry = context.getBean(MeterRegistry.class);
assertThat(registry.find("executor.completed").tags("name", "application").functionCounter())
assertThat(registry.find("executor.completed").tags("name", "taskScheduler").functionCounter())
.isNull();
});
}