From ed4d0881b188df46a41bea11e166f79ba925d77c Mon Sep 17 00:00:00 2001 From: David Pilato Date: Tue, 13 Sep 2016 18:10:52 +0200 Subject: [PATCH] Add profile and explain parameters to template API We can now run templates using `explain` and/or `profile` parameters. Which is interesting when you have defined a complicated profile but want to debug it in an easier way than running the full query again. You can use `explain` parameter when running a template: ```js GET /_search/template { "file": "my_template", "params": { "status": [ "pending", "published" ] }, "explain": true } ``` You can use `profile` parameter when running a template: ```js GET /_search/template { "file": "my_template", "params": { "status": [ "pending", "published" ] }, "profile": true } ``` --- .../reference/search/search-template.asciidoc | 36 +++++++++++++++++++ .../mustache/RestSearchTemplateAction.java | 2 ++ .../mustache/SearchTemplateRequest.java | 22 ++++++++++++ .../SearchTemplateRequestBuilder.java | 16 +++++++++ .../TransportSearchTemplateAction.java | 2 ++ .../lang_mustache/30_search_template.yaml | 16 +++++++++ .../rest-api-spec/api/search_template.json | 8 +++++ 7 files changed, 102 insertions(+) diff --git a/docs/reference/search/search-template.asciidoc b/docs/reference/search/search-template.asciidoc index e9222beabf5..7c6a0390ea6 100644 --- a/docs/reference/search/search-template.asciidoc +++ b/docs/reference/search/search-template.asciidoc @@ -486,6 +486,42 @@ GET /_render/template/ } ------------------------------------------ +[float] +===== Explain + +You can use `explain` parameter when running a template: + +[source,js] +------------------------------------------ +GET /_search/template +{ + "file": "my_template", + "params": { + "status": [ "pending", "published" ] + }, + "explain": true +} +------------------------------------------ + + +[float] +===== Profiling + +You can use `profile` parameter when running a template: + +[source,js] +------------------------------------------ +GET /_search/template +{ + "file": "my_template", + "params": { + "status": [ "pending", "published" ] + }, + "profile": true +} +------------------------------------------ + + [[multi-search-template]] == Multi Search Template diff --git a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java index 18637b15e84..6d830a21f5a 100644 --- a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java +++ b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/RestSearchTemplateAction.java @@ -68,6 +68,8 @@ public class RestSearchTemplateAction extends BaseRestHandler { request.setScriptType(ScriptService.ScriptType.STORED); request.setScript(s); }, new ParseField("id")); + PARSER.declareBoolean(SearchTemplateRequest::setExplain, new ParseField("explain")); + PARSER.declareBoolean(SearchTemplateRequest::setProfile, new ParseField("profile")); PARSER.declareField((parser, request, value) -> { request.setScriptType(ScriptService.ScriptType.INLINE); if (parser.currentToken() == XContentParser.Token.START_OBJECT) { diff --git a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequest.java b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequest.java index a4a65336046..1fa7f24de8f 100644 --- a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequest.java +++ b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequest.java @@ -41,6 +41,8 @@ public class SearchTemplateRequest extends ActionRequest private SearchRequest request; private boolean simulate = false; + private boolean explain = false; + private boolean profile = false; private ScriptService.ScriptType scriptType; private String script; private Map scriptParams; @@ -69,6 +71,22 @@ public class SearchTemplateRequest extends ActionRequest this.simulate = simulate; } + public boolean isExplain() { + return explain; + } + + public void setExplain(boolean explain) { + this.explain = explain; + } + + public boolean isProfile() { + return profile; + } + + public void setProfile(boolean profile) { + this.profile = profile; + } + public ScriptService.ScriptType getScriptType() { return scriptType; } @@ -123,6 +141,8 @@ public class SearchTemplateRequest extends ActionRequest super.readFrom(in); request = in.readOptionalStreamable(SearchRequest::new); simulate = in.readBoolean(); + explain = in.readBoolean(); + profile = in.readBoolean(); scriptType = ScriptService.ScriptType.readFrom(in); script = in.readOptionalString(); if (in.readBoolean()) { @@ -135,6 +155,8 @@ public class SearchTemplateRequest extends ActionRequest super.writeTo(out); out.writeOptionalStreamable(request); out.writeBoolean(simulate); + out.writeBoolean(explain); + out.writeBoolean(profile); ScriptService.ScriptType.writeTo(scriptType, out); out.writeOptionalString(script); boolean hasParams = scriptParams != null; diff --git a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequestBuilder.java b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequestBuilder.java index 811c2523e06..52f51b7254f 100644 --- a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequestBuilder.java +++ b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/SearchTemplateRequestBuilder.java @@ -47,6 +47,22 @@ public class SearchTemplateRequestBuilder return this; } + /** + * Enables explanation for each hit on how its score was computed. Disabled by default + */ + public SearchTemplateRequestBuilder setExplain(boolean explain) { + request.setExplain(explain); + return this; + } + + /** + * Enables profiling of the query. Disabled by default + */ + public SearchTemplateRequestBuilder setProfile(boolean profile) { + request.setProfile(profile); + return this; + } + public SearchTemplateRequestBuilder setScriptType(ScriptService.ScriptType scriptType) { request.setScriptType(scriptType); return this; diff --git a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/TransportSearchTemplateAction.java b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/TransportSearchTemplateAction.java index 9df5a29b9c7..f323fcf450f 100644 --- a/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/TransportSearchTemplateAction.java +++ b/modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/TransportSearchTemplateAction.java @@ -84,6 +84,8 @@ public class TransportSearchTemplateAction extends HandledTransportAction() { diff --git a/modules/lang-mustache/src/test/resources/rest-api-spec/test/lang_mustache/30_search_template.yaml b/modules/lang-mustache/src/test/resources/rest-api-spec/test/lang_mustache/30_search_template.yaml index c7e4c91b4cc..b09976885d4 100644 --- a/modules/lang-mustache/src/test/resources/rest-api-spec/test/lang_mustache/30_search_template.yaml +++ b/modules/lang-mustache/src/test/resources/rest-api-spec/test/lang_mustache/30_search_template.yaml @@ -106,3 +106,19 @@ - match: { hits.total: 1 } - length: { hits.hits: 1 } + + - do: + search_template: + body: { "file" : "template_1", "params": { "size": "2", "field": "otherField", "value": "foo" }, "explain" : true } + + - match: { hits.total: 1 } + - length: { hits.hits: 1 } + - match: { hits.hits.0._explanation.description: "weight(otherField:foo in 0) [PerFieldSimilarity], result of:" } + + - do: + search_template: + body: { "file" : "template_1", "params": { "size": "2", "field": "otherField", "value": "foo" }, "profile" : true } + + - match: { hits.total: 1 } + - length: { hits.hits: 1 } + - length: { profile: 1 } diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json index 67cbcf44a9e..ff1d35bb417 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json @@ -46,6 +46,14 @@ "type" : "enum", "options" : ["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"], "description" : "Search operation type" + }, + "explain": { + "type" : "boolean", + "description" : "Specify whether to return detailed information about score computation as part of a hit" + }, + "profile": { + "type" : "boolean", + "description" : "Specify whether to profile the query execution" } } },