fix: update index template settings only when they change #37217
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9849cf6 to
70585e9
Compare
834d109 to
3aeb344
Compare
3aeb344 to
89223b6
Compare
EuroLew
approved these changes
Aug 27, 2025
| @@ -483,33 +491,46 @@ utils.new SchemaSettingsAppender(templateFile) | |||
| } | |||
| } | |||
|
|
|||
| private PutIndexTemplateRequest updateTemplateSettings( | |||
| private Optional<PutIndexTemplateRequest> buildTemplateSettingsUpdateRequestIfChanged( | |||
There was a problem hiding this comment.
🔧 A bit hard to understand I would prefer it be split up
private Optional<PutIndexTemplateRequest> buildTemplateSettingsUpdateRequestIfChanged(
final IndexTemplateDescriptor templateDescriptor,
final IndexConfiguration configuredSettings) {
try (final var templateFile = getResourceAsStream(templateDescriptor.getMappingsClasspathFilename())) {
final var currentTemplate = getIndexTemplateState(templateDescriptor);
final var configuredPriority = convertValue(configuredSettings.getTemplatePriority(), Long::valueOf);
final var newSettings = utils.new SchemaSettingsAppender(templateFile)
.withNumberOfShards(configuredSettings.getNumberOfShards())
.withNumberOfReplicas(configuredSettings.getNumberOfReplicas());
if (areTemplateSettingsEqualToConfigured(currentTemplate, configuredPriority, newSettings)) {
LOG.debug("Index template settings for [{}] are already up to date", templateDescriptor.getTemplateName());
return Optional.empty();
}
return Optional.of(buildPutIndexTemplateRequest(templateDescriptor, currentTemplate, newSettings, configuredPriority));
} catch (final IOException e) {
throw new SearchEngineException(
"Failed to load file " + templateDescriptor.getMappingsClasspathFilename() + " from classpath.", e);
}
}
private boolean areTemplateSettingsEqualToConfigured(IndexTemplateState currentTemplate, Long configuredPriority, SchemaSettingsAppender newSettings) {
return Objects.equals(configuredPriority, currentTemplate.priority())
&& newSettings.equalsSettings(serializeAsMap(currentTemplate.template().settings()));
}
private PutIndexTemplateRequest buildPutIndexTemplateRequest(
IndexTemplateDescriptor templateDescriptor,
IndexTemplateState currentTemplate,
SchemaSettingsAppender settingsAppender,
Long priority) {
final var updatedSettings = deserializeJson(IndexTemplateMapping._DESERIALIZER, settingsAppender.build()).settings();
LOG.debug("Applying to index template [{}]: settings={}, priority={}",
templateDescriptor.getTemplateName(), updatedSettings, priority);
return new PutIndexTemplateRequest.Builder()
.name(templateDescriptor.getTemplateName())
.indexPatterns(templateDescriptor.getIndexPattern())
.template(t -> t
.settings(updatedSettings)
.mappings(currentTemplate.template().mappings())
.aliases(currentTemplate.template().aliases()))
.priority(priority)
.build();
}
There was a problem hiding this comment.
Thanks for the hint, I tired to make it clearer now
I did not add though
private PutIndexTemplateRequest buildPutIndexTemplateRequest(
IndexTemplateDescriptor templateDescriptor,
IndexTemplateState currentTemplate,
SchemaSettingsAppender settingsAppender,
Long priority) {
I feel it is very specific and it is not reusable, I think it is clear enough now
fdca237 to
ac327bc
Compare
|
Successfully created backport PR for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Skip redundant index template settings PUTs for Elasticsearch/OpenSearch.
Adds parallel execution of index settings updates to cut overhead.
Problem
Every startup overwrote template settings (priority, shards, replicas) even when unchanged. This wasted requests, bumped ES/OS cluster.
Solution
Effects
Checklist
Related issues
closes #37240