Add resource stats to task framework by sruti1312 · Pull Request #1555 · opensearch-project/OpenSearch

sruti1312 · 2021-11-16T01:27:23Z

Signed-off-by: Sruti Parthiban partsrut@amazon.com

Description

Add resource stats to task framework. The task expose interfaces to allow updating the resource stats. On task completion, the resource usage stats are emitted to registered consumers (or sinks).

Sample task response:

"rh6TkaWmTwCp3Tb0zrjHKQ:8120" : {
     "node" : "rh6TkaWmTwCp3Tb0zrjHKQ",
     "id" : 8120,
     "type" : "direct",
     "action" : "indices:data/read/search[phase/query]",
     "start_time_in_millis" : 1637004446880,
     "running_time_in_nanos" : 9010172401,
     "cancellable" : true,
     "parent_task_id" : "rh6TkaWmTwCp3Tb0zrjHKQ:8119",
     "headers" : { },
     "resource_stats" : {
            "total_resource_consumption" : {
              "cpu_time_in_nanos" : 0,
              "memory_in_bytes" : 0
            }
     }
}

Issues Resolved

This is used for Search Memory tracking.
#1009

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

opensearch-ci-bot · 2021-11-16T01:28:03Z

Can one of the admins verify this patch?

opensearch-ci-bot · 2021-11-16T01:30:25Z

✅ Gradle Wrapper Validation success c16586137b6ffe154ad6677f95b380a4d8974019

opensearch-ci-bot · 2021-11-16T01:38:16Z

✅ Gradle Precommit success c16586137b6ffe154ad6677f95b380a4d8974019

opensearch-ci-bot · 2021-11-16T01:45:24Z

❌ Gradle Check failure c16586137b6ffe154ad6677f95b380a4d8974019
Log 1093

Reports 1093

Signed-off-by: Sruti Parthiban <partsrut@amazon.com>

opensearch-ci-bot · 2021-11-16T05:54:19Z

✅ Gradle Wrapper Validation success 4744ffe

opensearch-ci-bot · 2021-11-16T06:01:42Z

✅ Gradle Precommit success 4744ffe

opensearch-ci-bot · 2021-11-16T06:38:30Z

✅ Gradle Check success 4744ffe
Log 1097

Reports 1097

dblock · 2021-11-19T15:11:46Z

LGTM, how do you plan to use it?

sruti1312 · 2021-11-22T19:37:46Z

@dblock - The resource stats can be used to get top N resource consuming tasks. We can use the TaskStatConsumer interface for adding log based or system index based consumer (or sink) to provide additional insights.

dblock · 2021-11-22T22:58:58Z

I approved, but am not super familiar with this code. Maybe @nknize or @reta could take a quick second look?

reta · 2021-11-23T03:35:52Z

server/src/main/java/org/opensearch/tasks/consumer/TaskStatConsumer.java

+/**
+ * This listener is notified whenever an task is completed and has stats present
+ */
+public interface TaskStatConsumer {


May be TaskStatsConsumer would be better name ?

reta · 2021-11-23T03:37:33Z

server/src/main/java/org/opensearch/tasks/StatCollectorTask.java

+import java.util.HashMap;
+import java.util.Map;
+
+public class StatCollectorTask extends CancellableTask {


StatsCollectorTask, since it collect all stats?

reta · 2021-11-23T03:46:27Z

server/src/main/java/org/opensearch/tasks/TaskManager.java

    private final SetOnce<TaskCancellationService> cancellationService = new SetOnce<>();

+    /** Consumers that are notified of the stats */
+    private List<TaskStatConsumer> statConsumers;


I believe we should use the thread-safe data structure here, TaskManager is a singleton and addTaskStatConsumer could be called any time. Alternatively, we could make it final and add the constructor argument (instead of addTaskStatConsumer) to exclude any races.

reta · 2021-11-23T03:50:49Z

I approved, but am not super familiar with this code. Maybe @nknize or @reta could take a quick second look?

Thanks @dblock , I have a few comments primarily regarding naming, it looks inconsistent (to me), there is a mix of StatXxx vs StatsXxx in different places. Otherwise, looks good, afaik it is a part of a bigger picture and real stats collectors are going to be introduced soon.

dblock · 2021-11-23T18:31:28Z

I approved, but am not super familiar with this code. Maybe @nknize or @reta could take a quick second look?

Thanks @dblock , I have a few comments primarily regarding naming, it looks inconsistent (to me), there is a mix of StatXxx vs StatsXxx in different places. Otherwise, looks good, afaik it is a part of a bigger picture and real stats collectors are going to be introduced soon.

Thanks! @sruti1312 care to address naming?

server/src/main/java/org/opensearch/tasks/consumer/TaskStatConsumer.java

server/src/main/java/org/opensearch/tasks/consumer/TaskStatsLogger.java

server/src/main/java/org/opensearch/tasks/StatCollectorTask.java

sohami · 2021-11-23T20:56:04Z

server/src/main/java/org/opensearch/rest/action/cat/RestTasksAction.java

        table.addCell(FORMATTER.format(Instant.ofEpochMilli(taskInfo.getStartTime())));
        table.addCell(taskInfo.getRunningTimeNanos());
        table.addCell(TimeValue.timeValueNanos(taskInfo.getRunningTimeNanos()));
+        table.addCell(taskInfo.getStatsInfo());


I think we should use a request parameter (similar to detailed flag) to control if task API will return the status_info in results or not. This will help to avoid breaking the backward compatibility where old client are accessing the cluster

@dblock : When a new field is added in any REST API response object, will that break backward compatibility from client perspective ? Or adding a new field is fine and client doesn't perform any strict schema validation on response object ? Based on that info we can decide if a new parameter is needed to control the response payload with new field or not.

I think new field are ok, @nknize can you confirm please?

server/src/main/java/org/opensearch/tasks/TaskInfo.java

sohami · 2021-11-23T22:25:18Z

server/src/main/java/org/opensearch/tasks/TaskInfo.java

            builder.field(attribute.getKey(), attribute.getValue());
        }
        builder.endObject();
+        if (statsInfo != null) {


In what case statsInfo will be null here ? I see it is always being setting as Collections.emptyMap() in callers if not supported by task

sohami · 2021-11-23T23:15:29Z

server/src/main/resources/org/opensearch/tasks/task-index-mapping.json

+          },
+          "stats_info": {
+            "type" : "object",
+            "enabled" : false


how this new field will be handled for existing task result indices ?

sohami · 2021-11-23T23:29:09Z

server/src/main/java/org/opensearch/tasks/Task.java

            parentTask,
-            headers
+            headers,
+            this instanceof StatCollectorTask ? ((StatCollectorTask) this).getStats() : Collections.emptyMap()


We are using empty map as default for statsInfo in TaskInfo, that means for all the API like CancelTask as well it will end up returning an empty object, which is not needed. Instead, we will need to have some mechanism similar to description field which supports nullability and is only returned if detailed flag is set in request. For cancel type API that is always treated as false and the field in not returned in the response. You can refer the caller of this method

sohami · 2021-11-24T01:25:18Z

server/src/main/java/org/opensearch/tasks/TaskInfo.java

        TaskId parentTaskId,
-        Map<String, String> headers
+        Map<String, String> headers,
+        Map<String, Long> statsInfo


We should instead use some stats object as value rather than Long to help with adding other fields in that object in future for each stats type

dblock

Thanks for another review @sohami, will leave this open for now.

opensearch-ci-bot · 2021-12-15T19:54:39Z

✅ Gradle Check success 071e56b
Log 1513

Reports 1513

dblock · 2021-12-18T16:07:13Z

@sruti1312 Want to get this over the finishing line? Rebase, etc.? Adding @andrross to help out on the CRs.

Signed-off-by: Sruti Parthiban <partsrut@amazon.com>

opensearch-ci-bot · 2022-01-03T05:19:07Z

✅ Gradle Check success 6c845dd
Log 1747

Reports 1747

andrross · 2022-01-03T17:53:09Z

server/src/main/java/org/opensearch/tasks/TaskStatsType.java

+    MEMORY("memory"),
+    CPU("cpu");


What do these stats mean? Like is the memory value a percentage or bytes? Maybe these answers are obvious to everyone but me :)

opensearch-ci-bot · 2022-01-20T21:39:27Z

❌ Gradle Check failure 208bf3f
Log 2008

Reports 2008

dblock · 2022-02-01T20:46:02Z

start gradle check

dblock · 2022-02-01T20:46:21Z

Leaving this to @andrross to final/review/merge.

opensearch-ci-bot · 2022-02-01T21:12:56Z

❌ Gradle Check failure 208bf3f
Log 2160

Reports 2160

server/src/main/java/org/opensearch/tasks/TaskInfo.java

server/src/main/java/org/opensearch/tasks/TaskStatsType.java

server/src/main/java/org/opensearch/tasks/TaskStats.java

client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskInfo.java

server/src/main/java/org/opensearch/tasks/TaskStatsContext.java

sohami · 2022-01-31T08:03:25Z

server/src/main/java/org/opensearch/tasks/Task.java


    private final Map<String, String> headers;

+    private final Map<String, List<TaskResourceStatsUtil>> resourceStats;


Current class names are confusing to me specially ones with Util and Helper as suffix in it. Does are usually used for static utility classes. How about below names:

TaskResourceStatsUtil --> TaskCompleteResourceInfo TaskResourceStatsHelper: ---> TaskResourceInfo TaskResourceMetric: --> TaskStatsInfo

This will make the different classes like below which shows the relation between them.

TaskCompleteResourceInfo: Map<TaskStatsType, TaskResourceInfo> TaskResourceInfo: Map<TaskStats, TaskStatsInfo> TaskStatsInfo: private final TaskStats stats; private final boolean absolute; private long startValue; private long endValue;

sohami · 2022-02-02T05:49:33Z

client/rest-high-level/src/main/java/org/opensearch/client/tasks/TaskInfo.java

    private TaskId parentTaskId;
    private final Map<String, Object> status = new HashMap<>();
    private final Map<String, String> headers = new HashMap<>();
+    private final List<Object> resourceStats = new ArrayList<>();


Probably we should have it as Map<String, Object> where initially the entry will be for total resources consumed at task level. That way the serialization can also be of below format:

resource_stats: { "total": { "cpu_time": 183930, "memory_in_bytes": 1010293 } }

sohami · 2022-02-02T05:58:27Z

distribution/docker/src/docker/config/log4j2.properties

+appender.search_fatlog_rolling.type = Console
+appender.search_fatlog_rolling.name = search_fatlog_rolling
+appender.search_fatlog_rolling.layout.type = OpenSearchJsonLayout
+appender.search_fatlog_rolling.layout.type_name = search_fatlog


let's name it something else other than search_fatlog like tasks_info.log or tasks_details.log. Considering it can be used for other actions except search let's not add search in the log name.

sohami · 2022-02-02T06:08:23Z

server/src/main/java/org/opensearch/tasks/TaskManager.java

+    /** Consumers that are notified of the stats */
+    private final List<Consumer<TaskStatsContext>> statsConsumers = new ArrayList<Consumer<TaskStatsContext>>() {
+        {
+            add(new TaskSearchStatsLogger());


Is this consumer enabled by default ?

opensearch-ci-bot · 2022-02-08T23:09:52Z

✅ Gradle Check success 46e533ca57b8be2da523897514b9dcf45b95972b
Log 2298

Reports 2298

opensearch-ci-bot · 2022-02-09T23:40:56Z

✅ Gradle Check success e314321a11d478d177a3e7ae061ff1294e009385
Log 2315

Reports 2315

opensearch-ci-bot · 2022-02-09T23:44:05Z

❌ Gradle Check failure 1432f54c93aef302454f3f2e3a64e3c926edfa46
Log 2316

Reports 2316

Signed-off-by: sruti1312 <srutiparthiban@gmail.com>

opensearch-ci-bot · 2022-02-10T00:40:53Z

✅ Gradle Check success eb3e993
Log 2317

Reports 2317

andrross · 2022-02-10T17:12:33Z

server/src/main/java/org/opensearch/tasks/Task.java

+    }
+
+    public long getTotalResourceUtilization(TaskStats taskStats) {
+        AtomicLong totalResourceConsumption = new AtomicLong();


Using an AtomicLong just to be able to capture side effects from inside lambda functions seems like an anti-pattern to me. It implies there's some sort of concurrency here and also seems a bit like a hack to get around the compiler. I think you can rewrite this pretty simply to use regular for loops and a primitive long, like:

long totalResourceConsumption = 0L; for (List<TaskCompleteResourceInfo> statsUtilList : resourceStats.values()) { for (TaskCompleteResourceInfo statsUtil : statsUtilList) { for (Map.Entry<TaskStatsType, TaskResourceInfo> entry : statsUtil.getResourceInfo().entrySet()) { if (!entry.getKey().isOnlyForAnalysis()) { totalResourceConsumption += entry.getValue().getStatsInfo().get(taskStats).getTotalValue(); } } } } return totalResourceConsumption;

I think you can also write this using the Java stream API, but I find it a bit hard to read and might prefer the more verbose style above:

return resourceStats.values().stream().mapToLong( statsUtilList -> statsUtilList.stream().mapToLong( statsUtil -> statsUtil.getResourceInfo().entrySet().stream() .filter(e -> !e.getKey().isOnlyForAnalysis()) .mapToLong(e -> e.getValue().getStatsInfo().get(taskStats).getTotalValue()) .sum()) .sum()) .sum();

andrross · 2022-02-10T17:19:54Z

server/src/main/java/org/opensearch/tasks/Task.java

        this.startTime = startTime;
        this.startTimeNanos = startTimeNanos;
        this.headers = headers;
+        this.resourceStats = resourceStats;


The constructor above creates a ConcurrentHashMap, but this constructor allows a caller to inject any kind of map it wants. If thread safety is important then usage of a thread safe map should be required (either copy the provided map into a ConcurrentHashMap or make the type ConcurrentMap). See my comment below about thread safety though.

andrross · 2022-02-10T17:21:22Z

server/src/main/java/org/opensearch/tasks/Task.java

+        TaskStatsType statsType,
+        TaskStatsInfo... taskResourceMetrics
+    ) {
+        List<TaskCompleteResourceInfo> taskStatsUtilList = resourceStats.getOrDefault(threadId, new ArrayList<>());


resourceStats is a ConcurrentHashMap and therefore is thread safe, but this method isn't. Two threads could race in this method and one would end up overwriting the effects of the other. Is thread safety actually required?

sruti1312 · 2022-02-11T06:09:40Z

Thanks @reta @sohami and @andrross for reviewing this PR. Will address the comments as part of this PR.

Closing this PR and opening multiple smaller PR's against feature branch.

Adding resource information into task framework.
Integration sinks to consume resource information.

sruti1312 requested a review from a team as a code owner November 16, 2021 01:27

Add stats to task framework

4744ffe

Signed-off-by: Sruti Parthiban <partsrut@amazon.com>

malpani mentioned this pull request Nov 19, 2021

Track resource consumption for query and fetch phases #1575

Closed

5 tasks

malpani mentioned this pull request Nov 19, 2021

Search Memory Tracking - track memory used during a shard search #1009

Open

6 tasks

sruti1312 changed the title ~~[WIP] Add stats to task framework~~ Add resource stats to task framework Nov 19, 2021

dblock approved these changes Nov 22, 2021

View reviewed changes

reta reviewed Nov 23, 2021

View reviewed changes

sohami reviewed Nov 24, 2021

View reviewed changes

dblock suggested changes Nov 24, 2021

View reviewed changes

Merge branch 'main' into feature/stat-task-framework

071e56b

dblock requested a review from andrross December 18, 2021 16:06

sruti1312 added 2 commits January 2, 2022 20:24

Add stats to the task and update stats consumer

dcbbf5b

Signed-off-by: Sruti Parthiban <partsrut@amazon.com>

Merge branch 'main' into feature/stat-task-framework

6c845dd

Signed-off-by: Sruti Parthiban <partsrut@amazon.com>

andrross reviewed Jan 3, 2022

View reviewed changes

dblock requested a review from andrross February 1, 2022 20:46

sohami requested changes Feb 2, 2022

View reviewed changes

Add support to update task resource consumption

eb3e993

Signed-off-by: sruti1312 <srutiparthiban@gmail.com>

andrross reviewed Feb 10, 2022

View reviewed changes

sruti1312 closed this Feb 11, 2022


		private final Map<String, String> headers;

		private final Map<String, List<TaskResourceStatsUtil>> resourceStats;

Conversation

sruti1312 commented Nov 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Check List

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

opensearch-ci-bot commented Nov 16, 2021

Uh oh!

dblock commented Nov 19, 2021

Uh oh!

sruti1312 commented Nov 22, 2021

Uh oh!

dblock commented Nov 22, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reta commented Nov 23, 2021

Uh oh!

dblock commented Nov 23, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

opensearch-ci-bot commented Dec 15, 2021

Uh oh!

dblock commented Dec 18, 2021

Uh oh!

opensearch-ci-bot commented Jan 3, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

opensearch-ci-bot commented Jan 20, 2022

Uh oh!

dblock commented Feb 1, 2022

Uh oh!

dblock commented Feb 1, 2022

Uh oh!

opensearch-ci-bot commented Feb 1, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sruti1312 commented Nov 16, 2021 •

edited

Loading