Skip to content

Commit

Permalink
Fixes for tests
Browse files Browse the repository at this point in the history 
Signed-off-by: Ajay Kumar Movva <[email protected]>
  • Loading branch information
@bharath-techie
bharath-techie authored and Ajay Kumar Movva committed Oct 24, 2023
1 parent b095493 commit fbbf4e8
Show file tree
Hide file tree
Showing 15 changed files with 347 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .../src/main/java/org/opensearch/ratelimitting/admissioncontrol/AdmissionControlService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import static org.opensearch.ratelimitting.admissioncontrol.settings.CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER;
import static org.opensearch.ratelimitting.admissioncontrol.controllers.CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER;

/**
* Admission control Service that bootstraps and manages all the Admission Controllers in OpenSearch.
Expand Down
4 changes: 1 addition & 3 deletions ...n/java/org/opensearch/ratelimitting/admissioncontrol/controllers/AdmissionController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,14 @@ public abstract class AdmissionController {
/**
* @param admissionControllerName name of the admissionController
* @param resourceUsageCollectorService instance used to get resource usage stats of the node
* @param rejectionCount initialised rejectionCount value for AdmissionController
* @param clusterService
*/
public AdmissionController(
String admissionControllerName,
ResourceUsageCollectorService resourceUsageCollectorService,
AtomicLong rejectionCount,
ClusterService clusterService
) {
this.rejectionCount = rejectionCount;
this.rejectionCount = new AtomicLong(0);
this.admissionControllerName = admissionControllerName;
this.resourceUsageCollectorService = resourceUsageCollectorService;
this.clusterService = clusterService;
Expand Down
4 changes: 2 additions & 2 deletions ...rg/opensearch/ratelimitting/admissioncontrol/controllers/CPUBasedAdmissionController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
import org.opensearch.ratelimitting.admissioncontrol.settings.CPUBasedAdmissionControllerSettings;

import java.util.Optional;
import java.util.concurrent.atomic.AtomicLong;

/**
* Class for CPU Based Admission Controller in OpenSearch, which aims to provide CPU utilisation admission control.
* It provides methods to apply admission control if configured limit has been reached
*/
public class CPUBasedAdmissionController extends AdmissionController {
public static final String CPU_BASED_ADMISSION_CONTROLLER = "global_cpu_usage";
private static final Logger LOGGER = LogManager.getLogger(CPUBasedAdmissionController.class);
public CPUBasedAdmissionControllerSettings settings;

Expand All @@ -41,7 +41,7 @@ public CPUBasedAdmissionController(
ClusterService clusterService,
Settings settings
) {
super(admissionControllerName, resourceUsageCollectorService, new AtomicLong(0), clusterService);
super(admissionControllerName, resourceUsageCollectorService, clusterService);
this.settings = new CPUBasedAdmissionControllerSettings(clusterService.getClusterSettings(), settings);
}

Expand Down
1 change: 0 additions & 1 deletion ...ensearch/ratelimitting/admissioncontrol/settings/CPUBasedAdmissionControllerSettings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
* @opensearch.internal
*/
public class CPUBasedAdmissionControllerSettings {
public static final String CPU_BASED_ADMISSION_CONTROLLER = "global_cpu_usage";

/**
* Default parameters for the CPUBasedAdmissionControllerSettings
Expand Down
8 changes: 6 additions & 2 deletions .../main/java/org/opensearch/ratelimitting/admissioncontrol/stats/AdmissionControlStats.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public AdmissionControlStats(List<AdmissionControllerStats> admissionControllerS
* @throws IOException if an I/O error occurs
*/
public AdmissionControlStats(StreamInput in) throws IOException {
this.admissionControllerStatsList = in.readNamedWriteableList(AdmissionControllerStats.class);
this.admissionControllerStatsList = in.readList(AdmissionControllerStats::new);
}

/**
Expand All @@ -51,6 +51,10 @@ public void writeTo(StreamOutput out) throws IOException {
out.writeList(this.admissionControllerStatsList);
}

public List<AdmissionControllerStats> getAdmissionControllerStatsList() {
return admissionControllerStatsList;
}

/**
* @param builder
* @param params
Expand All @@ -62,7 +66,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
builder.startObject("admission_control");
this.admissionControllerStatsList.forEach(stats -> {
try {
builder.field(stats.getWriteableName(), stats);
builder.field(stats.getAdmissionControllerName(), stats);
} catch (IOException e) {
throw new RuntimeException(e);
}
Expand Down
11 changes: 7 additions & 4 deletions ...in/java/org/opensearch/ratelimitting/admissioncontrol/stats/AdmissionControllerStats.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

package org.opensearch.ratelimitting.admissioncontrol.stats;

import org.opensearch.core.common.io.stream.NamedWriteable;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.common.io.stream.Writeable;
import org.opensearch.core.xcontent.ToXContentFragment;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.ratelimitting.admissioncontrol.controllers.AdmissionController;
Expand All @@ -21,7 +21,7 @@
/**
* Class for admission controller ( such as CPU ) stats which includes rejection count for each action type
*/
public class AdmissionControllerStats implements NamedWriteable, ToXContentFragment {
public class AdmissionControllerStats implements Writeable, ToXContentFragment {
public Map<String, Long> rejectionCount;
public String admissionControllerName;

Expand All @@ -35,11 +35,14 @@ public AdmissionControllerStats(StreamInput in) throws IOException {
this.admissionControllerName = in.readString();
}

@Override
public String getWriteableName() {
public String getAdmissionControllerName() {
return admissionControllerName;
}

public Map<String, Long> getRejectionCount() {
return rejectionCount;
}

/**
* Write this into the {@linkplain StreamOutput}.
*
Expand Down
12 changes: 12 additions & 0 deletions server/src/main/java/org/opensearch/ratelimitting/admissioncontrol/stats/package-info.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/*
* 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.
*/

/**
* This package contains stats related classes for the admissionController Feature
*/
package org.opensearch.ratelimitting.admissioncontrol.stats;
64 changes: 61 additions & 3 deletions server/src/test/java/org/opensearch/action/admin/cluster/node/stats/NodeStatsTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@
import org.opensearch.node.NodeResourceUsageStats;
import org.opensearch.node.NodesResourceUsageStats;
import org.opensearch.node.ResponseCollectorService;
import org.opensearch.ratelimitting.admissioncontrol.controllers.AdmissionController;
import org.opensearch.ratelimitting.admissioncontrol.controllers.CPUBasedAdmissionController;
import org.opensearch.ratelimitting.admissioncontrol.enums.AdmissionControlActionType;
import org.opensearch.ratelimitting.admissioncontrol.stats.AdmissionControlStats;
import org.opensearch.ratelimitting.admissioncontrol.stats.AdmissionControllerStats;
import org.opensearch.script.ScriptCacheStats;
import org.opensearch.script.ScriptStats;
import org.opensearch.test.OpenSearchTestCase;
Expand Down Expand Up @@ -539,15 +544,44 @@ public void testSerialization() throws IOException {
assertEquals(replicationStats.getTotalBytesBehind(), deserializedReplicationStats.getTotalBytesBehind());
assertEquals(replicationStats.getMaxReplicationLag(), deserializedReplicationStats.getMaxReplicationLag());
}
AdmissionControlStats admissionControlStats = nodeStats.getAdmissionControlStats();
AdmissionControlStats deserializedAdmissionControlStats = deserializedNodeStats.getAdmissionControlStats();
if (admissionControlStats == null) {
assertNull(deserializedAdmissionControlStats);
} else {
assertEquals(
admissionControlStats.getAdmissionControllerStatsList().size(),
deserializedAdmissionControlStats.getAdmissionControllerStatsList().size()
);
AdmissionControllerStats admissionControllerStats = admissionControlStats.getAdmissionControllerStatsList().get(0);
AdmissionControllerStats deserializedAdmissionControllerStats = deserializedAdmissionControlStats
.getAdmissionControllerStatsList()
.get(0);
assertEquals(
admissionControllerStats.getAdmissionControllerName(),
deserializedAdmissionControllerStats.getAdmissionControllerName()
);
assertEquals(1, (long) admissionControllerStats.getRejectionCount().get(AdmissionControlActionType.SEARCH.getType()));
assertEquals(
admissionControllerStats.getRejectionCount().get(AdmissionControlActionType.SEARCH.getType()),
deserializedAdmissionControllerStats.getRejectionCount().get(AdmissionControlActionType.SEARCH.getType())
);

assertEquals(2, (long) admissionControllerStats.getRejectionCount().get(AdmissionControlActionType.INDEXING.getType()));
assertEquals(
admissionControllerStats.getRejectionCount().get(AdmissionControlActionType.INDEXING.getType()),
deserializedAdmissionControllerStats.getRejectionCount().get(AdmissionControlActionType.INDEXING.getType())
);
}
}
}
}

public static NodeStats createNodeStats() {
public static NodeStats createNodeStats() throws IOException {
return createNodeStats(false);
}

public static NodeStats createNodeStats(boolean remoteStoreStats) {
public static NodeStats createNodeStats(boolean remoteStoreStats) throws IOException {
DiscoveryNode node = new DiscoveryNode(
"test_node",
buildNewFakeTransportAddress(),
Expand Down Expand Up @@ -861,6 +895,29 @@ public static NodeStats createNodeStats(boolean remoteStoreStats) {
clusterManagerThrottlingStats = new ClusterManagerThrottlingStats();
clusterManagerThrottlingStats.onThrottle("test-task", randomInt());
}

AdmissionControlStats admissionControlStats = null;
if (frequently()) {
AdmissionController admissionController = new AdmissionController(
CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER,
null,
null
) {
@Override
public void apply(String action, AdmissionControlActionType admissionControlActionType) {
return;
}
};
admissionController.addRejectionCount(AdmissionControlActionType.SEARCH.getType(), 1);
admissionController.addRejectionCount(AdmissionControlActionType.INDEXING.getType(), 2);
AdmissionControllerStats stats = new AdmissionControllerStats(
admissionController,
CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER
);
List<AdmissionControllerStats> statsList = new ArrayList();
statsList.add(stats);
admissionControlStats = new AdmissionControlStats(statsList);
}
ScriptCacheStats scriptCacheStats = scriptStats != null ? scriptStats.toScriptCacheStats() : null;

WeightedRoutingStats weightedRoutingStats = null;
Expand Down Expand Up @@ -898,7 +955,8 @@ public static NodeStats createNodeStats(boolean remoteStoreStats) {
null,
null,
segmentReplicationRejectionStats,
null
null,
admissionControlStats
);
}

Expand Down
9 changes: 8 additions & 1 deletion server/src/test/java/org/opensearch/action/admin/cluster/stats/ClusterStatsNodesTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import org.opensearch.core.xcontent.MediaTypeRegistry;
import org.opensearch.test.OpenSearchTestCase;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
Expand Down Expand Up @@ -87,7 +88,13 @@ public void testNetworkTypesToXContent() throws Exception {
}

public void testIngestStats() throws Exception {
NodeStats nodeStats = randomValueOtherThanMany(n -> n.getIngestStats() == null, NodeStatsTests::createNodeStats);
NodeStats nodeStats = randomValueOtherThanMany(n -> n.getIngestStats() == null, () -> {
try {
return NodeStatsTests.createNodeStats();
} catch (IOException e) {
throw new RuntimeException(e);
}
});

SortedMap<String, long[]> processorStats = new TreeMap<>();
nodeStats.getIngestStats().getProcessorStats().values().forEach(stats -> {
Expand Down
6 changes: 6 additions & 0 deletions server/src/test/java/org/opensearch/cluster/DiskUsageTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ public void testFillDiskUsage() {
null,
null,
null,
null,
null
),
new NodeStats(
Expand Down Expand Up @@ -222,6 +223,7 @@ public void testFillDiskUsage() {
null,
null,
null,
null,
null
),
new NodeStats(
Expand Down Expand Up @@ -251,6 +253,7 @@ public void testFillDiskUsage() {
null,
null,
null,
null,
null
)
);
Expand Down Expand Up @@ -311,6 +314,7 @@ public void testFillDiskUsageSomeInvalidValues() {
null,
null,
null,
null,
null
),
new NodeStats(
Expand Down Expand Up @@ -340,6 +344,7 @@ public void testFillDiskUsageSomeInvalidValues() {
null,
null,
null,
null,
null
),
new NodeStats(
Expand Down Expand Up @@ -369,6 +374,7 @@ public void testFillDiskUsageSomeInvalidValues() {
null,
null,
null,
null,
null
)
);
Expand Down
25 changes: 20 additions & 5 deletions ...test/java/org/opensearch/ratelimitting/admissioncontrol/AdmissionControlServiceTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public void testAdmissionControllerSettings() {
List<AdmissionController> admissionControllerList = admissionControlService.getAdmissionControllers();
assertEquals(admissionControllerList.size(), 1);
CPUBasedAdmissionController cpuBasedAdmissionController = (CPUBasedAdmissionController) admissionControlService
.getAdmissionController(CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER);
.getAdmissionController(CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER);
assertEquals(
admissionControlSettings.isTransportLayerAdmissionControlEnabled(),
cpuBasedAdmissionController.isEnabledForTransportLayer(
Expand Down Expand Up @@ -119,7 +119,7 @@ public void testApplyAdmissionControllerEnabled() {
admissionControlService = new AdmissionControlService(Settings.EMPTY, clusterService, threadPool, null);
admissionControlService.applyTransportAdmissionControl(this.action, null);
assertEquals(
admissionControlService.getAdmissionController(CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER)
admissionControlService.getAdmissionController(CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER)
.getRejectionCount(AdmissionControlActionType.INDEXING.getType()),
0
);
Expand All @@ -131,13 +131,28 @@ public void testApplyAdmissionControllerEnabled() {
)
.build();
clusterService.getClusterSettings().applySettings(settings);
admissionControlService.applyTransportAdmissionControl(this.action, null);
List<AdmissionController> admissionControllerList = admissionControlService.getAdmissionControllers();
assertEquals(admissionControllerList.size(), 1);
}

public void testApplyAdmissionControllerEnforced() {
this.action = "indices:data/write/bulk[s][p]";
admissionControlService = new AdmissionControlService(Settings.EMPTY, clusterService, threadPool, null);
admissionControlService.applyTransportAdmissionControl(this.action, null);
assertEquals(
admissionControlService.getAdmissionController(CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER)
admissionControlService.getAdmissionController(CPUBasedAdmissionController.CPU_BASED_ADMISSION_CONTROLLER)
.getRejectionCount(AdmissionControlActionType.INDEXING.getType()),
1
0
);

Settings settings = Settings.builder()
.put(
CPUBasedAdmissionControllerSettings.CPU_BASED_ADMISSION_CONTROLLER_TRANSPORT_LAYER_MODE.getKey(),
AdmissionControlMode.MONITOR.getMode()
)
.build();
clusterService.getClusterSettings().applySettings(settings);
List<AdmissionController> admissionControllerList = admissionControlService.getAdmissionControllers();
assertEquals(admissionControllerList.size(), 1);
}
}
Loading

0 comments on commit fbbf4e8

Please sign in to comment.