Skip to content

Remove synthetic recovery source feature flag. #122615

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 12 commits into from
Mar 5, 2025
Merged

Remove synthetic recovery source feature flag. #122615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a9b4389
Remove synthetic recovery source feature flag.
martijnvg Feb 14, 2025
29e2cbf
Update docs/changelog/122615.yaml
martijnvg Feb 14, 2025
e690f1c
[CI] Auto commit changes from spotless
Feb 14, 2025
5ae904b
update changelog
martijnvg Feb 14, 2025
0988cba
iter tests
martijnvg Feb 17, 2025
be4ca81
Merge remote-tracking branch 'es/main' into remove_synthetic_source_r…
martijnvg Feb 17, 2025
c430a36
Merge remote-tracking branch 'es/main' into remove_synthetic_source_r…
martijnvg Feb 18, 2025
551c3e4
Merge remote-tracking branch 'es/main' into remove_synthetic_source_r…
martijnvg Mar 3, 2025
9e54bfb
Merge remote-tracking branch 'es/main' into remove_synthetic_source_r…
martijnvg Mar 4, 2025
7e9074d
iter
martijnvg Mar 4, 2025
5eb2047
Update docs/changelog/122615.yaml
martijnvg Mar 5, 2025
5eb32a1
Merge remote-tracking branch 'es/main' into remove_synthetic_source_r…
martijnvg Mar 5, 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
8 changes: 8 additions & 0 deletions docs/changelog/122615.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
pr: 122615
summary: Enable synthetic recovery source by default when synthetic source is enabled.
Using synthetic recovery source significantly improves indexing performance compared
to regular recovery source.
area: Mapping
type: enhancement
issues:
- 116726
1 change: 0 additions & 1 deletion ...amlRestTest/java/org/elasticsearch/smoketest/SmokeTestMultiNodeClientYamlTestSuiteIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ public class SmokeTestMultiNodeClientYamlTestSuiteIT extends ESClientYamlSuiteTe
.node(0, n -> n.setting("node.roles", "[master,data,ml,remote_cluster_client,transform]"))
.feature(FeatureFlag.TIME_SERIES_MODE)
.feature(FeatureFlag.SUB_OBJECTS_AUTO_ENABLED)
.feature(FeatureFlag.INDEX_RECOVERY_USE_SYNTHETIC_SOURCE)
.feature(FeatureFlag.DOC_VALUES_SKIPPER)
.build();

Expand Down
1 change: 0 additions & 1 deletion rest-api-spec/src/yamlRestTest/java/org/elasticsearch/test/rest/ClientYamlTestSuiteIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ public class ClientYamlTestSuiteIT extends ESClientYamlSuiteTestCase {
.module("data-streams")
.feature(FeatureFlag.TIME_SERIES_MODE)
.feature(FeatureFlag.SUB_OBJECTS_AUTO_ENABLED)
.feature(FeatureFlag.INDEX_RECOVERY_USE_SYNTHETIC_SOURCE)
.feature(FeatureFlag.DOC_VALUES_SKIPPER)
.build();

Expand Down
6 changes: 1 addition & 5 deletions server/src/main/java/org/elasticsearch/index/IndexSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,19 +732,15 @@ public Iterator<Setting<?>> settings() {
Setting.Property.ServerlessPublic
);

public static final FeatureFlag RECOVERY_USE_SYNTHETIC_SOURCE = new FeatureFlag("index_recovery_use_synthetic_source");
public static final Setting<Boolean> RECOVERY_USE_SYNTHETIC_SOURCE_SETTING = Setting.boolSetting(
"index.recovery.use_synthetic_source",
settings -> {
boolean isSyntheticSourceRecoveryFeatureFlagEnabled = RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled();
boolean isNewIndexVersion = SETTING_INDEX_VERSION_CREATED.get(settings)
.onOrAfter(IndexVersions.USE_SYNTHETIC_SOURCE_FOR_RECOVERY_BY_DEFAULT);
boolean isIndexVersionInBackportRange = SETTING_INDEX_VERSION_CREATED.get(settings)
.between(IndexVersions.USE_SYNTHETIC_SOURCE_FOR_RECOVERY_BY_DEFAULT_BACKPORT, IndexVersions.UPGRADE_TO_LUCENE_10_0_0);

boolean useSyntheticRecoverySource = isSyntheticSourceRecoveryFeatureFlagEnabled
&& (isNewIndexVersion || isIndexVersionInBackportRange);

boolean useSyntheticRecoverySource = isNewIndexVersion || isIndexVersionInBackportRange;
return String.valueOf(
useSyntheticRecoverySource
&& Objects.equals(INDEX_MAPPER_SOURCE_MODE_SETTING.get(settings), SourceFieldMapper.Mode.SYNTHETIC)
Expand Down
23 changes: 3 additions & 20 deletions server/src/test/java/org/elasticsearch/index/mapper/NativeArrayIntegrationTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import org.elasticsearch.action.support.WriteRequest;
import org.elasticsearch.common.network.NetworkAddress;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.index.IndexSettings;
import org.elasticsearch.index.query.IdsQueryBuilder;
import org.elasticsearch.test.ESSingleNodeTestCase;
import org.elasticsearch.xcontent.XContentBuilder;
Expand All @@ -35,7 +34,6 @@

import static org.elasticsearch.xcontent.XContentFactory.jsonBuilder;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasKey;
Expand Down Expand Up @@ -136,14 +134,7 @@ protected void verifySyntheticArray(Object[][] arrays, XContentBuilder mapping,
var document = reader.storedFields().document(i);
// Verify that there is no ignored source:
Set<String> storedFieldNames = new LinkedHashSet<>(document.getFields().stream().map(IndexableField::name).toList());
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled()) {
assertThat(storedFieldNames, contains(expectedStoredFields));
} else {
var copyExpectedStoredFields = new String[expectedStoredFields.length + 1];
System.arraycopy(expectedStoredFields, 0, copyExpectedStoredFields, 0, expectedStoredFields.length);
copyExpectedStoredFields[copyExpectedStoredFields.length - 1] = "_recovery_source";
assertThat(storedFieldNames, containsInAnyOrder(copyExpectedStoredFields));
}
assertThat(storedFieldNames, contains(expectedStoredFields));
}
var fieldInfo = FieldInfos.getMergedFieldInfos(reader).fieldInfo("field.offsets");
assertThat(fieldInfo.getDocValuesType(), equalTo(DocValuesType.SORTED));
Expand Down Expand Up @@ -208,11 +199,7 @@ protected void verifySyntheticObjectArray(List<List<Object[]>> documents) throws
var document = reader.storedFields().document(i);
// Verify that there is ignored source because of leaf array being wrapped by object array:
List<String> storedFieldNames = document.getFields().stream().map(IndexableField::name).toList();
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled()) {
assertThat(storedFieldNames, contains("_id", "_ignored_source"));
} else {
assertThat(storedFieldNames, containsInAnyOrder("_id", "_ignored_source", "_recovery_source"));
}
assertThat(storedFieldNames, contains("_id", "_ignored_source"));

// Verify that there is no offset field:
LeafReader leafReader = reader.leaves().get(0).reader();
Expand Down Expand Up @@ -285,11 +272,7 @@ protected void verifySyntheticArrayInObject(List<Object[]> documents) throws IOE
var document = reader.storedFields().document(i);
// Verify that there is no ignored source:
Set<String> storedFieldNames = new LinkedHashSet<>(document.getFields().stream().map(IndexableField::name).toList());
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled()) {
assertThat(storedFieldNames, contains("_id"));
} else {
assertThat(storedFieldNames, containsInAnyOrder("_id", "_recovery_source"));
}
assertThat(storedFieldNames, contains("_id"));
}
var fieldInfo = FieldInfos.getMergedFieldInfos(reader).fieldInfo("object.field.offsets");
assertThat(fieldInfo.getDocValuesType(), equalTo(DocValuesType.SORTED));
Expand Down
53 changes: 6 additions & 47 deletions server/src/test/java/org/elasticsearch/index/mapper/SourceFieldMapperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,13 +489,7 @@ public void testRecoverySourceWithSyntheticSource() throws IOException {
MapperService mapperService = createMapperService(settings, topMapping(b -> {}));
DocumentMapper docMapper = mapperService.documentMapper();
ParsedDocument doc = docMapper.parse(source(b -> b.field("field1", "value1")));
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled() == false) {
// TODO: remove this if branch when removing the 'index_recovery_use_synthetic_source' feature flag
assertNotNull(doc.rootDoc().getField("_recovery_source"));
assertThat(doc.rootDoc().getField("_recovery_source").binaryValue(), equalTo(new BytesRef("{\"field1\":\"value1\"}")));
} else {
assertNull(doc.rootDoc().getField("_recovery_source"));
}
assertNull(doc.rootDoc().getField("_recovery_source"));
}
{
Settings settings = Settings.builder()
Expand Down Expand Up @@ -526,16 +520,8 @@ public void testRecoverySourceWithLogs() throws IOException {
MapperService mapperService = createMapperService(settings, mapping(b -> {}));
DocumentMapper docMapper = mapperService.documentMapper();
ParsedDocument doc = docMapper.parse(source(b -> { b.field("@timestamp", "2012-02-13"); }));
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled() == false) {
// TODO: remove this if branch when removing the 'index_recovery_use_synthetic_source' feature flag
assertNotNull(doc.rootDoc().getField("_recovery_source"));
assertThat(
doc.rootDoc().getField("_recovery_source").binaryValue(),
equalTo(new BytesRef("{\"@timestamp\":\"2012-02-13\"}"))
);
} else {
assertNull(doc.rootDoc().getField("_recovery_source"));
}
assertNotNull(doc.rootDoc().getField("_recovery_source_size"));
assertThat(doc.rootDoc().getField("_recovery_source_size").numericValue(), equalTo(27L));
}
{
Settings settings = Settings.builder()
Expand Down Expand Up @@ -728,16 +714,7 @@ public void testRecoverySourceWithLogsCustom() throws IOException {
MapperService mapperService = createMapperService(settings, mappings);
DocumentMapper docMapper = mapperService.documentMapper();
ParsedDocument doc = docMapper.parse(source(b -> { b.field("@timestamp", "2012-02-13"); }));
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled() == false) {
// TODO: remove this if branch when removing the 'index_recovery_use_synthetic_source' feature flag
assertNotNull(doc.rootDoc().getField("_recovery_source"));
assertThat(
doc.rootDoc().getField("_recovery_source").binaryValue(),
equalTo(new BytesRef("{\"@timestamp\":\"2012-02-13\"}"))
);
} else {
assertNull(doc.rootDoc().getField("_recovery_source"));
}
assertNull(doc.rootDoc().getField("_recovery_source"));
}
{
Settings settings = Settings.builder()
Expand All @@ -763,16 +740,7 @@ public void testRecoverySourceWithTimeSeries() throws IOException {
}));
DocumentMapper docMapper = mapperService.documentMapper();
ParsedDocument doc = docMapper.parse(source("123", b -> b.field("@timestamp", "2012-02-13").field("field", "value1"), null));
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled() == false) {
// TODO: remove this if branch when removing the 'index_recovery_use_synthetic_source' feature flag
assertNotNull(doc.rootDoc().getField("_recovery_source"));
assertThat(
doc.rootDoc().getField("_recovery_source").binaryValue(),
equalTo(new BytesRef("{\"@timestamp\":\"2012-02-13\",\"field\":\"value1\"}"))
);
} else {
assertNull(doc.rootDoc().getField("_recovery_source"));
}
assertNull(doc.rootDoc().getField("_recovery_source"));
}
{
Settings settings = Settings.builder()
Expand Down Expand Up @@ -816,16 +784,7 @@ public void testRecoverySourceWithTimeSeriesCustom() throws IOException {
MapperService mapperService = createMapperService(settings, mappings);
DocumentMapper docMapper = mapperService.documentMapper();
ParsedDocument doc = docMapper.parse(source("123", b -> b.field("@timestamp", "2012-02-13").field("field", "value1"), null));
if (IndexSettings.RECOVERY_USE_SYNTHETIC_SOURCE.isEnabled() == false) {
// TODO: remove this if branch when removing the 'index_recovery_use_synthetic_source' feature flag
assertNotNull(doc.rootDoc().getField("_recovery_source"));
assertThat(
doc.rootDoc().getField("_recovery_source").binaryValue(),
equalTo(new BytesRef("{\"@timestamp\":\"2012-02-13\",\"field\":\"value1\"}"))
);
} else {
assertNull(doc.rootDoc().getField("_recovery_source"));
}
assertNull(doc.rootDoc().getField("_recovery_source"));
}
{
Settings settings = Settings.builder()
Expand Down
5 changes: 0 additions & 5 deletions test/test-clusters/src/main/java/org/elasticsearch/test/cluster/FeatureFlag.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ public enum FeatureFlag {
TIME_SERIES_MODE("es.index_mode_feature_flag_registered=true", Version.fromString("8.0.0"), null),
FAILURE_STORE_ENABLED("es.failure_store_feature_flag_enabled=true", Version.fromString("8.12.0"), null),
SUB_OBJECTS_AUTO_ENABLED("es.sub_objects_auto_feature_flag_enabled=true", Version.fromString("8.16.0"), null),
INDEX_RECOVERY_USE_SYNTHETIC_SOURCE(
"es.index_recovery_use_synthetic_source_feature_flag_enabled=true",
Version.fromString("8.18.0"),
null
),
Copy link
Contributor

@kkrik-es kkrik-es Mar 5, 2025

Choose a reason for hiding this comment

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

Does this cause issues during upgrade?

Copy link
Member Author

@martijnvg martijnvg Mar 5, 2025

Choose a reason for hiding this comment

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

No, since the feature flag is now completely removed and so regular index version checks avoid issue during upgrades.

DOC_VALUES_SKIPPER("es.doc_values_skipper_feature_flag_enabled=true", Version.fromString("8.18.1"), null);

public final String systemProperty;
Expand Down
1 change: 0 additions & 1 deletion ...plugin/logsdb/src/yamlRestTest/java/org/elasticsearch/xpack/logsdb/LogsdbTestSuiteIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ public class LogsdbTestSuiteIT extends ESClientYamlSuiteTestCase {
.distribution(DistributionType.DEFAULT)
.setting("xpack.security.enabled", "false")
.setting("xpack.license.self_generated.type", "trial")
.feature(FeatureFlag.INDEX_RECOVERY_USE_SYNTHETIC_SOURCE)
.feature(FeatureFlag.DOC_VALUES_SKIPPER)
.build();

Expand Down
1 change: 0 additions & 1 deletion ...RestTest/java/org/elasticsearch/xpack/security/CoreWithSecurityClientYamlTestSuiteIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ public class CoreWithSecurityClientYamlTestSuiteIT extends ESClientYamlSuiteTest
.user(USER, PASS)
.feature(FeatureFlag.TIME_SERIES_MODE)
.feature(FeatureFlag.SUB_OBJECTS_AUTO_ENABLED)
.feature(FeatureFlag.INDEX_RECOVERY_USE_SYNTHETIC_SOURCE)
.feature(FeatureFlag.DOC_VALUES_SKIPPER)
.build();

Expand Down