[7.x] [ML] Add DatafeedTimingStats to datafeed GetDatafeedStatsAction…

….Response (#43045) (#44118)

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/datafeed/DatafeedStats.java

@@ -41,9 +41,12 @@ public class DatafeedStats implements ToXContentObject {
     private final NodeAttributes node;
     @Nullable
     private final String assignmentExplanation;
+    @Nullable
+    private final DatafeedTimingStats timingStats;
 
     public static final ParseField ASSIGNMENT_EXPLANATION = new ParseField("assignment_explanation");
     public static final ParseField NODE = new ParseField("node");
+    public static final ParseField TIMING_STATS = new ParseField("timing_stats");
 
     public static final ConstructingObjectParser<DatafeedStats, Void> PARSER = new ConstructingObjectParser<>("datafeed_stats",
     true,
@@ -52,22 +55,25 @@ public class DatafeedStats implements ToXContentObject {
         DatafeedState datafeedState = DatafeedState.fromString((String)a[1]);
         NodeAttributes nodeAttributes = (NodeAttributes)a[2];
         String assignmentExplanation = (String)a[3];
-        return new DatafeedStats(datafeedId, datafeedState, nodeAttributes, assignmentExplanation);
+        DatafeedTimingStats timingStats = (DatafeedTimingStats)a[4];
+        return new DatafeedStats(datafeedId, datafeedState, nodeAttributes, assignmentExplanation, timingStats);
     } );
 
     static {
         PARSER.declareString(ConstructingObjectParser.constructorArg(), DatafeedConfig.ID);
         PARSER.declareString(ConstructingObjectParser.constructorArg(), DatafeedState.STATE);
         PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), NodeAttributes.PARSER, NODE);
         PARSER.declareString(ConstructingObjectParser.optionalConstructorArg(), ASSIGNMENT_EXPLANATION);
+        PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), DatafeedTimingStats.PARSER, TIMING_STATS);
     }
 
     public DatafeedStats(String datafeedId, DatafeedState datafeedState, @Nullable NodeAttributes node,
-                         @Nullable String assignmentExplanation) {
+                         @Nullable String assignmentExplanation, @Nullable DatafeedTimingStats timingStats) {
         this.datafeedId = Objects.requireNonNull(datafeedId);
         this.datafeedState = Objects.requireNonNull(datafeedState);
         this.node = node;
         this.assignmentExplanation = assignmentExplanation;
+        this.timingStats = timingStats;
     }
 
     public String getDatafeedId() {
@@ -86,6 +92,10 @@ public String getAssignmentExplanation() {
         return assignmentExplanation;
     }
 
+    public DatafeedTimingStats getDatafeedTimingStats() {
+        return timingStats;
+    }
+
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
         builder.startObject();
@@ -110,13 +120,16 @@ public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params par
         if (assignmentExplanation != null) {
             builder.field(ASSIGNMENT_EXPLANATION.getPreferredName(), assignmentExplanation);
         }
+        if (timingStats != null) {
+            builder.field(TIMING_STATS.getPreferredName(), timingStats);
+        }
         builder.endObject();
         return builder;
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(datafeedId, datafeedState.toString(), node, assignmentExplanation);
+        return Objects.hash(datafeedId, datafeedState.toString(), node, assignmentExplanation, timingStats);
     }
 
     @Override
@@ -131,6 +144,7 @@ public boolean equals(Object obj) {
         return Objects.equals(datafeedId, other.datafeedId) &&
             Objects.equals(this.datafeedState, other.datafeedState) &&
             Objects.equals(this.node, other.node) &&
-            Objects.equals(this.assignmentExplanation, other.assignmentExplanation);
+            Objects.equals(this.assignmentExplanation, other.assignmentExplanation) &&
+            Objects.equals(this.timingStats, other.timingStats);
     }
 }

client/rest-high-level/src/main/java/org/elasticsearch/client/ml/datafeed/DatafeedTimingStats.java

@@ -0,0 +1,122 @@
+/*
+ * 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.client.ml.datafeed;
+
+import org.elasticsearch.common.Nullable;
+import org.elasticsearch.common.ParseField;
+import org.elasticsearch.common.Strings;
+import org.elasticsearch.common.xcontent.ConstructingObjectParser;
+import org.elasticsearch.common.xcontent.ToXContent;
+import org.elasticsearch.common.xcontent.ToXContentObject;
+import org.elasticsearch.common.xcontent.XContentBuilder;
+
+import java.io.IOException;
+import java.util.Objects;
+
+import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg;
+import static org.elasticsearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg;
+
+public class DatafeedTimingStats implements ToXContentObject {
+
+    public static final ParseField JOB_ID = new ParseField("job_id");
+    public static final ParseField SEARCH_COUNT = new ParseField("search_count");
+    public static final ParseField TOTAL_SEARCH_TIME_MS = new ParseField("total_search_time_ms");
+
+    public static final ParseField TYPE = new ParseField("datafeed_timing_stats");
+
+    public static final ConstructingObjectParser<DatafeedTimingStats, Void> PARSER = createParser();
+
+    private static ConstructingObjectParser<DatafeedTimingStats, Void> createParser() {
+        ConstructingObjectParser<DatafeedTimingStats, Void> parser =
+            new ConstructingObjectParser<>(
+                "datafeed_timing_stats",
+                true,
+                args -> {
+                    String jobId = (String) args[0];
+                    Long searchCount = (Long) args[1];
+                    Double totalSearchTimeMs = (Double) args[2];
+                    return new DatafeedTimingStats(jobId, getOrDefault(searchCount, 0L), getOrDefault(totalSearchTimeMs, 0.0));
+                });
+        parser.declareString(constructorArg(), JOB_ID);
+        parser.declareLong(optionalConstructorArg(), SEARCH_COUNT);
+        parser.declareDouble(optionalConstructorArg(), TOTAL_SEARCH_TIME_MS);
+        return parser;
+    }
+
+    private final String jobId;
+    private long searchCount;
+    private double totalSearchTimeMs;
+
+    public DatafeedTimingStats(String jobId, long searchCount, double totalSearchTimeMs) {
+        this.jobId = Objects.requireNonNull(jobId);
+        this.searchCount = searchCount;
+        this.totalSearchTimeMs = totalSearchTimeMs;
+    }
+
+    public String getJobId() {
+        return jobId;
+    }
+
+    public long getSearchCount() {
+        return searchCount;
+    }
+
+    public double getTotalSearchTimeMs() {
+        return totalSearchTimeMs;
+    }
+
+    @Override
+    public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException {
+        builder.startObject();
+        builder.field(JOB_ID.getPreferredName(), jobId);
+        builder.field(SEARCH_COUNT.getPreferredName(), searchCount);
+        builder.field(TOTAL_SEARCH_TIME_MS.getPreferredName(), totalSearchTimeMs);
+        builder.endObject();
+        return builder;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null || getClass() != obj.getClass()) {
+            return false;
+        }
+
+        DatafeedTimingStats other = (DatafeedTimingStats) obj;
+        return Objects.equals(this.jobId, other.jobId)
+            && this.searchCount == other.searchCount
+            && this.totalSearchTimeMs == other.totalSearchTimeMs;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(jobId, searchCount, totalSearchTimeMs);
+    }
+
+    @Override
+    public String toString() {
+        return Strings.toString(this);
+    }
+
+    private static <T> T getOrDefault(@Nullable T value, T defaultValue) {
+        return value != null ? value : defaultValue;
+    }
+}

client/rest-high-level/src/test/java/org/elasticsearch/client/ml/datafeed/DatafeedStatsTests.java

@@ -50,7 +50,8 @@ public static DatafeedStats createRandomInstance() {
                 attributes);
         }
         String assignmentReason = randomBoolean() ? randomAlphaOfLength(10) : null;
-        return new DatafeedStats(datafeedId, datafeedState, nodeAttributes, assignmentReason);
+        DatafeedTimingStats timingStats = DatafeedTimingStatsTests.createRandomInstance();
+        return new DatafeedStats(datafeedId, datafeedState, nodeAttributes, assignmentReason, timingStats);
     }
 
     @Override

client/rest-high-level/src/test/java/org/elasticsearch/client/ml/datafeed/DatafeedTimingStatsTests.java

@@ -0,0 +1,92 @@
+/*
+ * 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.client.ml.datafeed;
+
+import org.elasticsearch.common.xcontent.DeprecationHandler;
+import org.elasticsearch.common.xcontent.XContentFactory;
+import org.elasticsearch.common.xcontent.XContentParser;
+import org.elasticsearch.common.xcontent.XContentType;
+import org.elasticsearch.test.AbstractXContentTestCase;
+
+import java.io.IOException;
+
+import static org.hamcrest.Matchers.equalTo;
+
+public class DatafeedTimingStatsTests extends AbstractXContentTestCase<DatafeedTimingStats> {
+
+    private static final String JOB_ID = "my-job-id";
+
+    public static DatafeedTimingStats createRandomInstance() {
+        return new DatafeedTimingStats(randomAlphaOfLength(10), randomLong(), randomDouble());
+    }
+
+    @Override
+    protected DatafeedTimingStats createTestInstance() {
+        return createRandomInstance();
+    }
+
+    @Override
+    protected DatafeedTimingStats doParseInstance(XContentParser parser) throws IOException {
+        return DatafeedTimingStats.PARSER.apply(parser, null);
+    }
+
+    @Override
+    protected boolean supportsUnknownFields() {
+        return true;
+    }
+
+    public void testParse_OptionalFieldsAbsent() throws IOException {
+        String json = "{\"job_id\": \"my-job-id\"}";
+        try (XContentParser parser =
+                 XContentFactory.xContent(XContentType.JSON).createParser(
+                     xContentRegistry(), DeprecationHandler.THROW_UNSUPPORTED_OPERATION, json)) {
+            DatafeedTimingStats stats = DatafeedTimingStats.PARSER.apply(parser, null);
+            assertThat(stats.getJobId(), equalTo(JOB_ID));
+            assertThat(stats.getSearchCount(), equalTo(0L));
+            assertThat(stats.getTotalSearchTimeMs(), equalTo(0.0));
+        }
+    }
+
+    public void testEquals() {
+        DatafeedTimingStats stats1 = new DatafeedTimingStats(JOB_ID, 5, 100.0);
+        DatafeedTimingStats stats2 = new DatafeedTimingStats(JOB_ID, 5, 100.0);
+        DatafeedTimingStats stats3 = new DatafeedTimingStats(JOB_ID, 5, 200.0);
+
+        assertTrue(stats1.equals(stats1));
+        assertTrue(stats1.equals(stats2));
+        assertFalse(stats2.equals(stats3));
+    }
+
+    public void testHashCode() {
+        DatafeedTimingStats stats1 = new DatafeedTimingStats(JOB_ID, 5, 100.0);
+        DatafeedTimingStats stats2 = new DatafeedTimingStats(JOB_ID, 5, 100.0);
+        DatafeedTimingStats stats3 = new DatafeedTimingStats(JOB_ID, 5, 200.0);
+
+        assertEquals(stats1.hashCode(), stats1.hashCode());
+        assertEquals(stats1.hashCode(), stats2.hashCode());
+        assertNotEquals(stats2.hashCode(), stats3.hashCode());
+    }
+
+    public void testConstructorAndGetters() {
+        DatafeedTimingStats stats = new DatafeedTimingStats(JOB_ID, 5, 123.456);
+        assertThat(stats.getJobId(), equalTo(JOB_ID));
+        assertThat(stats.getSearchCount(), equalTo(5L));
+        assertThat(stats.getTotalSearchTimeMs(), equalTo(123.456));
+    }
+}

docs/reference/ml/apis/datafeedresource.asciidoc

@@ -143,3 +143,10 @@ update their values:
   `started`::: The {dfeed} is actively receiving data.
   `stopped`::: The {dfeed} is stopped and will not receive data until it is
   re-started.
+
+`timing_stats`::
+  (object) An object that provides statistical information about timing aspect of this datafeed. +
+  `job_id`::: A numerical character string that uniquely identifies the job.
+  `search_count`::: Number of searches performed by this datafeed.
+  `total_search_time_ms`::: Total time the datafeed spent searching in milliseconds.
+

docs/reference/ml/apis/get-datafeed-stats.asciidoc

@@ -90,7 +90,12 @@ The API returns the following results:
           "ml.max_open_jobs": "20"
         }
       },
-      "assignment_explanation": ""
+      "assignment_explanation": "",
+      "timing_stats": {
+        "job_id": "job-total-requests",
+        "search_count": 20,
+        "total_search_time_ms": 120.5
+      }
     }
   ]
 }