org.elasticsearch.threadpool.AutoQueueAdjustingExecutorBuilder Maven / Gradle / Ivy
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.threadpool;
import org.elasticsearch.common.settings.Setting;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.unit.SizeValue;
import org.elasticsearch.common.util.concurrent.EsExecutors;
import org.elasticsearch.common.util.concurrent.ThreadContext;
import org.elasticsearch.core.TimeValue;
import org.elasticsearch.node.Node;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ThreadFactory;
/**
* A builder for executors that automatically adjust the queue length as needed, depending on
* Little's Law. See https://en.wikipedia.org/wiki/Little's_law for more information.
*/
public final class AutoQueueAdjustingExecutorBuilder extends ExecutorBuilder {
private final Setting sizeSetting;
private final Setting queueSizeSetting;
private final Setting minQueueSizeSetting;
private final Setting maxQueueSizeSetting;
private final Setting targetedResponseTimeSetting;
private final Setting frameSizeSetting;
AutoQueueAdjustingExecutorBuilder(
final Settings settings,
final String name,
final int size,
final int initialQueueSize,
final int minQueueSize,
final int maxQueueSize,
final int frameSize
) {
super(name);
final String prefix = "thread_pool." + name;
final String sizeKey = settingsKey(prefix, "size");
this.sizeSetting = new Setting<>(
sizeKey,
s -> Integer.toString(size),
s -> Setting.parseInt(s, 1, applyHardSizeLimit(settings, name), sizeKey),
Setting.Property.NodeScope
);
final String queueSizeKey = settingsKey(prefix, "queue_size");
final String minSizeKey = settingsKey(prefix, "min_queue_size");
final String maxSizeKey = settingsKey(prefix, "max_queue_size");
final String frameSizeKey = settingsKey(prefix, "auto_queue_frame_size");
final String targetedResponseTimeKey = settingsKey(prefix, "target_response_time");
this.targetedResponseTimeSetting = Setting.timeSetting(
targetedResponseTimeKey,
TimeValue.timeValueSeconds(1),
TimeValue.timeValueMillis(10),
Setting.Property.NodeScope,
Setting.Property.Deprecated
);
this.queueSizeSetting = Setting.intSetting(queueSizeKey, initialQueueSize, Setting.Property.NodeScope);
// These temp settings are used to validate the min and max settings below
Setting tempMaxQueueSizeSetting = Setting.intSetting(
maxSizeKey,
maxQueueSize,
Setting.Property.NodeScope,
Setting.Property.Deprecated
);
Setting tempMinQueueSizeSetting = Setting.intSetting(
minSizeKey,
minQueueSize,
Setting.Property.NodeScope,
Setting.Property.Deprecated
);
this.minQueueSizeSetting = new Setting<>(
minSizeKey,
Integer.toString(minQueueSize),
s -> Setting.parseInt(s, 0, minSizeKey),
new Setting.Validator() {
@Override
public void validate(final Integer value) {
}
@Override
public void validate(final Integer value, final Map, Object> settings) {
if (value > (int) settings.get(tempMaxQueueSizeSetting)) {
throw new IllegalArgumentException(
"Failed to parse value ["
+ value
+ "] for setting ["
+ minSizeKey
+ "] must be <= "
+ settings.get(tempMaxQueueSizeSetting)
);
}
}
@Override
public Iterator> settings() {
final List> settings = Collections.singletonList(tempMaxQueueSizeSetting);
return settings.iterator();
}
},
Setting.Property.NodeScope
);
this.maxQueueSizeSetting = new Setting<>(
maxSizeKey,
Integer.toString(maxQueueSize),
s -> Setting.parseInt(s, 0, maxSizeKey),
new Setting.Validator() {
@Override
public void validate(Integer value) {
}
@Override
public void validate(final Integer value, final Map, Object> settings) {
if (value < (int) settings.get(tempMinQueueSizeSetting)) {
throw new IllegalArgumentException(
"Failed to parse value ["
+ value
+ "] for setting ["
+ minSizeKey
+ "] must be >= "
+ settings.get(tempMinQueueSizeSetting)
);
}
}
@Override
public Iterator> settings() {
final List> settings = Collections.singletonList(tempMinQueueSizeSetting);
return settings.iterator();
}
},
Setting.Property.NodeScope,
Setting.Property.Deprecated
);
this.frameSizeSetting = Setting.intSetting(
frameSizeKey,
frameSize,
100,
Setting.Property.NodeScope,
Setting.Property.Deprecated,
Setting.Property.Deprecated
);
}
@Override
public List> getRegisteredSettings() {
return Arrays.asList(
sizeSetting,
queueSizeSetting,
minQueueSizeSetting,
maxQueueSizeSetting,
frameSizeSetting,
targetedResponseTimeSetting
);
}
@Override
AutoExecutorSettings getSettings(Settings settings) {
final String nodeName = Node.NODE_NAME_SETTING.get(settings);
final int size = sizeSetting.get(settings);
final int initialQueueSize = queueSizeSetting.get(settings);
final int minQueueSize = minQueueSizeSetting.get(settings);
final int maxQueueSize = maxQueueSizeSetting.get(settings);
final int frameSize = frameSizeSetting.get(settings);
final TimeValue targetedResponseTime = targetedResponseTimeSetting.get(settings);
return new AutoExecutorSettings(nodeName, size, initialQueueSize, minQueueSize, maxQueueSize, frameSize, targetedResponseTime);
}
@Override
ThreadPool.ExecutorHolder build(final AutoExecutorSettings settings, final ThreadContext threadContext) {
int size = settings.size;
int initialQueueSize = settings.initialQueueSize;
int minQueueSize = settings.minQueueSize;
int maxQueueSize = settings.maxQueueSize;
int frameSize = settings.frameSize;
TimeValue targetedResponseTime = settings.targetedResponseTime;
final ThreadFactory threadFactory = EsExecutors.daemonThreadFactory(EsExecutors.threadName(settings.nodeName, name()));
final ExecutorService executor = EsExecutors.newAutoQueueFixed(
settings.nodeName + "/" + name(),
size,
initialQueueSize,
minQueueSize,
maxQueueSize,
frameSize,
targetedResponseTime,
threadFactory,
threadContext
);
// TODO: in a subsequent change we hope to extend ThreadPool.Info to be more specific for the thread pool type
final ThreadPool.Info info = new ThreadPool.Info(
name(),
ThreadPool.ThreadPoolType.FIXED_AUTO_QUEUE_SIZE,
size,
size,
null,
new SizeValue(initialQueueSize)
);
return new ThreadPool.ExecutorHolder(executor, info);
}
@Override
String formatInfo(ThreadPool.Info info) {
return String.format(
Locale.ROOT,
"name [%s], size [%d], queue size [%s]",
info.getName(),
info.getMax(),
info.getQueueSize() == null ? "unbounded" : info.getQueueSize()
);
}
static final class AutoExecutorSettings extends ExecutorBuilder.ExecutorSettings {
final int size;
final int initialQueueSize;
final int minQueueSize;
final int maxQueueSize;
final int frameSize;
final TimeValue targetedResponseTime;
AutoExecutorSettings(
final String nodeName,
final int size,
final int initialQueueSize,
final int minQueueSize,
final int maxQueueSize,
final int frameSize,
final TimeValue targetedResponseTime
) {
super(nodeName);
this.size = size;
this.initialQueueSize = initialQueueSize;
this.minQueueSize = minQueueSize;
this.maxQueueSize = maxQueueSize;
this.frameSize = frameSize;
this.targetedResponseTime = targetedResponseTime;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy