You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: manage-data/data-store/data-streams/failure-store.md
+24-6Lines changed: 24 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Enabling the failure store via [index templates](../templates.md) can only affec
52
52
To modify an existing data stream's options, use the [put data stream options](./failure-store.md) API:
53
53
54
54
```console
55
-
PUT my-datastream-existing/_options
55
+
PUT _data_stream/my-datastream-existing/_options
56
56
{
57
57
"failure_store": {
58
58
"enabled": true <1>
@@ -66,7 +66,7 @@ PUT my-datastream-existing/_options
66
66
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.
67
67
68
68
```console
69
-
PUT my-datastream-existing/_options
69
+
PUT _data_stream/my-datastream-existing/_options
70
70
{
71
71
"failure_store": {
72
72
"enabled": false <1>
@@ -78,9 +78,7 @@ PUT my-datastream-existing/_options
78
78
79
79
### Enable failure store via cluster setting [set-up-failure-store-cluster-setting]
80
80
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.
84
82
85
83
```console
86
84
PUT _cluster/settings
@@ -90,9 +88,29 @@ PUT _cluster/settings
90
88
}
91
89
}
92
90
```
93
-
94
91
1. Indices that match `my-datastream-*` or `logs-*` will redirect failures to the failure store unless explicitly disabled.
95
92
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).
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
+
96
114
## Using a failure store [use-failure-store]
97
115
98
116
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