From 9312207643ca94e706efe37ecd57adf7b9025a2a Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Fri, 10 Jan 2025 17:13:17 -0500 Subject: [PATCH 1/3] Add restrictions for synthetic --- .../ingest-management/data-streams.asciidoc | 45 ++++++++++--------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/docs/en/ingest-management/data-streams.asciidoc b/docs/en/ingest-management/data-streams.asciidoc index da380af17..95f512346 100644 --- a/docs/en/ingest-management/data-streams.asciidoc +++ b/docs/en/ingest-management/data-streams.asciidoc @@ -691,22 +691,6 @@ You can modify your pipeline API request as needed to apply custom processing at Refer to <> to learn more. - - - - - - - - - - - - - - - - [[data-streams-advanced-features]] == Enabling and disabling advanced indexing features for {fleet}-managed data streams @@ -720,6 +704,7 @@ Refer to <> to learn more. * link:{ref}/mapping-source-field.html#synthetic-source[Synthetic `_source`] These features can be enabled and disabled for {fleet}-managed data streams by using the index template API and a few key settings. +Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. As well, synthetic `_source` is supported only on non-TSDS data streams. NOTE: If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in <>), exercise care to ensure you don't overwrite your customizations when making these requests. @@ -878,10 +863,11 @@ For example, the following payload disables TSDS on `nginx.stubstatus`: [[data-streams-advanced-synthetic-enable]] == Enable synthetic `_source` +Note that synthetic `_source` is supported only on non-TSDS data streams. + [source,json] ---- PUT _component_template/@custom - { "template": { "mappings": { @@ -891,20 +877,37 @@ PUT _component_template/@custom } } } + +PUT _component_template/@custom +{ + "settings": { + "index": { + "mapping": { + "source": { + "mode": "synthetic" + } + } + } + } +} + ---- [discrete] [[data-streams-advanced-synthetic-disable]] == Disable synthetic `_source` +Note that synthetic `_source` is supported only on non-TSDS data streams. + [source,json] ---- PUT _component_template/@custom - { - "template": { - "mappings": { - "_source": {} + "settings": { + "index": { + "mapping": { + "source": {} + } } } } From f7d5f698dbdc1dac5eeb500ef557f71ccbb7fe75 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Mon, 20 Jan 2025 09:24:06 -0500 Subject: [PATCH 2/3] Fixes for Martijn's review --- .../ingest-management/data-streams.asciidoc | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/docs/en/ingest-management/data-streams.asciidoc b/docs/en/ingest-management/data-streams.asciidoc index 95f512346..07339f33f 100644 --- a/docs/en/ingest-management/data-streams.asciidoc +++ b/docs/en/ingest-management/data-streams.asciidoc @@ -704,7 +704,7 @@ Refer to <> to learn more. * link:{ref}/mapping-source-field.html#synthetic-source[Synthetic `_source`] These features can be enabled and disabled for {fleet}-managed data streams by using the index template API and a few key settings. -Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. As well, synthetic `_source` is supported only on non-TSDS data streams. +Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. As well, disabling synthetic `_source` is supported only on non-TSDS data streams. NOTE: If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in <>), exercise care to ensure you don't overwrite your customizations when making these requests. @@ -863,21 +863,8 @@ For example, the following payload disables TSDS on `nginx.stubstatus`: [[data-streams-advanced-synthetic-enable]] == Enable synthetic `_source` -Note that synthetic `_source` is supported only on non-TSDS data streams. - [source,json] ---- -PUT _component_template/@custom -{ - "template": { - "mappings": { - "_source": { - "mode": "synthetic" - } - } - } -} - PUT _component_template/@custom { "settings": { @@ -897,7 +884,7 @@ PUT _component_template/@custom [[data-streams-advanced-synthetic-disable]] == Disable synthetic `_source` -Note that synthetic `_source` is supported only on non-TSDS data streams. +Note that disabling synthetic `_source` is supported only on non-TSDS data streams. [source,json] ---- @@ -906,7 +893,7 @@ PUT _component_template/@custom "settings": { "index": { "mapping": { - "source": {} + "source": {"mode": "stored"} } } } From 5a30d2cdb8f9aefac614eded3d432df157b1c901 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Tue, 21 Jan 2025 09:00:31 -0500 Subject: [PATCH 3/3] Remove note about synthetic _source not supported on TSDS --- docs/en/ingest-management/data-streams.asciidoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/en/ingest-management/data-streams.asciidoc b/docs/en/ingest-management/data-streams.asciidoc index 07339f33f..f5967fff5 100644 --- a/docs/en/ingest-management/data-streams.asciidoc +++ b/docs/en/ingest-management/data-streams.asciidoc @@ -704,7 +704,7 @@ Refer to <> to learn more. * link:{ref}/mapping-source-field.html#synthetic-source[Synthetic `_source`] These features can be enabled and disabled for {fleet}-managed data streams by using the index template API and a few key settings. -Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. As well, disabling synthetic `_source` is supported only on non-TSDS data streams. +Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. NOTE: If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in <>), exercise care to ensure you don't overwrite your customizations when making these requests. @@ -884,8 +884,6 @@ PUT _component_template/@custom [[data-streams-advanced-synthetic-disable]] == Disable synthetic `_source` -Note that disabling synthetic `_source` is supported only on non-TSDS data streams. - [source,json] ---- PUT _component_template/@custom