Skip to content

Commit b6ebe31

Browse files
thecoopthecoop
committed
Rename to phase failures
1 parent bb60050 commit b6ebe31

File tree

21 files changed

+108
-108
lines changed

21 files changed

+108
-108
lines changed

‎client/client-benchmark-noop-api-plugin/src/main/java/org/elasticsearch/plugin/noop/action/search/TransportNoopSearchAction.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import org.elasticsearch.action.search.SearchRequest;
1313
import org.elasticsearch.action.search.SearchResponse;
1414
import org.elasticsearch.action.search.ShardSearchFailure;
15-
import org.elasticsearch.action.search.SubsidiaryFailure;
15+
import org.elasticsearch.action.search.PhaseFailure;
1616
import org.elasticsearch.action.support.ActionFilters;
1717
import org.elasticsearch.action.support.HandledTransportAction;
1818
import org.elasticsearch.common.util.concurrent.EsExecutors;
@@ -56,7 +56,7 @@ protected void doExecute(Task task, SearchRequest request, ActionListener<Search
5656
0,
5757
0,
5858
ShardSearchFailure.EMPTY_ARRAY,
59-
SubsidiaryFailure.EMPTY_ARRAY,
59+
PhaseFailure.EMPTY_ARRAY,
6060
SearchResponse.Clusters.EMPTY
6161
)
6262
);

‎docs/changelog/122788.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
pr: 122788
2-
summary: Add subsidiary failures to search responses
2+
summary: Add phase failures to search responses
33
area: Ranking
44
type: enhancement
55
issues:

‎modules/lang-mustache/src/test/java/org/elasticsearch/script/mustache/SearchTemplateResponseTests.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import org.apache.lucene.search.TotalHits;
1313
import org.elasticsearch.action.search.SearchResponse;
1414
import org.elasticsearch.action.search.ShardSearchFailure;
15-
import org.elasticsearch.action.search.SubsidiaryFailure;
15+
import org.elasticsearch.action.search.PhaseFailure;
1616
import org.elasticsearch.common.bytes.BytesReference;
1717
import org.elasticsearch.common.xcontent.XContentHelper;
1818
import org.elasticsearch.search.SearchHit;
@@ -202,7 +202,7 @@ public void testSearchResponseToXContent() throws IOException {
202202
0,
203203
0,
204204
ShardSearchFailure.EMPTY_ARRAY,
205-
SubsidiaryFailure.EMPTY_ARRAY,
205+
PhaseFailure.EMPTY_ARRAY,
206206
SearchResponse.Clusters.EMPTY
207207
);
208208

‎server/src/main/java/org/elasticsearch/action/search/AbstractSearchAsyncAction.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ abstract class AbstractSearchAsyncAction<Result extends SearchPhaseResult> exten
9292
private final AtomicInteger successfulOps = new AtomicInteger();
9393
private final SearchTimeProvider timeProvider;
9494
private final SearchResponse.Clusters clusters;
95-
private final List<SubsidiaryFailure> subsidiaryFailures = Collections.synchronizedList(new ArrayList<>());
95+
private final List<PhaseFailure> phaseFailures = Collections.synchronizedList(new ArrayList<>());
9696

9797
protected final List<SearchShardIterator> toSkipShardsIts;
9898
protected final List<SearchShardIterator> shardsIts;
@@ -575,7 +575,7 @@ public boolean isPartOfPointInTime(ShardSearchContextId contextId) {
575575
private SearchResponse buildSearchResponse(
576576
SearchResponseSections internalSearchResponse,
577577
ShardSearchFailure[] failures,
578-
SubsidiaryFailure[] subsidiaryFailures,
578+
PhaseFailure[] phaseFailures,
579579
String scrollId,
580580
BytesReference searchContextId
581581
) {
@@ -591,7 +591,7 @@ private SearchResponse buildSearchResponse(
591591
toSkipShardsIts.size(),
592592
buildTookInMillis(),
593593
failures,
594-
subsidiaryFailures,
594+
phaseFailures,
595595
clusters,
596596
searchContextId
597597
);
@@ -628,7 +628,7 @@ public void sendSearchResponse(SearchResponseSections internalSearchResponse, At
628628
}
629629
}
630630

631-
SubsidiaryFailure[] subFailures = subsidiaryFailures.toArray(SubsidiaryFailure.EMPTY_ARRAY);
631+
PhaseFailure[] subFailures = phaseFailures.toArray(PhaseFailure.EMPTY_ARRAY);
632632

633633
ActionListener.respondAndRelease(
634634
listener,
@@ -671,8 +671,8 @@ private void raisePhaseFailure(SearchPhaseExecutionException exception) {
671671
listener.onFailure(exception);
672672
}
673673

674-
public void addSubsidiaryFailure(String description, Exception exception) {
675-
subsidiaryFailures.add(new SubsidiaryFailure(description, exception));
674+
public void addPhaseFailure(String phase, Exception exception) {
675+
phaseFailures.add(new PhaseFailure(phase, exception));
676676
}
677677

678678
/**

‎server/src/main/java/org/elasticsearch/action/search/SubsidiaryFailure.java‎ renamed to ‎server/src/main/java/org/elasticsearch/action/search/PhaseFailure.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818

1919
import java.io.IOException;
2020

21-
public record SubsidiaryFailure(String phase, Exception failure) implements ToXContentObject, Writeable {
21+
public record PhaseFailure(String phase, Exception failure) implements ToXContentObject, Writeable {
2222
public static final String PHASE_FIELD = "phase";
2323
public static final String FAILURE_FIELD = "failure";
2424

25-
public static final SubsidiaryFailure[] EMPTY_ARRAY = new SubsidiaryFailure[0];
25+
public static final PhaseFailure[] EMPTY_ARRAY = new PhaseFailure[0];
2626

27-
public SubsidiaryFailure(StreamInput in) throws IOException {
27+
public PhaseFailure(StreamInput in) throws IOException {
2828
this(in.readString(), in.readException());
2929
}
3030

‎server/src/main/java/org/elasticsearch/action/search/RankFeaturePhase.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public void onFailure(Exception e) {
201201
if (rankFeaturePhaseRankCoordinatorContext.failuresAllowed()) {
202202
// don't want to log the entire stack trace, it's not helpful here
203203
logger.warn("Exception computing updated ranks, continuing with existing ranks: {}", e.toString());
204-
context.addSubsidiaryFailure("reranking", e);
204+
context.addPhaseFailure("reranking", e);
205205

206206
// use the existing score docs as-is
207207
// downstream things expect every doc to have a score, so we need to infer a score here

‎server/src/main/java/org/elasticsearch/action/search/SearchResponse.java‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public class SearchResponse extends ActionResponse implements ChunkedToXContentO
6969
public static final ParseField TIMED_OUT = new ParseField("timed_out");
7070
public static final ParseField TERMINATED_EARLY = new ParseField("terminated_early");
7171
public static final ParseField NUM_REDUCE_PHASES = new ParseField("num_reduce_phases");
72-
public static final ParseField SUBSIDIARY_FAILURES = new ParseField("subsidiaryFailures");
72+
public static final ParseField PHASE_FAILURES = new ParseField("phase_failures");
7373

7474
private final SearchHits hits;
7575
private final InternalAggregations aggregations;
@@ -84,7 +84,7 @@ public class SearchResponse extends ActionResponse implements ChunkedToXContentO
8484
private final int successfulShards;
8585
private final int skippedShards;
8686
private final ShardSearchFailure[] shardFailures;
87-
private final SubsidiaryFailure[] subsidiaryFailures;
87+
private final PhaseFailure[] phaseFailures;
8888
private final Clusters clusters;
8989
private final long tookInMillis;
9090

@@ -106,12 +106,12 @@ public SearchResponse(StreamInput in) throws IOException {
106106
s -> s == 0 ? ShardSearchFailure.EMPTY_ARRAY : new ShardSearchFailure[s]
107107
);
108108
if (in.getTransportVersion().onOrAfter(TransportVersions.SEARCH_SUBSIDIARY_FAILURES)) {
109-
subsidiaryFailures = in.readArray(
110-
SubsidiaryFailure::new,
111-
s -> s == 0 ? SubsidiaryFailure.EMPTY_ARRAY : new SubsidiaryFailure[s]
109+
phaseFailures = in.readArray(
110+
PhaseFailure::new,
111+
s -> s == 0 ? PhaseFailure.EMPTY_ARRAY : new PhaseFailure[s]
112112
);
113113
} else {
114-
subsidiaryFailures = SubsidiaryFailure.EMPTY_ARRAY;
114+
phaseFailures = PhaseFailure.EMPTY_ARRAY;
115115
}
116116
clusters = new Clusters(in);
117117
scrollId = in.readOptionalString();
@@ -134,7 +134,7 @@ public SearchResponse(
134134
int skippedShards,
135135
long tookInMillis,
136136
ShardSearchFailure[] shardFailures,
137-
SubsidiaryFailure[] subsidiaryFailures,
137+
PhaseFailure[] phaseFailures,
138138
Clusters clusters
139139
) {
140140
this(
@@ -151,7 +151,7 @@ public SearchResponse(
151151
skippedShards,
152152
tookInMillis,
153153
shardFailures,
154-
subsidiaryFailures,
154+
phaseFailures,
155155
clusters,
156156
null
157157
);
@@ -165,7 +165,7 @@ public SearchResponse(
165165
int skippedShards,
166166
long tookInMillis,
167167
ShardSearchFailure[] shardFailures,
168-
SubsidiaryFailure[] subsidiaryFailures,
168+
PhaseFailure[] phaseFailures,
169169
Clusters clusters,
170170
BytesReference pointInTimeId
171171
) {
@@ -183,7 +183,7 @@ public SearchResponse(
183183
skippedShards,
184184
tookInMillis,
185185
shardFailures,
186-
subsidiaryFailures,
186+
phaseFailures,
187187
clusters,
188188
pointInTimeId
189189
);
@@ -203,7 +203,7 @@ public SearchResponse(
203203
int skippedShards,
204204
long tookInMillis,
205205
ShardSearchFailure[] shardFailures,
206-
SubsidiaryFailure[] subsidiaryFailures,
206+
PhaseFailure[] phaseFailures,
207207
Clusters clusters,
208208
BytesReference pointInTimeId
209209
) {
@@ -223,7 +223,7 @@ public SearchResponse(
223223
this.skippedShards = skippedShards;
224224
this.tookInMillis = tookInMillis;
225225
this.shardFailures = shardFailures;
226-
this.subsidiaryFailures = subsidiaryFailures;
226+
this.phaseFailures = phaseFailures;
227227
assert skippedShards <= totalShards : "skipped: " + skippedShards + " total: " + totalShards;
228228
assert scrollId == null || pointInTimeId == null
229229
: "SearchResponse can't have both scrollId [" + scrollId + "] and searchContextId [" + pointInTimeId + "]";
@@ -353,10 +353,10 @@ public ShardSearchFailure[] getShardFailures() {
353353
}
354354

355355
/**
356-
* The failures that occurred that did not stop results from being returned.
356+
* The failures that occurred with specific phases that did not stop results from being returned.
357357
*/
358-
public SubsidiaryFailure[] getSubsidiaryFailures() {
359-
return subsidiaryFailures;
358+
public PhaseFailure[] getPhaseFailures() {
359+
return phaseFailures;
360360
}
361361

362362
/**
@@ -409,9 +409,9 @@ public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params
409409
public Iterator<? extends ToXContent> innerToXContentChunked(ToXContent.Params params) {
410410
return Iterators.concat(
411411
ChunkedToXContentHelper.chunk(SearchResponse.this::headerToXContent),
412-
CollectionUtils.isEmpty(subsidiaryFailures)
412+
CollectionUtils.isEmpty(phaseFailures)
413413
? Collections.emptyIterator()
414-
: ChunkedToXContentHelper.array(SUBSIDIARY_FAILURES.getPreferredName(), Iterators.forArray(subsidiaryFailures)),
414+
: ChunkedToXContentHelper.array(PHASE_FAILURES.getPreferredName(), Iterators.forArray(phaseFailures)),
415415
Iterators.single(clusters),
416416
Iterators.concat(
417417
hits.toXContentChunked(params),
@@ -466,7 +466,7 @@ public void writeTo(StreamOutput out) throws IOException {
466466
out.writeVInt(successfulShards);
467467
out.writeArray(shardFailures);
468468
if (out.getTransportVersion().onOrAfter(TransportVersions.SEARCH_SUBSIDIARY_FAILURES)) {
469-
out.writeArray(subsidiaryFailures);
469+
out.writeArray(phaseFailures);
470470
}
471471
clusters.writeTo(out);
472472
out.writeOptionalString(scrollId);
@@ -1181,7 +1181,7 @@ public static SearchResponse empty(Supplier<Long> tookInMillisSupplier, Clusters
11811181
0,
11821182
tookInMillisSupplier.get(),
11831183
ShardSearchFailure.EMPTY_ARRAY,
1184-
SubsidiaryFailure.EMPTY_ARRAY,
1184+
PhaseFailure.EMPTY_ARRAY,
11851185
clusters,
11861186
null
11871187
);

‎server/src/main/java/org/elasticsearch/action/search/SearchResponseMerger.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public SearchResponse getMergedResponse(Clusters clusters) {
129129
// the current reduce phase counts as one
130130
int numReducePhases = 1;
131131
List<ShardSearchFailure> failures = new ArrayList<>();
132-
List<SubsidiaryFailure> subsidiaryFailures = new ArrayList<>();
132+
List<PhaseFailure> phaseFailures = new ArrayList<>();
133133
Map<String, SearchProfileShardResult> profileResults = new HashMap<>();
134134
List<InternalAggregations> aggs = new ArrayList<>();
135135
Map<ShardIdAndClusterAlias, Integer> shards = new TreeMap<>();
@@ -146,7 +146,7 @@ public SearchResponse getMergedResponse(Clusters clusters) {
146146
numReducePhases += searchResponse.getNumReducePhases();
147147

148148
Collections.addAll(failures, searchResponse.getShardFailures());
149-
Collections.addAll(subsidiaryFailures, searchResponse.getSubsidiaryFailures());
149+
Collections.addAll(phaseFailures, searchResponse.getPhaseFailures());
150150

151151
profileResults.putAll(searchResponse.getProfileResults());
152152

@@ -215,7 +215,7 @@ public SearchResponse getMergedResponse(Clusters clusters) {
215215
? InternalAggregations.EMPTY
216216
: InternalAggregations.topLevelReduce(aggs, aggReduceContextBuilder.forFinalReduction());
217217
ShardSearchFailure[] shardFailures = failures.toArray(ShardSearchFailure.EMPTY_ARRAY);
218-
SubsidiaryFailure[] subFailures = subsidiaryFailures.toArray(SubsidiaryFailure.EMPTY_ARRAY);
218+
PhaseFailure[] subFailures = phaseFailures.toArray(PhaseFailure.EMPTY_ARRAY);
219219
SearchProfileResults profileShardResults = profileResults.isEmpty() ? null : new SearchProfileResults(profileResults);
220220
// make failures ordering consistent between ordinary search and CCS by looking at the shard they come from
221221
Arrays.sort(shardFailures, FAILURES_COMPARATOR);

‎server/src/main/java/org/elasticsearch/action/search/SearchScrollAsyncAction.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ abstract class SearchScrollAsyncAction<T extends SearchPhaseResult> {
5555
protected final SearchTransportService searchTransportService;
5656
private final long startTime;
5757
private final List<ShardSearchFailure> shardFailures = new ArrayList<>();
58-
private final List<SubsidiaryFailure> subsidiaryFailures = new ArrayList<>();
58+
private final List<PhaseFailure> phaseFailures = new ArrayList<>();
5959
private final AtomicInteger successfulOps;
6060

6161
protected SearchScrollAsyncAction(
@@ -214,8 +214,8 @@ synchronized ShardSearchFailure[] buildShardFailures() { // pkg private for test
214214
return shardFailures.toArray(ShardSearchFailure.EMPTY_ARRAY);
215215
}
216216

217-
synchronized SubsidiaryFailure[] buildSubsidiaryFailures() {
218-
return subsidiaryFailures.toArray(SubsidiaryFailure.EMPTY_ARRAY);
217+
synchronized PhaseFailure[] buildPhaseFailures() {
218+
return phaseFailures.toArray(PhaseFailure.EMPTY_ARRAY);
219219
}
220220

221221
// we do our best to return the shard failures, but its ok if its not fully concurrently safe
@@ -268,7 +268,7 @@ protected final void sendResponse(
268268
0,
269269
buildTookInMillis(),
270270
buildShardFailures(),
271-
buildSubsidiaryFailures(),
271+
buildPhaseFailures(),
272272
SearchResponse.Clusters.EMPTY,
273273
null
274274
)

‎server/src/main/java/org/elasticsearch/action/search/TransportSearchAction.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ public void onResponse(SearchResponse searchResponse) {
691691
searchResponse.getSkippedShards(),
692692
timeProvider.buildTookInMillis(),
693693
searchResponse.getShardFailures(),
694-
searchResponse.getSubsidiaryFailures(),
694+
searchResponse.getPhaseFailures(),
695695
clusters,
696696
searchResponse.pointInTimeId()
697697
)

0 commit comments

Comments
 (0)