forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Settings related to Workload Management feature (opensearch-proje…
…ct#15028) Signed-off-by: Ruirui Zhang <[email protected]> * add QeryGroup Service tests Signed-off-by: Ruirui Zhang <[email protected]> * add PR to changelog Signed-off-by: Ruirui Zhang <[email protected]> * change the test directory Signed-off-by: Ruirui Zhang <[email protected]> * modify comments to be more specific Signed-off-by: Ruirui Zhang <[email protected]> * add test coverage Signed-off-by: Ruirui Zhang <[email protected]> * remove QUERY_GROUP_RUN_INTERVAL_SETTING as we'll define it in QueryGroupService Signed-off-by: Ruirui Zhang <[email protected]> * address comments Signed-off-by: Ruirui Zhang <[email protected]> (cherry picked from commit 01184de)
- Loading branch information
Showing
4 changed files
with
506 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
256 changes: 256 additions & 0 deletions
256
server/src/main/java/org/opensearch/wlm/WorkloadManagementSettings.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,256 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.wlm; | ||
|
|
||
| import org.opensearch.common.settings.ClusterSettings; | ||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.settings.Settings; | ||
|
|
||
| /** | ||
| * Main class to declare Workload Management related settings | ||
| */ | ||
| public class WorkloadManagementSettings { | ||
| private static final Double DEFAULT_NODE_LEVEL_MEMORY_REJECTION_THRESHOLD = 0.8; | ||
| private static final Double DEFAULT_NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD = 0.9; | ||
| private static final Double DEFAULT_NODE_LEVEL_CPU_REJECTION_THRESHOLD = 0.8; | ||
| private static final Double DEFAULT_NODE_LEVEL_CPU_CANCELLATION_THRESHOLD = 0.9; | ||
| public static final double NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD_MAX_VALUE = 0.95; | ||
| public static final double NODE_LEVEL_MEMORY_REJECTION_THRESHOLD_MAX_VALUE = 0.9; | ||
| public static final double NODE_LEVEL_CPU_CANCELLATION_THRESHOLD_MAX_VALUE = 0.95; | ||
| public static final double NODE_LEVEL_CPU_REJECTION_THRESHOLD_MAX_VALUE = 0.9; | ||
|
|
||
| private Double nodeLevelMemoryCancellationThreshold; | ||
| private Double nodeLevelMemoryRejectionThreshold; | ||
| private Double nodeLevelCpuCancellationThreshold; | ||
| private Double nodeLevelCpuRejectionThreshold; | ||
|
|
||
| /** | ||
| * Setting name for node level memory based rejection threshold for QueryGroup service | ||
| */ | ||
| public static final String NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME = "wlm.query_group.node.memory_rejection_threshold"; | ||
| /** | ||
| * Setting to control the memory based rejection threshold | ||
| */ | ||
| public static final Setting<Double> NODE_LEVEL_MEMORY_REJECTION_THRESHOLD = Setting.doubleSetting( | ||
| NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME, | ||
| DEFAULT_NODE_LEVEL_MEMORY_REJECTION_THRESHOLD, | ||
| Setting.Property.Dynamic, | ||
| Setting.Property.NodeScope | ||
| ); | ||
| /** | ||
| * Setting name for node level cpu based rejection threshold for QueryGroup service | ||
| */ | ||
| public static final String NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME = "wlm.query_group.node.cpu_rejection_threshold"; | ||
| /** | ||
| * Setting to control the cpu based rejection threshold | ||
| */ | ||
| public static final Setting<Double> NODE_LEVEL_CPU_REJECTION_THRESHOLD = Setting.doubleSetting( | ||
| NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME, | ||
| DEFAULT_NODE_LEVEL_CPU_REJECTION_THRESHOLD, | ||
| Setting.Property.Dynamic, | ||
| Setting.Property.NodeScope | ||
| ); | ||
| /** | ||
| * Setting name for node level memory based cancellation threshold for QueryGroup service | ||
| */ | ||
| public static final String NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME = "wlm.query_group.node.memory_cancellation_threshold"; | ||
| /** | ||
| * Setting to control the memory based cancellation threshold | ||
| */ | ||
| public static final Setting<Double> NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD = Setting.doubleSetting( | ||
| NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME, | ||
| DEFAULT_NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD, | ||
| Setting.Property.Dynamic, | ||
| Setting.Property.NodeScope | ||
| ); | ||
| /** | ||
| * Setting name for node level cpu based cancellation threshold for QueryGroup service | ||
| */ | ||
| public static final String NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME = "wlm.query_group.node.cpu_cancellation_threshold"; | ||
| /** | ||
| * Setting to control the cpu based cancellation threshold | ||
| */ | ||
| public static final Setting<Double> NODE_LEVEL_CPU_CANCELLATION_THRESHOLD = Setting.doubleSetting( | ||
| NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME, | ||
| DEFAULT_NODE_LEVEL_CPU_CANCELLATION_THRESHOLD, | ||
| Setting.Property.Dynamic, | ||
| Setting.Property.NodeScope | ||
| ); | ||
|
|
||
| /** | ||
| * QueryGroup service settings constructor | ||
| * @param settings - QueryGroup service settings | ||
| * @param clusterSettings - QueryGroup cluster settings | ||
| */ | ||
| public WorkloadManagementSettings(Settings settings, ClusterSettings clusterSettings) { | ||
| nodeLevelMemoryCancellationThreshold = NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD.get(settings); | ||
| nodeLevelMemoryRejectionThreshold = NODE_LEVEL_MEMORY_REJECTION_THRESHOLD.get(settings); | ||
| nodeLevelCpuCancellationThreshold = NODE_LEVEL_CPU_CANCELLATION_THRESHOLD.get(settings); | ||
| nodeLevelCpuRejectionThreshold = NODE_LEVEL_CPU_REJECTION_THRESHOLD.get(settings); | ||
|
|
||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelMemoryRejectionThreshold, | ||
| nodeLevelMemoryCancellationThreshold, | ||
| NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelCpuRejectionThreshold, | ||
| nodeLevelCpuCancellationThreshold, | ||
| NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
|
|
||
| clusterSettings.addSettingsUpdateConsumer(NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD, this::setNodeLevelMemoryCancellationThreshold); | ||
| clusterSettings.addSettingsUpdateConsumer(NODE_LEVEL_MEMORY_REJECTION_THRESHOLD, this::setNodeLevelMemoryRejectionThreshold); | ||
| clusterSettings.addSettingsUpdateConsumer(NODE_LEVEL_CPU_CANCELLATION_THRESHOLD, this::setNodeLevelCpuCancellationThreshold); | ||
| clusterSettings.addSettingsUpdateConsumer(NODE_LEVEL_CPU_REJECTION_THRESHOLD, this::setNodeLevelCpuRejectionThreshold); | ||
| } | ||
|
|
||
| /** | ||
| * Method to get the node level memory based cancellation threshold | ||
| * @return current node level memory based cancellation threshold | ||
| */ | ||
| public Double getNodeLevelMemoryCancellationThreshold() { | ||
| return nodeLevelMemoryCancellationThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to set the node level memory based cancellation threshold | ||
| * @param nodeLevelMemoryCancellationThreshold sets the new node level memory based cancellation threshold | ||
| * @throws IllegalArgumentException if the value is > 0.95 and cancellation < rejection threshold | ||
| */ | ||
| public void setNodeLevelMemoryCancellationThreshold(Double nodeLevelMemoryCancellationThreshold) { | ||
| if (Double.compare(nodeLevelMemoryCancellationThreshold, NODE_LEVEL_MEMORY_CANCELLATION_THRESHOLD_MAX_VALUE) > 0) { | ||
| throw new IllegalArgumentException( | ||
| NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME + " value cannot be greater than 0.95 as it can result in a node drop" | ||
| ); | ||
| } | ||
|
|
||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelMemoryRejectionThreshold, | ||
| nodeLevelMemoryCancellationThreshold, | ||
| NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
|
|
||
| this.nodeLevelMemoryCancellationThreshold = nodeLevelMemoryCancellationThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to get the node level cpu based cancellation threshold | ||
| * @return current node level cpu based cancellation threshold | ||
| */ | ||
| public Double getNodeLevelCpuCancellationThreshold() { | ||
| return nodeLevelCpuCancellationThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to set the node level cpu based cancellation threshold | ||
| * @param nodeLevelCpuCancellationThreshold sets the new node level cpu based cancellation threshold | ||
| * @throws IllegalArgumentException if the value is > 0.95 and cancellation < rejection threshold | ||
| */ | ||
| public void setNodeLevelCpuCancellationThreshold(Double nodeLevelCpuCancellationThreshold) { | ||
| if (Double.compare(nodeLevelCpuCancellationThreshold, NODE_LEVEL_CPU_CANCELLATION_THRESHOLD_MAX_VALUE) > 0) { | ||
| throw new IllegalArgumentException( | ||
| NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME + " value cannot be greater than 0.95 as it can result in a node drop" | ||
| ); | ||
| } | ||
|
|
||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelCpuRejectionThreshold, | ||
| nodeLevelCpuCancellationThreshold, | ||
| NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
|
|
||
| this.nodeLevelCpuCancellationThreshold = nodeLevelCpuCancellationThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to get the memory based node level rejection threshold | ||
| * @return the current memory based node level rejection threshold | ||
| */ | ||
| public Double getNodeLevelMemoryRejectionThreshold() { | ||
| return nodeLevelMemoryRejectionThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to set the node level memory based rejection threshold | ||
| * @param nodeLevelMemoryRejectionThreshold sets the new memory based rejection threshold | ||
| * @throws IllegalArgumentException if rejection > 0.90 and rejection < cancellation threshold | ||
| */ | ||
| public void setNodeLevelMemoryRejectionThreshold(Double nodeLevelMemoryRejectionThreshold) { | ||
| if (Double.compare(nodeLevelMemoryRejectionThreshold, NODE_LEVEL_MEMORY_REJECTION_THRESHOLD_MAX_VALUE) > 0) { | ||
| throw new IllegalArgumentException( | ||
| NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME + " value cannot be greater than 0.90 as it can result in a node drop" | ||
| ); | ||
| } | ||
|
|
||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelMemoryRejectionThreshold, | ||
| nodeLevelMemoryCancellationThreshold, | ||
| NODE_MEMORY_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_MEMORY_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
|
|
||
| this.nodeLevelMemoryRejectionThreshold = nodeLevelMemoryRejectionThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to get the cpu based node level rejection threshold | ||
| * @return the current cpu based node level rejection threshold | ||
| */ | ||
| public Double getNodeLevelCpuRejectionThreshold() { | ||
| return nodeLevelCpuRejectionThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to set the node level cpu based rejection threshold | ||
| * @param nodeLevelCpuRejectionThreshold sets the new cpu based rejection threshold | ||
| * @throws IllegalArgumentException if rejection > 0.90 and rejection < cancellation threshold | ||
| */ | ||
| public void setNodeLevelCpuRejectionThreshold(Double nodeLevelCpuRejectionThreshold) { | ||
| if (Double.compare(nodeLevelCpuRejectionThreshold, NODE_LEVEL_CPU_REJECTION_THRESHOLD_MAX_VALUE) > 0) { | ||
| throw new IllegalArgumentException( | ||
| NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME + " value cannot be greater than 0.90 as it can result in a node drop" | ||
| ); | ||
| } | ||
|
|
||
| ensureRejectionThresholdIsLessThanCancellation( | ||
| nodeLevelCpuRejectionThreshold, | ||
| nodeLevelCpuCancellationThreshold, | ||
| NODE_CPU_REJECTION_THRESHOLD_SETTING_NAME, | ||
| NODE_CPU_CANCELLATION_THRESHOLD_SETTING_NAME | ||
| ); | ||
|
|
||
| this.nodeLevelCpuRejectionThreshold = nodeLevelCpuRejectionThreshold; | ||
| } | ||
|
|
||
| /** | ||
| * Method to validate that the cancellation threshold is greater than or equal to rejection threshold | ||
| * @param nodeLevelRejectionThreshold rejection threshold to be compared | ||
| * @param nodeLevelCancellationThreshold cancellation threshold to be compared | ||
| * @param rejectionThresholdSettingName name of the rejection threshold setting | ||
| * @param cancellationThresholdSettingName name of the cancellation threshold setting | ||
| * @throws IllegalArgumentException if cancellation threshold is less than rejection threshold | ||
| */ | ||
| private void ensureRejectionThresholdIsLessThanCancellation( | ||
| Double nodeLevelRejectionThreshold, | ||
| Double nodeLevelCancellationThreshold, | ||
| String rejectionThresholdSettingName, | ||
| String cancellationThresholdSettingName | ||
| ) { | ||
| if (Double.compare(nodeLevelCancellationThreshold, nodeLevelRejectionThreshold) < 0) { | ||
| throw new IllegalArgumentException( | ||
| cancellationThresholdSettingName + " value should not be less than " + rejectionThresholdSettingName | ||
| ); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.