Skip to content

Expose ForkJoinPool parallelism and pool size metrics #5236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 4, 2024
Merged

Expose ForkJoinPool parallelism and pool size metrics #5236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6741c4
Expose ForkJoinPool::getParallelism as a metric
genuss Jun 28, 2024
1ee9a99
Add pool size metric and a test
genuss Jul 1, 2024
7455ff8
Use the same description for equally named metrics. Add units
genuss Jul 2, 2024
4000d2f
Review fixes
genuss Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion ...r-core/src/main/java/io/micrometer/core/instrument/binder/jvm/ExecutorServiceMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ public class ExecutorServiceMetrics implements MeterBinder {

private static final String DEFAULT_EXECUTOR_METRIC_PREFIX = "";

private static final String DESCRIPTION_POOL_SIZE = "The current number of threads in the pool";

@Nullable
private final ExecutorService executorService;

Expand Down Expand Up @@ -362,7 +364,7 @@ private void monitor(MeterRegistry registry, @Nullable ThreadPoolExecutor tp) {

Gauge.builder(metricPrefix + "executor.pool.size", tp, ThreadPoolExecutor::getPoolSize)
.tags(tags)
.description("The current number of threads in the pool")
.description(DESCRIPTION_POOL_SIZE)
.baseUnit(BaseUnits.THREADS)
.register(registry);

Expand Down Expand Up @@ -402,6 +404,18 @@ private void monitor(MeterRegistry registry, ForkJoinPool fj) {
.description(
"An estimate of the number of worker threads that are not blocked waiting to join tasks or for other managed synchronization threads")
.register(registry);

Gauge.builder(metricPrefix + "executor.parallelism", fj, ForkJoinPool::getParallelism)
.tags(tags)
.description("The targeted parallelism level of this pool")
.baseUnit(BaseUnits.THREADS)
.register(registry);

Gauge.builder(metricPrefix + "executor.pool.size", fj, ForkJoinPool::getPoolSize)
.tags(tags)
.description(DESCRIPTION_POOL_SIZE)
.baseUnit(BaseUnits.THREADS)
.register(registry);
}

/**
Expand Down
13 changes: 13 additions & 0 deletions ...re/src/test/java/io/micrometer/core/instrument/binder/jvm/ExecutorServiceMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,19 @@ void monitorExecutorsExecutorServicePrivateClass() {
.doesNotThrowAnyException();
}

@DisplayName("ForkJoinPool is assigned with its own set of metrics")
@ParameterizedTest
@CsvSource({ "custom,custom.", "custom.,custom.", ",''", "' ',''" })
void forkJoinPool(String metricPrefix, String expectedMetricPrefix) {
var fjp = new ForkJoinPool(1);
monitorExecutorService("fjp", metricPrefix, fjp);
registry.get(expectedMetricPrefix + "executor.steals").tags(userTags).tag("name", "fjp").functionCounter();
registry.get(expectedMetricPrefix + "executor.queued").tags(userTags).tag("name", "fjp").gauge();
registry.get(expectedMetricPrefix + "executor.running").tags(userTags).tag("name", "fjp").gauge();
registry.get(expectedMetricPrefix + "executor.parallelism").tags(userTags).tag("name", "fjp").gauge();
registry.get(expectedMetricPrefix + "executor.pool.size").tags(userTags).tag("name", "fjp").gauge();
}

@DisplayName("ScheduledExecutorService can be monitored with a default set of metrics")
@ParameterizedTest
@CsvSource({ "custom,custom.", "custom.,custom.", ",''", "' ',''" })
Expand Down