Skip to content

ShardSearchStatsTests - add missing metrics and methods #129311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 20, 2025
Merged

ShardSearchStatsTests - add missing metrics and methods #129311

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83c9b3e
Add missing metrics and methods
drempapis Jun 11, 2025
68b63ff
Merge branch 'main' into add_coverate_to_shard_search_stats
drempapis Jun 12, 2025
f4ae8af
[CI] Auto commit changes from spotless
Jun 12, 2025
67e1673
Merge branch 'main' into add_coverate_to_shard_search_stats
drempapis Jun 18, 2025
4c1fe68
Merge branch 'main' into add_coverate_to_shard_search_stats
drempapis Jun 19, 2025
c420cd0
Merge branch 'main' into add_coverate_to_shard_search_stats
drempapis Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 88 additions & 2 deletions server/src/test/java/org/elasticsearch/search/stats/ShardSearchStatsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,27 @@
import org.elasticsearch.index.search.stats.SearchStats;
import org.elasticsearch.index.search.stats.SearchStatsSettings;
import org.elasticsearch.index.search.stats.ShardSearchStats;
import org.elasticsearch.index.shard.IndexShard;
import org.elasticsearch.index.shard.IndexShardTestCase;
import org.elasticsearch.index.shard.ShardId;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.elasticsearch.search.internal.AliasFilter;
import org.elasticsearch.search.internal.ReaderContext;
import org.elasticsearch.search.internal.SearchContext;
import org.elasticsearch.search.internal.ShardSearchContextId;
import org.elasticsearch.search.internal.ShardSearchRequest;
import org.elasticsearch.search.suggest.SuggestBuilder;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.test.TestSearchContext;
import org.junit.Before;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.TimeUnit;

public class ShardSearchStatsTests extends ESTestCase {
public class ShardSearchStatsTests extends IndexShardTestCase {

private static final long TEN_MILLIS = 10;

Expand All @@ -57,6 +61,9 @@ public void testQueryPhase() {
shardSearchStatsListener.onQueryPhase(sc, TimeUnit.MILLISECONDS.toNanos(TEN_MILLIS));

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getQueryCurrent());
assertEquals(1, stats.getQueryCount());
assertEquals(TEN_MILLIS, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -67,6 +74,12 @@ public void testQueryPhase_SuggestOnly() {
shardSearchStatsListener.onQueryPhase(sc, TimeUnit.MILLISECONDS.toNanos(TEN_MILLIS));

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getSuggestCurrent());
assertEquals(1, stats.getSuggestCount());
assertEquals(TEN_MILLIS, stats.getSuggestTimeInMillis());
assertEquals(0, stats.getQueryCurrent());
assertEquals(0, stats.getQueryCount());
assertEquals(0, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -78,9 +91,15 @@ public void testQueryPhase_withGroup() {

SearchStats searchStats = shardSearchStatsListener.stats("_all");
SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getQueryCurrent());
assertEquals(1, stats.getQueryCount());
assertEquals(TEN_MILLIS, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);

stats = Objects.requireNonNull(searchStats.getGroupStats()).get("group1");
assertEquals(0, stats.getQueryCurrent());
assertEquals(1, stats.getQueryCount());
assertEquals(TEN_MILLIS, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -93,9 +112,21 @@ public void testQueryPhase_withGroup_SuggestOnly() {

SearchStats searchStats = shardSearchStatsListener.stats("_all");
SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getSuggestCurrent());
assertEquals(1, stats.getSuggestCount());
assertEquals(TEN_MILLIS, stats.getSuggestTimeInMillis());
assertEquals(0, stats.getQueryCurrent());
assertEquals(0, stats.getQueryCount());
assertEquals(0, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);

stats = Objects.requireNonNull(searchStats.getGroupStats()).get("group1");
assertEquals(0, stats.getSuggestCurrent());
assertEquals(1, stats.getSuggestCount());
assertEquals(TEN_MILLIS, stats.getSuggestTimeInMillis());
assertEquals(0, stats.getQueryCurrent());
assertEquals(0, stats.getQueryCount());
assertEquals(0, stats.getQueryTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -106,6 +137,11 @@ public void testQueryPhase_SuggestOnly_Failure() {
shardSearchStatsListener.onFailedQueryPhase(sc);

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getSuggestCurrent());
assertEquals(0, stats.getSuggestCount());
assertEquals(0, stats.getQueryCurrent());
assertEquals(0, stats.getQueryCount());
assertEquals(0, stats.getQueryFailure());
assertEquals(0.0, stats.getSearchLoadRate(), 0);
}
}
Expand All @@ -116,6 +152,9 @@ public void testQueryPhase_Failure() {
shardSearchStatsListener.onFailedQueryPhase(sc);

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getQueryCurrent());
assertEquals(0, stats.getQueryCount());
assertEquals(1, stats.getQueryFailure());
assertEquals(0.0, stats.getSearchLoadRate(), 0);
}
}
Expand All @@ -126,6 +165,9 @@ public void testFetchPhase() {
shardSearchStatsListener.onFetchPhase(sc, TimeUnit.MILLISECONDS.toNanos(TEN_MILLIS));

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getFetchCurrent());
assertEquals(1, stats.getFetchCount());
assertEquals(TEN_MILLIS, stats.getFetchTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -137,9 +179,15 @@ public void testFetchPhase_withGroup() {

SearchStats searchStats = shardSearchStatsListener.stats("_all");
SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getFetchCurrent());
assertEquals(1, stats.getFetchCount());
assertEquals(TEN_MILLIS, stats.getFetchTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);

stats = Objects.requireNonNull(searchStats.getGroupStats()).get("group1");
assertEquals(0, stats.getFetchCurrent());
assertEquals(1, stats.getFetchCount());
assertEquals(TEN_MILLIS, stats.getFetchTimeInMillis());
assertTrue(stats.getSearchLoadRate() > 0.0);
}
}
Expand All @@ -150,10 +198,48 @@ public void testFetchPhase_Failure() {
shardSearchStatsListener.onFailedFetchPhase(sc);

SearchStats.Stats stats = shardSearchStatsListener.stats().getTotal();
assertEquals(0, stats.getFetchCurrent());
assertEquals(0, stats.getFetchCount());
assertEquals(1, stats.getFetchFailure());
assertEquals(0.0, stats.getSearchLoadRate(), 0);
}
}

public void testReaderContext() throws IOException {
IndexShard indexShard = newShard(true);
try (ReaderContext rc = createReaderContext(indexShard)) {
shardSearchStatsListener.onNewReaderContext(rc);
SearchStats stats = shardSearchStatsListener.stats();
assertEquals(1, stats.getOpenContexts());

shardSearchStatsListener.onFreeReaderContext(rc);
stats = shardSearchStatsListener.stats();
assertEquals(0, stats.getOpenContexts());
} finally {
closeShards(indexShard);
}
}

public void testScrollContext() throws IOException {
IndexShard indexShard = newShard(true);
try (ReaderContext rc = createReaderContext(indexShard)) {
shardSearchStatsListener.onNewScrollContext(rc);
SearchStats stats = shardSearchStatsListener.stats();
assertEquals(1, stats.getTotal().getScrollCurrent());

shardSearchStatsListener.onFreeScrollContext(rc);
stats = shardSearchStatsListener.stats();
assertEquals(0, stats.getTotal().getScrollCurrent());
assertEquals(1, stats.getTotal().getScrollCount());
} finally {
closeShards(indexShard);
}
}

private static ReaderContext createReaderContext(IndexShard indexShard) {
return new ReaderContext(new ShardSearchContextId("test", 1L), null, indexShard, null, 0L, false);
}

private static SearchContext createSearchContext(boolean suggested) {
IndexSettings indexSettings = new IndexSettings(
IndexMetadata.builder("index")
Expand Down