Skip to content

Commit 0ac82d2

Browse files
kderussomarkjhoy
authored and
smalyshev
committed
Add tracking for query rule types (#116357)
* Add total rule type counts to list calls and xpack usage * Add feature * Update docs/changelog/116357.yaml * Fix docs test failure & update yaml tests * remove additional spaces --------- Co-authored-by: Mark J. Hoy <[email protected]>
1 parent 99c7c13 commit 0ac82d2

File tree

11 files changed

+184
-24
lines changed

11 files changed

+184
-24
lines changed

‎docs/changelog/116357.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pr: 116357
2+
summary: Add tracking for query rule types
3+
area: Relevance
4+
type: enhancement
5+
issues: []

‎docs/reference/query-rules/apis/list-query-rulesets.asciidoc‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ PUT _query_rules/ruleset-3
124124
},
125125
{
126126
"rule_id": "rule-3",
127-
"type": "pinned",
127+
"type": "exclude",
128128
"criteria": [
129129
{
130130
"type": "fuzzy",
@@ -178,6 +178,9 @@ A sample response:
178178
"rule_total_count": 1,
179179
"rule_criteria_types_counts": {
180180
"exact": 1
181+
},
182+
"rule_type_counts": {
183+
"pinned": 1
181184
}
182185
},
183186
{
@@ -186,6 +189,9 @@ A sample response:
186189
"rule_criteria_types_counts": {
187190
"exact": 1,
188191
"fuzzy": 1
192+
},
193+
"rule_type_counts": {
194+
"pinned": 2
189195
}
190196
},
191197
{
@@ -194,6 +200,10 @@ A sample response:
194200
"rule_criteria_types_counts": {
195201
"exact": 1,
196202
"fuzzy": 2
203+
},
204+
"rule_type_counts": {
205+
"pinned": 2,
206+
"exclude": 1
197207
}
198208
}
199209
]

‎server/src/main/java/org/elasticsearch/TransportVersions.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ static TransportVersion def(int id) {
196196
public static final TransportVersion ADD_COMPATIBILITY_VERSIONS_TO_NODE_INFO = def(8_789_00_0);
197197
public static final TransportVersion VERTEX_AI_INPUT_TYPE_ADDED = def(8_790_00_0);
198198
public static final TransportVersion SKIP_INNER_HITS_SEARCH_SOURCE = def(8_791_00_0);
199+
public static final TransportVersion QUERY_RULES_LIST_INCLUDES_TYPES = def(8_792_00_0);
200+
199201
/*
200202
* STOP! READ THIS FIRST! No, really,
201203
* ____ _____ ___ ____ _ ____ _____ _ ____ _____ _ _ ___ ____ _____ ___ ____ ____ _____ _

‎x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/application/EnterpriseSearchFeatureSetUsage.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ public class EnterpriseSearchFeatureSetUsage extends XPackFeatureUsage {
3434
public static final String MIN_RULE_COUNT = "min_rule_count";
3535
public static final String MAX_RULE_COUNT = "max_rule_count";
3636
public static final String RULE_CRITERIA_TOTAL_COUNTS = "rule_criteria_total_counts";
37+
public static final String RULE_TYPE_TOTAL_COUNTS = "rule_type_total_counts";
3738

3839
private final Map<String, Object> searchApplicationsUsage;
3940
private final Map<String, Object> analyticsCollectionsUsage;

‎x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/rules/20_query_ruleset_list.yml‎

Lines changed: 87 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
setup:
2-
- requires:
3-
cluster_features: [ "gte_v8.10.0" ]
4-
reason: Introduced in 8.10.0
52
- do:
63
query_rules.put_ruleset:
74
ruleset_id: test-query-ruleset-3
@@ -222,7 +219,7 @@ teardown:
222219
body:
223220
rules:
224221
- rule_id: query-rule-id1
225-
type: pinned
222+
type: exclude
226223
criteria:
227224
- type: exact
228225
metadata: query_string
@@ -307,3 +304,89 @@ teardown:
307304

308305
- match: { error.type: 'security_exception' }
309306

307+
---
308+
'List query rulesets - include rule types':
309+
- requires:
310+
cluster_features: [ "query_rule_list_types" ]
311+
reason: 'List responses updated in 8.15.5 and 8.16.1'
312+
313+
- do:
314+
query_rules.put_ruleset:
315+
ruleset_id: a-test-query-ruleset-with-lots-of-criteria
316+
body:
317+
rules:
318+
- rule_id: query-rule-id1
319+
type: exclude
320+
criteria:
321+
- type: exact
322+
metadata: query_string
323+
values: [ puggles ]
324+
- type: gt
325+
metadata: year
326+
values: [ 2023 ]
327+
actions:
328+
ids:
329+
- 'id1'
330+
- 'id2'
331+
- rule_id: query-rule-id2
332+
type: pinned
333+
criteria:
334+
- type: exact
335+
metadata: query_string
336+
values: [ pug ]
337+
actions:
338+
ids:
339+
- 'id3'
340+
- 'id4'
341+
- rule_id: query-rule-id3
342+
type: pinned
343+
criteria:
344+
- type: fuzzy
345+
metadata: query_string
346+
values: [ puggles ]
347+
actions:
348+
ids:
349+
- 'id5'
350+
- 'id6'
351+
- rule_id: query-rule-id4
352+
type: pinned
353+
criteria:
354+
- type: always
355+
actions:
356+
ids:
357+
- 'id7'
358+
- 'id8'
359+
- rule_id: query-rule-id5
360+
type: pinned
361+
criteria:
362+
- type: prefix
363+
metadata: query_string
364+
values: [ pug ]
365+
- type: suffix
366+
metadata: query_string
367+
values: [ gle ]
368+
actions:
369+
ids:
370+
- 'id9'
371+
- 'id10'
372+
373+
- do:
374+
query_rules.list_rulesets:
375+
from: 0
376+
size: 1
377+
378+
- match: { count: 4 }
379+
380+
# Alphabetical order by ruleset_id for results
381+
- match: { results.0.ruleset_id: "a-test-query-ruleset-with-lots-of-criteria" }
382+
- match: { results.0.rule_total_count: 5 }
383+
- match:
384+
results.0.rule_criteria_types_counts:
385+
exact: 2
386+
gt: 1
387+
fuzzy: 1
388+
prefix: 1
389+
suffix: 1
390+
always: 1
391+
- match: { results.0.rule_type_counts: { pinned: 4, exclude: 1 } }
392+

‎x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/EnterpriseSearchFeatures.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import org.elasticsearch.features.NodeFeature;
1313
import org.elasticsearch.xpack.application.analytics.AnalyticsTemplateRegistry;
1414
import org.elasticsearch.xpack.application.connector.ConnectorTemplateRegistry;
15+
import org.elasticsearch.xpack.application.rules.action.ListQueryRulesetsAction;
1516
import org.elasticsearch.xpack.application.rules.retriever.QueryRuleRetrieverBuilder;
1617

1718
import java.util.Map;
@@ -23,7 +24,11 @@ public class EnterpriseSearchFeatures implements FeatureSpecification {
2324

2425
@Override
2526
public Set<NodeFeature> getFeatures() {
26-
return Set.of(QUERY_RULES_TEST_API, QueryRuleRetrieverBuilder.QUERY_RULE_RETRIEVERS_SUPPORTED);
27+
return Set.of(
28+
QUERY_RULES_TEST_API,
29+
QueryRuleRetrieverBuilder.QUERY_RULE_RETRIEVERS_SUPPORTED,
30+
ListQueryRulesetsAction.QUERY_RULE_LIST_TYPES
31+
);
2732
}
2833

2934
@Override

‎x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/EnterpriseSearchUsageTransportAction.java‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import org.elasticsearch.threadpool.ThreadPool;
2828
import org.elasticsearch.transport.TransportService;
2929
import org.elasticsearch.xpack.application.analytics.action.GetAnalyticsCollectionAction;
30-
import org.elasticsearch.xpack.application.rules.QueryRuleCriteriaType;
3130
import org.elasticsearch.xpack.application.rules.QueryRulesIndexService;
3231
import org.elasticsearch.xpack.application.rules.QueryRulesetListItem;
3332
import org.elasticsearch.xpack.application.rules.action.ListQueryRulesetsAction;
@@ -41,7 +40,6 @@
4140
import org.elasticsearch.xpack.core.application.EnterpriseSearchFeatureSetUsage;
4241

4342
import java.util.Collections;
44-
import java.util.EnumMap;
4543
import java.util.HashMap;
4644
import java.util.IntSummaryStatistics;
4745
import java.util.List;
@@ -226,20 +224,29 @@ private void addQueryRulesetUsage(ListQueryRulesetsAction.Response response, Map
226224
List<QueryRulesetListItem> results = response.queryPage().results();
227225
IntSummaryStatistics ruleStats = results.stream().mapToInt(QueryRulesetListItem::ruleTotalCount).summaryStatistics();
228226

229-
Map<QueryRuleCriteriaType, Integer> criteriaTypeCountMap = new EnumMap<>(QueryRuleCriteriaType.class);
230-
results.stream()
231-
.flatMap(result -> result.criteriaTypeToCountMap().entrySet().stream())
232-
.forEach(entry -> criteriaTypeCountMap.merge(entry.getKey(), entry.getValue(), Integer::sum));
227+
Map<String, Object> ruleCriteriaTypeCountMap = new HashMap<>();
228+
Map<String, Object> ruleTypeCountMap = new HashMap<>();
233229

234-
Map<String, Object> rulesTypeCountMap = new HashMap<>();
235-
criteriaTypeCountMap.forEach((criteriaType, count) -> rulesTypeCountMap.put(criteriaType.name().toLowerCase(Locale.ROOT), count));
230+
results.forEach(result -> {
231+
populateCounts(ruleCriteriaTypeCountMap, result.criteriaTypeToCountMap());
232+
populateCounts(ruleTypeCountMap, result.ruleTypeToCountMap());
233+
});
236234

237235
queryRulesUsage.put(TOTAL_COUNT, response.queryPage().count());
238236
queryRulesUsage.put(TOTAL_RULE_COUNT, ruleStats.getSum());
239237
queryRulesUsage.put(MIN_RULE_COUNT, results.isEmpty() ? 0 : ruleStats.getMin());
240238
queryRulesUsage.put(MAX_RULE_COUNT, results.isEmpty() ? 0 : ruleStats.getMax());
241-
if (rulesTypeCountMap.isEmpty() == false) {
242-
queryRulesUsage.put(RULE_CRITERIA_TOTAL_COUNTS, rulesTypeCountMap);
239+
if (ruleCriteriaTypeCountMap.isEmpty() == false) {
240+
queryRulesUsage.put(RULE_CRITERIA_TOTAL_COUNTS, ruleCriteriaTypeCountMap);
241+
}
242+
if (ruleTypeCountMap.isEmpty() == false) {
243+
queryRulesUsage.put(EnterpriseSearchFeatureSetUsage.RULE_TYPE_TOTAL_COUNTS, ruleTypeCountMap);
243244
}
244245
}
246+
247+
private void populateCounts(Map<String, Object> targetMap, Map<? extends Enum<?>, Integer> sourceMap) {
248+
sourceMap.forEach(
249+
(key, value) -> targetMap.merge(key.name().toLowerCase(Locale.ROOT), value, (v1, v2) -> (Integer) v1 + (Integer) v2)
250+
);
251+
}
245252
}

‎x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/QueryRulesIndexService.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,7 @@ private static QueryRulesetListItem hitToQueryRulesetListItem(SearchHit searchHi
445445
final List<LinkedHashMap<?, ?>> rules = ((List<LinkedHashMap<?, ?>>) sourceMap.get(QueryRuleset.RULES_FIELD.getPreferredName()));
446446
final int numRules = rules.size();
447447
final Map<QueryRuleCriteriaType, Integer> queryRuleCriteriaTypeToCountMap = new EnumMap<>(QueryRuleCriteriaType.class);
448+
final Map<QueryRule.QueryRuleType, Integer> ruleTypeToCountMap = new EnumMap<>(QueryRule.QueryRuleType.class);
448449
for (LinkedHashMap<?, ?> rule : rules) {
449450
@SuppressWarnings("unchecked")
450451
List<LinkedHashMap<?, ?>> criteriaList = ((List<LinkedHashMap<?, ?>>) rule.get(QueryRule.CRITERIA_FIELD.getPreferredName()));
@@ -453,9 +454,12 @@ private static QueryRulesetListItem hitToQueryRulesetListItem(SearchHit searchHi
453454
final QueryRuleCriteriaType queryRuleCriteriaType = QueryRuleCriteriaType.type(criteriaType);
454455
queryRuleCriteriaTypeToCountMap.compute(queryRuleCriteriaType, (k, v) -> v == null ? 1 : v + 1);
455456
}
457+
final String ruleType = ((String) rule.get(QueryRule.TYPE_FIELD.getPreferredName()));
458+
final QueryRule.QueryRuleType queryRuleType = QueryRule.QueryRuleType.queryRuleType(ruleType);
459+
ruleTypeToCountMap.compute(queryRuleType, (k, v) -> v == null ? 1 : v + 1);
456460
}
457461

458-
return new QueryRulesetListItem(rulesetId, numRules, queryRuleCriteriaTypeToCountMap);
462+
return new QueryRulesetListItem(rulesetId, numRules, queryRuleCriteriaTypeToCountMap, ruleTypeToCountMap);
459463
}
460464

461465
public record QueryRulesetResult(List<QueryRulesetListItem> rulesets, long totalResults) {}

‎x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/QueryRulesetListItem.java‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@ public class QueryRulesetListItem implements Writeable, ToXContentObject {
3232
public static final ParseField RULESET_ID_FIELD = new ParseField("ruleset_id");
3333
public static final ParseField RULE_TOTAL_COUNT_FIELD = new ParseField("rule_total_count");
3434
public static final ParseField RULE_CRITERIA_TYPE_COUNTS_FIELD = new ParseField("rule_criteria_types_counts");
35+
public static final ParseField RULE_TYPE_COUNTS_FIELD = new ParseField("rule_type_counts");
3536

3637
private final String rulesetId;
3738
private final int ruleTotalCount;
3839
private final Map<QueryRuleCriteriaType, Integer> criteriaTypeToCountMap;
40+
private final Map<QueryRule.QueryRuleType, Integer> ruleTypeToCountMap;
3941

4042
/**
4143
* Constructs a QueryRulesetListItem.
@@ -44,11 +46,17 @@ public class QueryRulesetListItem implements Writeable, ToXContentObject {
4446
* @param ruleTotalCount The number of rules contained within the ruleset.
4547
* @param criteriaTypeToCountMap A map of criteria type to the number of rules of that type.
4648
*/
47-
public QueryRulesetListItem(String rulesetId, int ruleTotalCount, Map<QueryRuleCriteriaType, Integer> criteriaTypeToCountMap) {
49+
public QueryRulesetListItem(
50+
String rulesetId,
51+
int ruleTotalCount,
52+
Map<QueryRuleCriteriaType, Integer> criteriaTypeToCountMap,
53+
Map<QueryRule.QueryRuleType, Integer> ruleTypeToCountMap
54+
) {
4855
Objects.requireNonNull(rulesetId, "rulesetId cannot be null on a QueryRuleListItem");
4956
this.rulesetId = rulesetId;
5057
this.ruleTotalCount = ruleTotalCount;
5158
this.criteriaTypeToCountMap = criteriaTypeToCountMap;
59+
this.ruleTypeToCountMap = ruleTypeToCountMap;
5260
}
5361

5462
public QueryRulesetListItem(StreamInput in) throws IOException {
@@ -59,6 +67,11 @@ public QueryRulesetListItem(StreamInput in) throws IOException {
5967
} else {
6068
this.criteriaTypeToCountMap = Map.of();
6169
}
70+
if (in.getTransportVersion().onOrAfter(TransportVersions.QUERY_RULES_LIST_INCLUDES_TYPES)) {
71+
this.ruleTypeToCountMap = in.readMap(m -> in.readEnum(QueryRule.QueryRuleType.class), StreamInput::readInt);
72+
} else {
73+
this.ruleTypeToCountMap = Map.of();
74+
}
6275
}
6376

6477
@Override
@@ -71,6 +84,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
7184
builder.field(criteriaType.name().toLowerCase(Locale.ROOT), criteriaTypeToCountMap.get(criteriaType));
7285
}
7386
builder.endObject();
87+
builder.startObject(RULE_TYPE_COUNTS_FIELD.getPreferredName());
88+
for (QueryRule.QueryRuleType ruleType : ruleTypeToCountMap.keySet()) {
89+
builder.field(ruleType.name().toLowerCase(Locale.ROOT), ruleTypeToCountMap.get(ruleType));
90+
}
91+
builder.endObject();
7492
builder.endObject();
7593
return builder;
7694
}
@@ -82,6 +100,9 @@ public void writeTo(StreamOutput out) throws IOException {
82100
if (out.getTransportVersion().onOrAfter(EXPANDED_RULESET_COUNT_TRANSPORT_VERSION)) {
83101
out.writeMap(criteriaTypeToCountMap, StreamOutput::writeEnum, StreamOutput::writeInt);
84102
}
103+
if (out.getTransportVersion().onOrAfter(TransportVersions.QUERY_RULES_LIST_INCLUDES_TYPES)) {
104+
out.writeMap(ruleTypeToCountMap, StreamOutput::writeEnum, StreamOutput::writeInt);
105+
}
85106
}
86107

87108
/**
@@ -106,18 +127,23 @@ public Map<QueryRuleCriteriaType, Integer> criteriaTypeToCountMap() {
106127
return criteriaTypeToCountMap;
107128
}
108129

130+
public Map<QueryRule.QueryRuleType, Integer> ruleTypeToCountMap() {
131+
return ruleTypeToCountMap;
132+
}
133+
109134
@Override
110135
public boolean equals(Object o) {
111136
if (this == o) return true;
112137
if (o == null || getClass() != o.getClass()) return false;
113138
QueryRulesetListItem that = (QueryRulesetListItem) o;
114139
return ruleTotalCount == that.ruleTotalCount
115140
&& Objects.equals(rulesetId, that.rulesetId)
116-
&& Objects.equals(criteriaTypeToCountMap, that.criteriaTypeToCountMap);
141+
&& Objects.equals(criteriaTypeToCountMap, that.criteriaTypeToCountMap)
142+
&& Objects.equals(ruleTypeToCountMap, that.ruleTypeToCountMap);
117143
}
118144

119145
@Override
120146
public int hashCode() {
121-
return Objects.hash(rulesetId, ruleTotalCount, criteriaTypeToCountMap);
147+
return Objects.hash(rulesetId, ruleTotalCount, criteriaTypeToCountMap, ruleTypeToCountMap);
122148
}
123149
}

‎x-pack/plugin/ent-search/src/main/java/org/elasticsearch/xpack/application/rules/action/ListQueryRulesetsAction.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import org.elasticsearch.action.ActionType;
1414
import org.elasticsearch.common.io.stream.StreamInput;
1515
import org.elasticsearch.common.io.stream.StreamOutput;
16+
import org.elasticsearch.features.NodeFeature;
1617
import org.elasticsearch.xcontent.ConstructingObjectParser;
1718
import org.elasticsearch.xcontent.ParseField;
1819
import org.elasticsearch.xcontent.ToXContentObject;
@@ -33,6 +34,8 @@ public class ListQueryRulesetsAction {
3334
public static final String NAME = "cluster:admin/xpack/query_rules/list";
3435
public static final ActionType<ListQueryRulesetsAction.Response> INSTANCE = new ActionType<>(NAME);
3536

37+
public static final NodeFeature QUERY_RULE_LIST_TYPES = new NodeFeature("query_rule_list_types");
38+
3639
private ListQueryRulesetsAction() {/* no instances */}
3740

3841
public static class Request extends ActionRequest implements ToXContentObject {

0 commit comments

Comments
 (0)