Search: Add a timed_out element indicating if the search request timed out, closes elastic#592.

Author: kimchy

modules/elasticsearch/src/main/java/org/elasticsearch/action/search/SearchResponse.java

@@ -94,6 +94,20 @@ public Facets getFacets() {
         return facets();
     }
 
+    /**
+     * Has the search operation timed out.
+     */
+    public boolean timedOut() {
+        return internalResponse.timedOut();
+    }
+
+    /**
+     * Has the search operation timed out.
+     */
+    public boolean isTimedOut() {
+        return timedOut();
+    }
+
     /**
      * How long the search took.
      */
@@ -205,13 +219,15 @@ static final class Fields {
         static final XContentBuilderString SHARD = new XContentBuilderString("shard");
         static final XContentBuilderString REASON = new XContentBuilderString("reason");
         static final XContentBuilderString TOOK = new XContentBuilderString("took");
+        static final XContentBuilderString TIMED_OUT = new XContentBuilderString("timed_out");
     }
 
     @Override public void toXContent(XContentBuilder builder, Params params) throws IOException {
         if (scrollId != null) {
             builder.field(Fields._SCROLL_ID, scrollId);
         }
         builder.field(Fields.TOOK, tookInMillis);
+        builder.field(Fields.TIMED_OUT, timedOut());
         builder.startObject(Fields._SHARDS);
         builder.field(Fields.TOTAL, totalShards());
         builder.field(Fields.SUCCESSFUL, successfulShards());

modules/elasticsearch/src/main/java/org/elasticsearch/search/controller/SearchPhaseController.java

@@ -223,7 +223,11 @@ public InternalSearchResponse merge(ShardDoc[] sortedDocs, Map<SearchShardTarget
         // count the total (we use the query result provider here, since we might not get any hits (we scrolled past them))
         long totalHits = 0;
         float maxScore = Float.NEGATIVE_INFINITY;
+        boolean timedOut = false;
         for (QuerySearchResultProvider queryResultProvider : queryResults.values()) {
+            if (queryResultProvider.queryResult().searchTimedOut()) {
+                timedOut = true;
+            }
             totalHits += queryResultProvider.queryResult().topDocs().totalHits;
             if (!Float.isNaN(queryResultProvider.queryResult().topDocs().getMaxScore())) {
                 maxScore = Math.max(maxScore, queryResultProvider.queryResult().topDocs().getMaxScore());
@@ -265,7 +269,8 @@ public InternalSearchResponse merge(ShardDoc[] sortedDocs, Map<SearchShardTarget
                 }
             }
         }
+
         InternalSearchHits searchHits = new InternalSearchHits(hits.toArray(new InternalSearchHit[hits.size()]), totalHits, maxScore);
-        return new InternalSearchResponse(searchHits, facets);
+        return new InternalSearchResponse(searchHits, facets, timedOut);
     }
 }

modules/elasticsearch/src/main/java/org/elasticsearch/search/internal/InternalSearchResponse.java

@@ -41,12 +41,19 @@ public class InternalSearchResponse implements Streamable, ToXContent {
 
     private InternalFacets facets;
 
+    private boolean timedOut;
+
     private InternalSearchResponse() {
     }
 
-    public InternalSearchResponse(InternalSearchHits hits, InternalFacets facets) {
+    public InternalSearchResponse(InternalSearchHits hits, InternalFacets facets, boolean timedOut) {
         this.hits = hits;
         this.facets = facets;
+        this.timedOut = timedOut;
+    }
+
+    public boolean timedOut() {
+        return this.timedOut;
     }
 
     public SearchHits hits() {
@@ -75,6 +82,7 @@ public static InternalSearchResponse readInternalSearchResponse(StreamInput in)
         if (in.readBoolean()) {
             facets = InternalFacets.readFacets(in);
         }
+        timedOut = in.readBoolean();
     }
 
     @Override public void writeTo(StreamOutput out) throws IOException {
@@ -85,5 +93,6 @@ public static InternalSearchResponse readInternalSearchResponse(StreamInput in)
             out.writeBoolean(true);
             facets.writeTo(out);
         }
+        out.writeBoolean(timedOut);
     }
 }