Search Task Resource Tracking PoC #1643
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.search.stats; | ||
|
|
||
|
|
||
| import org.opensearch.action.ActionFuture; | ||
| import org.opensearch.action.admin.indices.stats.IndicesStatsResponse; | ||
| import org.opensearch.action.admin.indices.stats.ShardStats; | ||
| import org.opensearch.action.index.IndexRequestBuilder; | ||
| import org.opensearch.action.search.SearchResponse; | ||
| import org.opensearch.cluster.metadata.IndexMetadata; | ||
| import org.opensearch.cluster.routing.ShardRouting; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.test.OpenSearchIntegTestCase; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.opensearch.common.xcontent.XContentFactory.jsonBuilder; | ||
| import static org.opensearch.index.query.QueryBuilders.matchAllQuery; | ||
| import static org.opensearch.search.aggregations.AggregationBuilders.count; | ||
| import static org.opensearch.test.OpenSearchIntegTestCase.*; | ||
|
|
||
|
|
||
| @ClusterScope(scope = Scope.SUITE, supportsDedicatedMasters = false, numDataNodes = 3, numClientNodes = 1) | ||
| public class TaskResourceTrackerIT extends OpenSearchIntegTestCase { | ||
|
|
||
| private void addDocuments(String index, int start, int end) throws Exception { | ||
| List<IndexRequestBuilder> builders = new ArrayList<>(); | ||
| for (int i = start; i < end; i++) { | ||
| builders.add(client().prepareIndex(index, "type", "" + i + 1).setSource(jsonBuilder() | ||
| .startObject() | ||
| .field("value", i + 1) | ||
| .field("tag", "tag" + i) | ||
| .endObject())); | ||
| } | ||
|
|
||
| indexRandom(true, builders); | ||
| ensureSearchable(); | ||
| } | ||
|
|
||
| public void testAggregation() throws Exception { | ||
| String index = "idx"; | ||
| createIndex(index, Settings.builder().put(IndexMetadata.SETTING_NUMBER_OF_SHARDS, 3).put(IndexMetadata.SETTING_NUMBER_OF_REPLICAS, 1).build()); | ||
| addDocuments(index, 0, 50); | ||
|
|
||
| ActionFuture<SearchResponse> searchResponseActionFuture = client().prepareSearch(index) | ||
| .setQuery(matchAllQuery()) | ||
| .addAggregation(count("count").field("value")) | ||
| .execute(); | ||
|
|
||
| List<String> nodeIds = getNodeNames(index); | ||
|
|
||
| // Thread.sleep(6000); | ||
|
|
||
| // NodesStatsResponse nodesStats = client().admin().cluster().prepareNodesStats().addMetric("thread_pool/search").get(); | ||
|
|
||
| searchResponseActionFuture.get(); | ||
| } | ||
|
|
||
| private List<String> getNodeNames(String indexName) { | ||
| IndicesStatsResponse response = client().admin().indices().prepareStats(indexName).get(); | ||
| return Stream.of(response.getShards()) | ||
| .map(ShardStats::getShardRouting) | ||
| .filter(ShardRouting::primary) | ||
| .map(ShardRouting::currentNodeId) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| } |
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
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,68 @@ | ||
| /* | ||
| * 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.common.util.concurrent; | ||
|
|
||
| import java.lang.management.ManagementFactory; | ||
| import java.util.Objects; | ||
|
|
||
| import com.sun.management.ThreadMXBean; | ||
| import org.opensearch.ExceptionsHelper; | ||
| import org.opensearch.tasks.TaskResourceTracker; | ||
|
|
||
| public class ResourceRunnable extends AbstractRunnable implements WrappedRunnable { | ||
|
There was a problem hiding this comment. Lets add java docs to explain how threads running cost is computed and associated with the corresponding task |
||
|
|
||
| private Runnable original; | ||
| private ThreadContext threadContext; | ||
| ThreadMXBean threadMXBean; | ||
| private String taskId; | ||
| private String threadpoolName; | ||
|
|
||
| public ResourceRunnable(ThreadContext threadContext, final Runnable original, String name) { | ||
| this.original = original; | ||
| this.threadContext = threadContext; | ||
| this.threadMXBean = (ThreadMXBean) ManagementFactory.getThreadMXBean(); | ||
| this.threadpoolName = name; | ||
| } | ||
|
|
||
| @Override | ||
| public void onFailure(Exception e) { | ||
| if (original instanceof AbstractRunnable) { | ||
| ((AbstractRunnable) original).onRejection(e); | ||
| } else { | ||
| ExceptionsHelper.reThrowIfNotNull(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void doRun() throws Exception { | ||
| if (Objects.nonNull(threadContext.getTransient("TASK_ID"))) { | ||
| String taskId = threadContext.getTransient("TASK_ID"); | ||
| long threadId = Thread.currentThread().getId(); | ||
| TaskResourceTracker.getInstance().registerWorkerForTask(Long.parseLong(taskId), threadId, | ||
| threadMXBean.getCurrentThreadCpuTime(), | ||
| threadMXBean.getThreadAllocatedBytes(threadId), threadpoolName); | ||
| } | ||
| try { | ||
| original.run(); | ||
| } finally { | ||
| if (Objects.nonNull(threadContext.getTransient("TASK_ID"))) { | ||
| String taskId = threadContext.getTransient("TASK_ID"); | ||
| long threadId = Thread.currentThread().getId(); | ||
| TaskResourceTracker.getInstance().unregisterWorkerForTask(Long.parseLong(taskId), threadId, | ||
| threadMXBean.getCurrentThreadCpuTime(), threadMXBean.getThreadAllocatedBytes(threadId)); | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public Runnable unwrap() { | ||
| return original; | ||
| } | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * 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.tasks; | ||
|
|
||
| import org.opensearch.index.shard.ShardId; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| public class TaskInfoKey { | ||
|
|
||
| private final long taskId; | ||
| private final List<String> indices; | ||
| private final ShardId shardId; | ||
| private final String action; | ||
|
|
||
| public TaskInfoKey(long taskId) { | ||
| this(taskId, new ArrayList<>(), null, null); | ||
| } | ||
|
|
||
| public TaskInfoKey(long taskId, List<String> indices, ShardId shardId, String action) { | ||
| this.taskId = taskId; | ||
| this.indices = indices; | ||
| this.shardId = shardId; | ||
| this.action = action; | ||
| } | ||
|
Comment on lines
+28
to
+33
There was a problem hiding this comment. Task is so far not bound to a ShardId, this should be more generic |
||
|
|
||
| public long getTaskId() { | ||
| return taskId; | ||
| } | ||
|
|
||
| public List<String> getIndices() { | ||
| return indices; | ||
| } | ||
|
|
||
| public ShardId getShardId() { | ||
| return shardId; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| TaskInfoKey that = (TaskInfoKey) o; | ||
| return Objects.equals(taskId, that.taskId); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(taskId); | ||
| } | ||
|
|
||
| } | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is expensive. Move this to a static final variable