Skip to content

Commit e978f6e

Browse files
committed
edit configuration section for more clarity
1 parent 08b2ac3 commit e978f6e

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

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

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Enabling the failure store via [index templates](../templates.md) can only affec
5252
To modify an existing data stream's options, use the [put data stream options](./failure-store.md) API:
5353

5454
```console
55-
PUT my-datastream-existing/_options
55+
PUT _data_stream/my-datastream-existing/_options
5656
{
5757
"failure_store": {
5858
"enabled": true <1>
@@ -66,7 +66,7 @@ PUT my-datastream-existing/_options
6666
The failure store redirection can be disabled using this API as well. When the failure store is deactivated, only failed document redirection is halted. Any existing failure data in the data stream will remain until removed by manual deletion or by retention.
6767

6868
```console
69-
PUT my-datastream-existing/_options
69+
PUT _data_stream/my-datastream-existing/_options
7070
{
7171
"failure_store": {
7272
"enabled": false <1>
@@ -78,9 +78,7 @@ PUT my-datastream-existing/_options
7878

7979
### Enable failure store via cluster setting [set-up-failure-store-cluster-setting]
8080

81-
If you have a large number of existing data streams you may want an easier way to control if failures should be redirected. Instead of enabling the failure store using the [put data stream options](./failure-store.md) API, you can instead configure a set of patterns in the [cluster settings](./failure-store.md) which will enable the failure store feature by default.
82-
83-
Configure a list of patterns using the `data_streams.failure_store.enabled` dynamic cluster setting. If a data stream matches a pattern in this setting and does not have the failure store explicitly disabled in its options, then the failure store will default to being enabled for that matching data stream.
81+
If you have a large number of existing data streams you may want to enable their failure stores in one place. Instead of updating each of their options individually, set `data_streams.failure_store.enabled` to a list of index patterns in the [cluster settings](./failure-store.md). Any data streams that match one of these patterns will operate with their failure store enabled.
8482

8583
```console
8684
PUT _cluster/settings
@@ -90,9 +88,29 @@ PUT _cluster/settings
9088
}
9189
}
9290
```
93-
9491
1. Indices that match `my-datastream-*` or `logs-*` will redirect failures to the failure store unless explicitly disabled.
9592

93+
Matching data streams will ignore this configuration if the failure store is explicitly enabled or disabled in their [data stream options](./failure-store.md).
94+
95+
```console
96+
PUT _cluster/settings
97+
{
98+
"persistent" : {
99+
"data_streams.failure_store.enabled" : [ "my-datastream-*", "logs-*" ] <1>
100+
}
101+
}
102+
```
103+
```console
104+
PUT _data_stream/my-datastream-1/_options
105+
{
106+
"failure_store": {
107+
"enabled": false <2>
108+
}
109+
}
110+
```
111+
1. Enabling the failure stores for `my-datastream-*` and `logs-*`
112+
2. The failure store for `my-datastream-1` is disabled even though it matches `my-datastream-*`.
113+
96114
## Using a failure store [use-failure-store]
97115

98116
The failure store is meant to ease the burden of detecting and handling failures when ingesting data to {{es}}. Clients are less likely to encounter unrecoverable failures when writing documents, and developers are more easily able to troubleshoot faulty pipelines and mappings.

0 commit comments

Comments
 (0)