Skip to content

Commit

Permalink
Shrink slow log for match query (#83338)
Browse files Browse the repository at this point in the history 
This removes defaults from the output of the `match` query's
`toXContent`. That'll make it take up less room in the slow log. And
anywhere else is shows up.

Relates to #76515
  • Loading branch information
@nik9000
nik9000 authored Feb 11, 2022
1 parent 4cf37b7 commit 26be52b
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 30 deletions.
19 changes: 18 additions & 1 deletion server/src/main/java/org/elasticsearch/index/query/AbstractQueryBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,30 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws

protected abstract void doXContent(XContentBuilder builder, Params params) throws IOException;

protected void printBoostAndQueryName(XContentBuilder builder) throws IOException {
/**
* Add {@code boost} and {@code query_name} to the builder.
* @deprecated use {@link #boostAndQueryNameToXContent}
*/
@Deprecated
protected final void printBoostAndQueryName(XContentBuilder builder) throws IOException {
builder.field(BOOST_FIELD.getPreferredName(), boost);
if (queryName != null) {
builder.field(NAME_FIELD.getPreferredName(), queryName);
}
}

/**
* Add {@code boost} and {@code query_name} to the builder.
*/
protected final void boostAndQueryNameToXContent(XContentBuilder builder) throws IOException {
if (boost != DEFAULT_BOOST) {
builder.field(BOOST_FIELD.getPreferredName(), boost);
}
if (queryName != null) {
builder.field(NAME_FIELD.getPreferredName(), queryName);
}
}

@Override
public final Query toQuery(SearchExecutionContext context) throws IOException {
Query query = doToQuery(context);
Expand Down
30 changes: 22 additions & 8 deletions server/src/main/java/org/elasticsearch/index/query/MatchQueryBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,27 +328,41 @@ public void doXContent(XContentBuilder builder, Params params) throws IOExceptio
builder.startObject(fieldName);

builder.field(QUERY_FIELD.getPreferredName(), value);
builder.field(OPERATOR_FIELD.getPreferredName(), operator.toString());
if (operator != DEFAULT_OPERATOR) {
builder.field(OPERATOR_FIELD.getPreferredName(), operator.toString());
}
if (analyzer != null) {
builder.field(ANALYZER_FIELD.getPreferredName(), analyzer);
}
if (fuzziness != null) {
fuzziness.toXContent(builder, params);
}
builder.field(PREFIX_LENGTH_FIELD.getPreferredName(), prefixLength);
builder.field(MAX_EXPANSIONS_FIELD.getPreferredName(), maxExpansions);
if (prefixLength != FuzzyQuery.defaultPrefixLength) {
builder.field(PREFIX_LENGTH_FIELD.getPreferredName(), prefixLength);
}
if (maxExpansions != FuzzyQuery.defaultMaxExpansions) {
builder.field(MAX_EXPANSIONS_FIELD.getPreferredName(), maxExpansions);
}
if (minimumShouldMatch != null) {
builder.field(MINIMUM_SHOULD_MATCH_FIELD.getPreferredName(), minimumShouldMatch);
}
if (fuzzyRewrite != null) {
builder.field(FUZZY_REWRITE_FIELD.getPreferredName(), fuzzyRewrite);
}
// LUCENE 4 UPGRADE we need to document this & test this
builder.field(FUZZY_TRANSPOSITIONS_FIELD.getPreferredName(), fuzzyTranspositions);
builder.field(LENIENT_FIELD.getPreferredName(), lenient);
builder.field(ZERO_TERMS_QUERY_FIELD.getPreferredName(), zeroTermsQuery.toString());
builder.field(GENERATE_SYNONYMS_PHRASE_QUERY.getPreferredName(), autoGenerateSynonymsPhraseQuery);
printBoostAndQueryName(builder);
if (fuzzyTranspositions != FuzzyQuery.defaultTranspositions) {
builder.field(FUZZY_TRANSPOSITIONS_FIELD.getPreferredName(), fuzzyTranspositions);
}
if (lenient != MatchQueryParser.DEFAULT_LENIENCY) {
builder.field(LENIENT_FIELD.getPreferredName(), lenient);
}
if (false == zeroTermsQuery.equals(MatchQueryParser.DEFAULT_ZERO_TERMS_QUERY)) {
builder.field(ZERO_TERMS_QUERY_FIELD.getPreferredName(), zeroTermsQuery.toString());
}
if (autoGenerateSynonymsPhraseQuery == false) {
builder.field(GENERATE_SYNONYMS_PHRASE_QUERY.getPreferredName(), autoGenerateSynonymsPhraseQuery);
}
boostAndQueryNameToXContent(builder);
builder.endObject();
builder.endObject();
}
Expand Down
29 changes: 27 additions & 2 deletions server/src/test/java/org/elasticsearch/index/query/MatchQueryBuilderTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,11 @@ public void testIllegalValues() {
}
}

public void testSimpleMatchQuery() throws IOException {
public void testParseDefaultsRemoved() throws IOException {
/*
* This json includes many defaults. When we parse the query and then
* call toString on it all of the defaults are removed.
*/
String json = """
{
"match" : {
Expand All @@ -258,12 +262,33 @@ public void testSimpleMatchQuery() throws IOException {
}
}""";
MatchQueryBuilder qb = (MatchQueryBuilder) parseQuery(json);
checkGeneratedJson(json, qb);
checkGeneratedJson("""
{
"match": {
"message": {
"query": "to be or not to be",
"operator": "AND",
"zero_terms_query": "ALL"
}
}
}""", qb);

assertEquals(json, "to be or not to be", qb.value());
assertEquals(json, Operator.AND, qb.operator());
}

public void testToXConentWithDefaults() throws IOException {
QueryBuilder query = new MatchQueryBuilder("foo", "bar");
checkGeneratedJson("""
{
"match": {
"foo": {
"query": "bar"
}
}
}""", query);
}

public void testFuzzinessOnNonStringField() throws Exception {
MatchQueryBuilder query = new MatchQueryBuilder(INT_FIELD_NAME, 42);
query.fuzziness(randomFuzziness(INT_FIELD_NAME));
Expand Down
35 changes: 33 additions & 2 deletions server/src/test/java/org/elasticsearch/index/query/NestedQueryBuilderTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,11 @@ public void testValidate() {
assertThat(e.getMessage(), equalTo("[nested] requires 'score_mode' field"));
}

public void testFromJson() throws IOException {
public void testParseDefaultsRemoved() throws IOException {
/*
* This json includes many defaults. When we parse the query and then
* call toString on it all of the defaults are removed.
*/
String json = """
{
"nested" : {
Expand Down Expand Up @@ -178,7 +182,34 @@ public void testFromJson() throws IOException {
}""";

NestedQueryBuilder parsed = (NestedQueryBuilder) parseQuery(json);
checkGeneratedJson(json, parsed);
checkGeneratedJson("""
{
"nested" : {
"query" : {
"bool" : {
"must" : [ {
"match" : {
"obj1.name" : {
"query" : "blue"
}
}
}, {
"range" : {
"obj1.count" : {
"gt" : 5,
"boost" : 1.0
}
}
} ],
"boost" : 1.0
}
},
"path" : "obj1",
"ignore_unmapped" : false,
"score_mode" : "avg",
"boost" : 1.0
}
}""", parsed);

assertEquals(json, ScoreMode.Avg, parsed.scoreMode());
}
Expand Down
18 changes: 1 addition & 17 deletions ...e/src/test/java/org/elasticsearch/xpack/core/ml/utils/XContentObjectTransformerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,23 +59,7 @@ public void testFromMap() throws IOException {
assertXContentAreEqual(aggTransformer.fromMap(aggMap), aggMap);
assertXContentAreEqual(aggTransformer.fromMap(aggMap), aggTransformer.toMap(aggTransformer.fromMap(aggMap)));

Map<String, Object> queryMap = Collections.singletonMap(
"match",
Collections.singletonMap("fieldName", new HashMap<String, Object>() {
{
// Add all the default fields so they are not added dynamically when the object is parsed
put("query", "fieldValue");
put("operator", "OR");
put("prefix_length", 0);
put("max_expansions", 50);
put("fuzzy_transpositions", true);
put("lenient", false);
put("zero_terms_query", "NONE");
put("auto_generate_synonyms_phrase_query", true);
put("boost", 1.0);
}
})
);
Map<String, Object> queryMap = Map.of("match", Map.of("fieldName", Map.of("query", "fieldValue")));

XContentObjectTransformer<QueryBuilder> queryBuilderTransformer = XContentObjectTransformer.queryBuilderTransformer(
xContentRegistry()
Expand Down

0 comments on commit 26be52b

Please sign in to comment.