Skip to content

Add index mode to get data stream API #122486

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

Add index mode to get data stream API #122486

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ed79e17
Add index mode to get data stream API
dakrone Feb 13, 2025
8839217
Update docs/changelog/122486.yaml
dakrone Feb 13, 2025
b2c06f7
Fix test
dakrone Feb 13, 2025
dac32e1
Merge branch 'main' into add-index-mode-to-get-data-stream
dakrone Feb 13, 2025
993d962
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Feb 14, 2025
ddb2cb6
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Feb 20, 2025
9300e9b
Add a test for index providers giving data stream mode
dakrone Feb 20, 2025
1b2a428
Replace all string constants
dakrone Feb 20, 2025
9813ac6
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Feb 20, 2025
b902777
[CI] Auto commit changes from spotless
Feb 20, 2025
2ed217c
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Feb 21, 2025
f76b5c6
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Mar 5, 2025
a63bcd5
Merge remote-tracking branch 'origin/main' into add-index-mode-to-get…
dakrone Mar 5, 2025
f75ed49
Fix test after merging in main
dakrone Mar 5, 2025
4ecb0d2
Merge branch 'main' into add-index-mode-to-get-data-stream
dakrone 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
5 changes: 5 additions & 0 deletions docs/changelog/122486.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 122486
summary: Add index mode to get data stream API
area: Data streams
type: enhancement
issues: []
11 changes: 8 additions & 3 deletions docs/reference/indices/get-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,21 +304,24 @@ The API returns the following response:
"index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
"prefer_ilm": true,
"ilm_policy": "my-lifecycle-policy",
"managed_by": "Index Lifecycle Management"
"managed_by": "Index Lifecycle Management",
"index_mode": "standard"
},
{
"index_name": ".ds-my-data-stream-2099.03.08-000002",
"index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
"prefer_ilm": true,
"ilm_policy": "my-lifecycle-policy",
"managed_by": "Index Lifecycle Management"
"managed_by": "Index Lifecycle Management",
"index_mode": "standard"
}
],
"generation": 2,
"_meta": {
"my-meta-field": "foo"
},
"status": "GREEN",
"index_mode": "standard",
"next_generation_managed_by": "Index Lifecycle Management",
"prefer_ilm": true,
"template": "my-index-template",
Expand All @@ -340,14 +343,16 @@ The API returns the following response:
"index_uuid": "3liBu2SYS5axasRt6fUIpA",
"prefer_ilm": true,
"ilm_policy": "my-lifecycle-policy",
"managed_by": "Index Lifecycle Management"
"managed_by": "Index Lifecycle Management",
"index_mode": "standard"
}
],
"generation": 1,
"_meta": {
"my-meta-field": "foo"
},
"status": "YELLOW",
"index_mode": "standard",
"next_generation_managed_by": "Index Lifecycle Management",
"prefer_ilm": true,
"template": "my-index-template",
Expand Down
70 changes: 68 additions & 2 deletions ...ams/src/main/java/org/elasticsearch/datastreams/action/TransportGetDataStreamsAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.elasticsearch.cluster.block.ClusterBlockException;
import org.elasticsearch.cluster.block.ClusterBlockLevel;
import org.elasticsearch.cluster.health.ClusterStateHealth;
import org.elasticsearch.cluster.metadata.ComposableIndexTemplate;
import org.elasticsearch.cluster.metadata.DataStream;
import org.elasticsearch.cluster.metadata.DataStreamFailureStoreSettings;
import org.elasticsearch.cluster.metadata.DataStreamGlobalRetentionSettings;
Expand All @@ -39,6 +40,9 @@
import org.elasticsearch.core.Tuple;
import org.elasticsearch.index.Index;
import org.elasticsearch.index.IndexMode;
import org.elasticsearch.index.IndexSettingProvider;
import org.elasticsearch.index.IndexSettingProviders;
import org.elasticsearch.index.IndexSettings;
import org.elasticsearch.indices.SystemDataStreamDescriptor;
import org.elasticsearch.indices.SystemIndices;
import org.elasticsearch.injection.guice.Inject;
Expand All @@ -52,6 +56,7 @@
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;

Expand All @@ -67,6 +72,7 @@ public class TransportGetDataStreamsAction extends TransportMasterNodeReadAction
private final ClusterSettings clusterSettings;
private final DataStreamGlobalRetentionSettings globalRetentionSettings;
private final DataStreamFailureStoreSettings dataStreamFailureStoreSettings;
private final IndexSettingProviders indexSettingProviders;
private final Client client;

@Inject
Expand All @@ -79,6 +85,7 @@ public TransportGetDataStreamsAction(
SystemIndices systemIndices,
DataStreamGlobalRetentionSettings globalRetentionSettings,
DataStreamFailureStoreSettings dataStreamFailureStoreSettings,
IndexSettingProviders indexSettingProviders,
Client client
) {
super(
Expand All @@ -96,6 +103,7 @@ public TransportGetDataStreamsAction(
this.globalRetentionSettings = globalRetentionSettings;
clusterSettings = clusterService.getClusterSettings();
this.dataStreamFailureStoreSettings = dataStreamFailureStoreSettings;
this.indexSettingProviders = indexSettingProviders;
this.client = new OriginSettingClient(client, "stack");
}

Expand Down Expand Up @@ -128,6 +136,7 @@ public void onResponse(DataStreamsStatsAction.Response response) {
clusterSettings,
globalRetentionSettings,
dataStreamFailureStoreSettings,
indexSettingProviders,
maxTimestamps
)
);
Expand All @@ -148,12 +157,43 @@ public void onFailure(Exception e) {
clusterSettings,
globalRetentionSettings,
dataStreamFailureStoreSettings,
indexSettingProviders,
null
)
);
}
}

/**
* Resolves the index mode ("index.mode" setting) for the given data stream, from the template or additional setting providers
*/
@Nullable
static IndexMode resolveMode(
ClusterState state,
IndexSettingProviders indexSettingProviders,
DataStream dataStream,
Settings settings,
ComposableIndexTemplate indexTemplate
) {
IndexMode indexMode = state.metadata().retrieveIndexModeFromTemplate(indexTemplate);
for (IndexSettingProvider provider : indexSettingProviders.getIndexSettingProviders()) {
Settings addlSettinsg = provider.getAdditionalIndexSettings(
MetadataIndexTemplateService.VALIDATE_INDEX_NAME,
dataStream.getName(),
indexMode,
state.metadata(),
Instant.now(),
settings,
List.of()
);
var rawMode = addlSettinsg.get(IndexSettings.MODE.getKey());
if (rawMode != null) {
indexMode = Enum.valueOf(IndexMode.class, rawMode.toUpperCase(Locale.ROOT));
Copy link
Contributor

Choose a reason for hiding this comment

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

For my curiosity, why do we favor the value in settings provider over the index template?

Copy link
Member Author

@dakrone dakrone Feb 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The settings provider can override settings at index creation time (it essentially has higher precedence over the template(s))

}
}
return indexMode;
}

static GetDataStreamAction.Response innerOperation(
ClusterState state,
GetDataStreamAction.Request request,
Expand All @@ -162,6 +202,7 @@ static GetDataStreamAction.Response innerOperation(
ClusterSettings clusterSettings,
DataStreamGlobalRetentionSettings globalRetentionSettings,
DataStreamFailureStoreSettings dataStreamFailureStoreSettings,
IndexSettingProviders indexSettingProviders,
@Nullable Map<String, Long> maxTimestamps
) {
List<DataStream> dataStreams = getDataStreams(state, indexNameExpressionResolver, request);
Expand All @@ -174,6 +215,7 @@ static GetDataStreamAction.Response innerOperation(
final String indexTemplate;
boolean indexTemplatePreferIlmValue = true;
String ilmPolicyName = null;
IndexMode indexMode = dataStream.getIndexMode();
if (dataStream.isSystem()) {
SystemDataStreamDescriptor dataStreamDescriptor = systemIndices.findMatchingDataStreamDescriptor(dataStream.getName());
indexTemplate = dataStreamDescriptor != null ? dataStreamDescriptor.getDataStreamName() : null;
Expand All @@ -183,13 +225,31 @@ static GetDataStreamAction.Response innerOperation(
dataStreamDescriptor.getComponentTemplates()
);
ilmPolicyName = settings.get(IndexMetadata.LIFECYCLE_NAME);
if (indexMode == null) {
indexMode = resolveMode(
state,
indexSettingProviders,
dataStream,
settings,
dataStreamDescriptor.getComposableIndexTemplate()
);
}
indexTemplatePreferIlmValue = PREFER_ILM_SETTING.get(settings);
}
} else {
indexTemplate = MetadataIndexTemplateService.findV2Template(state.metadata(), dataStream.getName(), false);
if (indexTemplate != null) {
Settings settings = MetadataIndexTemplateService.resolveSettings(state.metadata(), indexTemplate);
ilmPolicyName = settings.get(IndexMetadata.LIFECYCLE_NAME);
if (indexMode == null && state.metadata().templatesV2().get(indexTemplate) != null) {
indexMode = resolveMode(
state,
indexSettingProviders,
dataStream,
settings,
state.metadata().templatesV2().get(indexTemplate)
);
}
indexTemplatePreferIlmValue = PREFER_ILM_SETTING.get(settings);
} else {
LOGGER.warn(
Expand Down Expand Up @@ -281,7 +341,9 @@ public int compareTo(IndexInfo o) {
timeSeries,
backingIndicesSettingsValues,
indexTemplatePreferIlmValue,
maxTimestamps == null ? null : maxTimestamps.get(dataStream.getName())
maxTimestamps == null ? null : maxTimestamps.get(dataStream.getName()),
// Default to standard mode if not specified; should we set this to "unset" or "unspecified" instead?
indexMode == null ? IndexMode.STANDARD.getName() : indexMode.getName()
Comment on lines +349 to +350
Copy link
Contributor

Choose a reason for hiding this comment

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

If the indexMode can't be resolved here, does it imply that it must have fell back to the default STANDARD mode or is it possible that it could be something else but just can't be found? If it's the prior then STANDARD seems fine. Though it would be better if the "fall back to STANDARD mode" logic is already reusable from somewhere else than here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this is the paranoid case for when we can't resolve it from the data stream template. I can only think of when a data stream gets restored from a snapshot without a template (so we wouldn't be able to resolve anything).

)
);
}
Expand Down Expand Up @@ -310,7 +372,11 @@ private static void collectIndexSettingsValues(
} else {
managedBy = ManagedBy.UNMANAGED;
}
backingIndicesSettingsValues.put(index, new IndexProperties(preferIlm, indexMetadata.getLifecyclePolicyName(), managedBy));
String indexMode = IndexSettings.MODE.get(indexMetadata.getSettings()).getName();
backingIndicesSettingsValues.put(
index,
new IndexProperties(preferIlm, indexMetadata.getLifecyclePolicyName(), managedBy, indexMode)
);
}
}

Expand Down
30 changes: 18 additions & 12 deletions ...reams/src/test/java/org/elasticsearch/datastreams/action/GetDataStreamsResponseTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ public void testResponseIlmAndDataStreamLifecycleRepresentation() throws Excepti
String ilmPolicyName = "rollover-30days";
Map<Index, Response.IndexProperties> indexSettingsValues = Map.of(
firstGenerationIndex,
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM),
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM, null),
secondGenerationIndex,
new Response.IndexProperties(false, ilmPolicyName, ManagedBy.LIFECYCLE),
new Response.IndexProperties(false, ilmPolicyName, ManagedBy.LIFECYCLE, null),
writeIndex,
new Response.IndexProperties(false, null, ManagedBy.LIFECYCLE),
new Response.IndexProperties(false, null, ManagedBy.LIFECYCLE, null),
failureStoreIndex,
new Response.IndexProperties(false, null, ManagedBy.LIFECYCLE)
new Response.IndexProperties(false, null, ManagedBy.LIFECYCLE, null)
);

Response.DataStreamInfo dataStreamInfo = new Response.DataStreamInfo(
Expand All @@ -109,6 +109,7 @@ public void testResponseIlmAndDataStreamLifecycleRepresentation() throws Excepti
null,
indexSettingsValues,
false,
null,
null
);
Response response = new Response(List.of(dataStreamInfo));
Expand Down Expand Up @@ -195,13 +196,13 @@ public void testResponseIlmAndDataStreamLifecycleRepresentation() throws Excepti
String ilmPolicyName = "rollover-30days";
Map<Index, Response.IndexProperties> indexSettingsValues = Map.of(
firstGenerationIndex,
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM),
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM, null),
secondGenerationIndex,
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM),
new Response.IndexProperties(true, ilmPolicyName, ManagedBy.ILM, null),
writeIndex,
new Response.IndexProperties(false, null, ManagedBy.UNMANAGED),
new Response.IndexProperties(false, null, ManagedBy.UNMANAGED, null),
failureStoreIndex,
new Response.IndexProperties(false, null, ManagedBy.UNMANAGED)
new Response.IndexProperties(false, null, ManagedBy.UNMANAGED, null)
);

Response.DataStreamInfo dataStreamInfo = new Response.DataStreamInfo(
Expand All @@ -213,6 +214,7 @@ public void testResponseIlmAndDataStreamLifecycleRepresentation() throws Excepti
null,
indexSettingsValues,
false,
null,
null
);
Response response = new Response(List.of(dataStreamInfo));
Expand Down Expand Up @@ -309,7 +311,8 @@ private Response.DataStreamInfo mutateInstance(Response.DataStreamInfo instance)
new Response.IndexProperties(
randomBoolean(),
randomAlphaOfLengthBetween(50, 100),
randomBoolean() ? ManagedBy.ILM : ManagedBy.LIFECYCLE
randomBoolean() ? ManagedBy.ILM : ManagedBy.LIFECYCLE,
null
)
)
);
Expand All @@ -328,7 +331,8 @@ private Response.DataStreamInfo mutateInstance(Response.DataStreamInfo instance)
timeSeries,
indexSettings,
templatePreferIlm,
maximumTimestamp
maximumTimestamp,
null
);
}

Expand All @@ -349,7 +353,8 @@ private Map<Index, Response.IndexProperties> generateRandomIndexSettingsValues()
new Response.IndexProperties(
randomBoolean(),
randomAlphaOfLengthBetween(50, 100),
randomBoolean() ? ManagedBy.ILM : ManagedBy.LIFECYCLE
randomBoolean() ? ManagedBy.ILM : ManagedBy.LIFECYCLE,
randomBoolean() ? randomFrom(IndexMode.values()).getName() : null
)
);
}
Expand All @@ -367,7 +372,8 @@ private Response.DataStreamInfo generateRandomDataStreamInfo() {
timeSeries != null ? new Response.TimeSeries(timeSeries) : null,
generateRandomIndexSettingsValues(),
randomBoolean(),
usually() ? randomNonNegativeLong() : null
usually() ? randomNonNegativeLong() : null,
usually() ? randomFrom(IndexMode.values()).getName() : null
);
}
}
Loading
Loading