Skip to content

Commit 62ed5a6

Browse files
committed
Updating the configure data stream retention tutorial
1 parent 4eaa1f3 commit 62ed5a6

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

manage-data/data-store/data-streams.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ You can also use a [data stream lifecycle](../lifecycle/data-stream.md) to autom
2525
Starting with {{stack}} version 9.2, **Streams** provides a centralized interface for managing your data in {{kib}}. It consolidates common data management tasks and eliminates the need for manual configuration of multiple applications and components. A stream directly corresponds to an {{es}} data stream, for example `logs-myapp-default`. Any changes that you make in Streams are automatically propagated to the associated data stream.
2626

2727
You can use Streams to perform the following data management tasks:
28-
* defining parsing and field extraction logic to structure incoming data
29-
* managing and updating field mappings
30-
* configuring data retention policies
31-
* identifying failed and degraded documents
32-
* manually adjusting index configuration settings
28+
* defining parsing and field extraction logic to structure incoming data {applies_to}`"stack": "ga 9.2, preview 9.1"`
29+
* configuring data retention policies {applies_to}`"stack": "ga 9.2, preview 9.1"`
30+
* manually adjusting index configuration settings {applies_to}`"stack": "ga 9.2, preview 9.1"`
31+
* managing and updating field mappings {applies_to}`stack: ga 9.2`
32+
* identifying failed and degraded documents {applies_to}`stack: ga 9.2`
3333

3434
For more information, refer to [Streams](/solutions/observability/streams/streams.md).
3535
:::

manage-data/lifecycle/data-stream/tutorial-data-stream-retention.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ products:
1010

1111
# Tutorial: Configure data stream retention [tutorial-manage-data-stream-retention]
1212

13-
In this tutorial, we are going to go over the data stream lifecycle retention; we will define it, go over how it can be configured and how it can gets applied. Keep in mind, the following options apply only to data streams that are managed by the data stream lifecycle.
13+
In this tutorial, we are going to go over the data stream lifecycle retention; we will define it, go over how it can be configured and how it gets applied. Keep in mind, the following options apply only to data streams that are managed by the data stream lifecycle.
1414

1515
1. [What is data stream retention?](#what-is-retention)
1616
2. [How to configure retention?](#retention-configuration)
@@ -42,6 +42,11 @@ The result should look like this:
4242
2. Ensure that the lifecycle is enabled, meaning this should be `true`.
4343

4444

45+
:::{tip}
46+
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
47+
48+
You can also review how a data stream is managed by locating it on the **Streams** page in {{kib}}. A stream directly corresponds to a data stream. Select a stream to view its details and go to the **Retention** tab.
49+
:::
4550

4651
## What is data stream retention? [what-is-retention]
4752

@@ -69,7 +74,7 @@ Global default and max retention do not apply to data streams internal to elasti
6974

7075
* By setting the `data_retention` on the data stream level. This retention can be configured in two ways:
7176

72-
For new data streams, it can be defined in the index template that would be applied during the data stream’s creation. You can use the [create index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template), for example:
77+
* For new data streams, it can be defined in the index template that would be applied during the data stream’s creation. You can use the [create index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template), for example:
7378

7479
```console
7580
PUT _index_template/template
@@ -88,7 +93,7 @@ Global default and max retention do not apply to data streams internal to elasti
8893
}
8994
```
9095

91-
For an existing data stream, it can be set via the [PUT lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
96+
* For an existing data stream, it can be set via the [PUT lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
9297

9398
```console
9499
PUT _data_stream/my-data-stream/_lifecycle
@@ -99,7 +104,13 @@ Global default and max retention do not apply to data streams internal to elasti
99104

100105
1. The retention period of this data stream is set to 30 days.
101106

102-
* By setting the global retention via the `data_streams.lifecycle.retention.default` and/or `data_streams.lifecycle.retention.max` that are set on a cluster level. You can be set via the [update cluster settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). For example:
107+
:::{tip}
108+
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
109+
110+
To adjust the retention period of a data stream in {{kib}}, locate a data stream on the **Streams** page. A stream directly corresponds to a data stream. Next, select a stream to view its details and review the **Retention** tab to find out how it's managed before making your adjustments.
111+
:::
112+
113+
* By setting the global retention via the `data_streams.lifecycle.retention.default` and/or `data_streams.lifecycle.retention.max` that are set on a cluster level. You can set this via the [update cluster settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). For example:
103114

104115
```console
105116
PUT /_cluster/settings

0 commit comments

Comments
 (0)