Skip to content

Commit

Permalink
Add restrictions for synthetic _source (#1622) (#1641)
Browse files Browse the repository at this point in the history
* Add restrictions for synthetic

* Fixes for Martijn's review

* Remove note about synthetic _source not supported on TSDS

(cherry picked from commit 42b052f)

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
  • Loading branch information
mergify[bot] and kilfoyle authored Jan 21, 2025
1 parent 5f1dd08 commit ea071ee
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions docs/en/ingest-management/data-streams.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -937,6 +937,7 @@ Refer to <<data-streams-pipelines>> 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.

NOTE: If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in <<data-streams-ilm-tutorial,Tutorial: Customize data retention policies>>), exercise care to ensure you don't overwrite your customizations when making these requests.

Expand Down Expand Up @@ -1098,16 +1099,18 @@ For example, the following payload disables TSDS on `nginx.stubstatus`:
[source,json]
----
PUT _component_template/<NAME>@custom
{
"template": {
"mappings": {
"_source": {
"mode": "synthetic"
"settings": {
"index": {
"mapping": {
"source": {
"mode": "synthetic"
}
}
}
}
}
----

[discrete]
Expand All @@ -1117,11 +1120,12 @@ PUT _component_template/<NAME>@custom
[source,json]
----
PUT _component_template/<NAME>@custom
{
"template": {
"mappings": {
"_source": {}
"settings": {
"index": {
"mapping": {
"source": {"mode": "stored"}
}
}
}
}
Expand Down

0 comments on commit ea071ee

Please sign in to comment.