Skip to content

Bugfix: Disable eager loading BitSetFilterCache on Indexing Nodes #105791

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
JVerwolf merged 9 commits into from
Mar 5, 2024
Merged

Bugfix: Disable eager loading BitSetFilterCache on Indexing Nodes #105791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cb6aa73
Disable eager loading BitSetCache on Indexing Nodes
JVerwolf Feb 23, 2024
19c7127
spotless
JVerwolf Feb 23, 2024
bcbe203
Update condition to check for stateless
JVerwolf Feb 23, 2024
871e414
spotless
JVerwolf Feb 23, 2024
544540a
Update docs/changelog/105791.yaml
JVerwolf Feb 23, 2024
83f1270
PR Feedback: reorder conditionals
JVerwolf Feb 27, 2024
ba4ce6b
Merge branch 'bugfix/BitSetFilterCache' of github.com:JVerwolf/elasti…
JVerwolf Feb 27, 2024
8815e4a
Merge branch 'main' into bugfix/BitSetFilterCache
elasticmachine Mar 5, 2024
23fcd79
Update docs/changelog/105791.yaml
JVerwolf Mar 5, 2024
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
5 changes: 5 additions & 0 deletions docs/changelog/105791.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 105791
summary: "Bugfix: Disable eager loading `BitSetFilterCache` on Indexing Nodes"
area: Search
type: bug
issues: []
18 changes: 17 additions & 1 deletion server/src/main/java/org/elasticsearch/index/cache/bitset/BitsetFilterCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
import org.apache.lucene.util.BitDocIdSet;
import org.apache.lucene.util.BitSet;
import org.elasticsearch.ExceptionsHelper;
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.cluster.node.DiscoveryNodeRole;
import org.elasticsearch.common.cache.Cache;
import org.elasticsearch.common.cache.CacheBuilder;
import org.elasticsearch.common.cache.RemovalListener;
Expand Down Expand Up @@ -55,6 +57,8 @@
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;

import static org.elasticsearch.index.IndexSettings.INDEX_FAST_REFRESH_SETTING;

/**
* This is a cache for {@link BitDocIdSet} based filters and is unbounded by size or time.
* <p>
Expand Down Expand Up @@ -92,10 +96,22 @@ public BitsetFilterCache(IndexSettings indexSettings, Listener listener) {
throw new IllegalArgumentException("listener must not be null");
}
this.index = indexSettings.getIndex();
this.loadRandomAccessFiltersEagerly = indexSettings.getValue(INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING);
this.loadRandomAccessFiltersEagerly = shouldLoadRandomAccessFiltersEagerly(indexSettings);
this.listener = listener;
}

static boolean shouldLoadRandomAccessFiltersEagerly(IndexSettings settings) {
boolean loadFiltersEagerlySetting = settings.getValue(INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING);
boolean isStateless = DiscoveryNode.isStateless(settings.getNodeSettings());
if (isStateless) {
return DiscoveryNode.hasRole(settings.getNodeSettings(), DiscoveryNodeRole.INDEX_ROLE)
&& loadFiltersEagerlySetting
&& INDEX_FAST_REFRESH_SETTING.get(settings.getSettings());
} else {
return loadFiltersEagerlySetting;
}
}

public static BitSet bitsetFromQuery(Query query, LeafReaderContext context) throws IOException {
final IndexReaderContext topLevelContext = ReaderUtil.getTopLevelContext(context);
final IndexSearcher searcher = new IndexSearcher(topLevelContext);
Expand Down
57 changes: 57 additions & 0 deletions server/src/test/java/org/elasticsearch/index/cache/bitset/BitSetFilterCacheTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,27 @@
import org.apache.lucene.store.Directory;
import org.apache.lucene.util.Accountable;
import org.apache.lucene.util.BitSet;
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.cluster.node.DiscoveryNodeRole;
import org.elasticsearch.common.lucene.index.ElasticsearchDirectoryReader;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.IOUtils;
import org.elasticsearch.index.Index;
import org.elasticsearch.index.IndexSettings;
import org.elasticsearch.index.shard.ShardId;
import org.elasticsearch.lucene.util.MatchAllBitSet;
import org.elasticsearch.node.NodeRoleSettings;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.test.IndexSettingsModule;

import java.io.IOException;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;

import static org.elasticsearch.cluster.node.DiscoveryNode.STATELESS_ENABLED_SETTING_NAME;
import static org.elasticsearch.index.IndexSettings.INDEX_FAST_REFRESH_SETTING;
import static org.elasticsearch.index.cache.bitset.BitsetFilterCache.INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.Matchers.hasSize;
Expand Down Expand Up @@ -259,4 +267,53 @@ public void onRemoval(ShardId shardId, Accountable accountable) {
}
}

public void testShouldLoadRandomAccessFiltersEagerly() {
var values = List.of(true, false);
for (var hasIndexRole : values) {
for (var indexFastRefresh : values) {
for (var loadFiltersEagerly : values) {
for (var isStateless : values) {
if (isStateless) {
assertEquals(
loadFiltersEagerly && indexFastRefresh && hasIndexRole,
BitsetFilterCache.shouldLoadRandomAccessFiltersEagerly(
bitsetFilterCacheSettings(isStateless, hasIndexRole, loadFiltersEagerly, indexFastRefresh)
)
);
} else {
assertEquals(
loadFiltersEagerly,
BitsetFilterCache.shouldLoadRandomAccessFiltersEagerly(
bitsetFilterCacheSettings(isStateless, hasIndexRole, loadFiltersEagerly, indexFastRefresh)
)
);
}
}
}
}
}
}
Copy link
Contributor Author

@JVerwolf JVerwolf Feb 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spent a bunch of time working on an integration test for this to check cache warming behaviour (see this diff: https://github.com/JVerwolf/elasticsearch/compare/bugfix/BitSetFilterCache...JVerwolf:elasticsearch:bugfix/BitSetFilterCache-IT-save2?expand=1#).

However, I ran into issues updating system indices and decided it wasn't worth the effort.


private IndexSettings bitsetFilterCacheSettings(
boolean isStateless,
boolean hasIndexRole,
boolean loadFiltersEagerly,
boolean indexFastRefresh
) {
var indexSettingsBuilder = Settings.builder().put(INDEX_LOAD_RANDOM_ACCESS_FILTERS_EAGERLY_SETTING.getKey(), loadFiltersEagerly);
if (isStateless) indexSettingsBuilder.put(INDEX_FAST_REFRESH_SETTING.getKey(), indexFastRefresh);

var nodeSettingsBuilder = Settings.builder()
.putList(
NodeRoleSettings.NODE_ROLES_SETTING.getKey(),
hasIndexRole ? DiscoveryNodeRole.INDEX_ROLE.roleName() : DiscoveryNodeRole.SEARCH_ROLE.roleName()
)
.put(STATELESS_ENABLED_SETTING_NAME, isStateless);

return IndexSettingsModule.newIndexSettings(
new Index("index", IndexMetadata.INDEX_UUID_NA_VALUE),
indexSettingsBuilder.build(),
nodeSettingsBuilder.build()
);
}
}