Skip to content

Commit 594a8ab

Browse files
Merge branch 'main' into replace-api-links-troubleshoot
2 parents 5c8fffc + fb2fc77 commit 594a8ab

File tree

162 files changed

+933
-1583
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+933
-1583
lines changed

explore-analyze/alerts-cases/watcher/actions-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The following snippet shows a simple `index` action definition:
4040
| --- | --- | --- | --- |
4141
| `index` | yes* | - | The index, alias, or data stream to index into. Date math expressions like `<my-index-{now/d}>` are also supported.<br><br>*If you dynamically set an `_index` value, this parameter isn’t required. See [Multi-document support](#anatomy-actions-index-multi-doc-support).<br> |
4242
| `doc_id` | no | - | The optional `_id` of the document. |
43-
| `op_type` | no | `index` | The [op_type](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#docs-index-api-op_type) for the index operation. Must be one of either `index` or `create`. Must be `create` if `index` is a data stream. |
43+
| `op_type` | no | `index` | The [op_type](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create) for the index operation. Must be one of either `index` or `create`. Must be `create` if `index` is a data stream. |
4444
| `execution_time_field` | no | - | The field that will store/index the watch execution time. |
4545
| `timeout` | no | 60s | The timeout for waiting for the index api call to return. If no response is returned within this time, the index action times out and fails. This setting overrides the default timeouts. |
4646
| `refresh` | no | - | Optional setting of the [refresh policy](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-refresh.html) for the write request |

explore-analyze/alerts-cases/watcher/actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,9 @@ If you do not define a throttle period at the action or watch level, the global
146146
xpack.watcher.execution.default_throttle_period: 15m
147147
```
148148
149-
{{watcher}} also supports acknowledgement-based throttling. You can acknowledge a watch using the [ack watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html) to prevent the watch actions from being executed again while the watch condition remains `true`. This essentially tells {{watcher}} "I received the notification and I’m handling it, please do not notify me about this error again". An acknowledged watch action remains in the `acked` state until the watch’s condition evaluates to `false`. When that happens, the action’s state changes to `awaits_successful_execution`.
149+
{{watcher}} also supports acknowledgement-based throttling. You can acknowledge a watch using the [ack watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch) to prevent the watch actions from being executed again while the watch condition remains `true`. This essentially tells {{watcher}} "I received the notification and I’m handling it, please do not notify me about this error again". An acknowledged watch action remains in the `acked` state until the watch’s condition evaluates to `false`. When that happens, the action’s state changes to `awaits_successful_execution`.
150150

151-
To acknowledge an action, you use the [ack watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html):
151+
To acknowledge an action, you use the [ack watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch):
152152

153153
```console
154154
POST _watcher/watch/<id>/_ack/<action_ids>

explore-analyze/alerts-cases/watcher/how-watcher-works.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A watch consists of a *trigger*, *input*, *condition*, and *actions*. The action
3535
: Specify what happens when the watch condition is met.
3636

3737
$$$watch-definition-example$$$
38-
For example, the following snippet shows a [create or update watch](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html) request that defines a watch that looks for log error events:
38+
For example, the following snippet shows a [create or update watch](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch) request that defines a watch that looks for log error events:
3939

4040
```console
4141
PUT _watcher/watch/log_errors
@@ -167,10 +167,10 @@ By default, when you add a watch it is immediately set to the *active* state, re
167167

168168
You can also set a watch to the *inactive* state. Inactive watches are not registered with a trigger engine and can never be triggered.
169169

170-
To set a watch to the inactive state when you create it, set the [`active`](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html) parameter to *inactive*. To deactivate an existing watch, use the [deactivate watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html). To reactivate an inactive watch, use the [activate watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html).
170+
To set a watch to the inactive state when you create it, set the [`active`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch) parameter to *inactive*. To deactivate an existing watch, use the [deactivate watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch). To reactivate an inactive watch, use the [activate watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch).
171171

172172
::::{note}
173-
You can use the [execute watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html) to force the execution of a watch even when it is inactive.
173+
You can use the [execute watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch) to force the execution of a watch even when it is inactive.
174174
::::
175175

176176

explore-analyze/alerts-cases/watcher/input-http.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use the `http` input to submit a request to an HTTP endpoint and load the respon
1414
With the `http` input, you can:
1515

1616
* Query external Elasticsearch clusters. The `http` input provides a way to submit search requests to clusters other than the one {{watcher}} is running on. This is useful when you’re running a dedicated {{watcher}} cluster or if you need to search clusters that are running different Elasticsearch versions.
17-
* Query Elasticsearch APIs other than the search API. For example, you might want to load data from the [nodes stats](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html), [cluster health](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html) or [cluster state](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html) APIs.
17+
* Query Elasticsearch APIs other than the search API. For example, you might want to load data from the [nodes stats](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats), [cluster health](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health) or [cluster state](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state) APIs.
1818
* Query external web services. The `http` input enables you to load data from any service that exposes an HTTP endpoint. This provides a bridge between Elasticsearch clusters and other systems.
1919

2020
## Querying external Elasticsearch clusters [_querying_external_elasticsearch_clusters]
@@ -50,7 +50,7 @@ You can use the full Elasticsearch [Query DSL](../../query-filter/languages/quer
5050

5151
## Calling Elasticsearch APIs [_calling_elasticsearch_apis]
5252

53-
To load the data from other Elasticsearch APIs, specify the API endpoint as the `path` attribute. Use the `params` attribute to specify query string parameters. For example, the following `http` input calls the [cluster stats](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html) API and enables the `human` attribute:
53+
To load the data from other Elasticsearch APIs, specify the API endpoint as the `path` attribute. Use the `params` attribute to specify query string parameters. For example, the following `http` input calls the [cluster stats](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats) API and enables the `human` attribute:
5454

5555
```js
5656
"input" : {

explore-analyze/alerts-cases/watcher/input-search.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use the `search` input to load the results of an Elasticsearch search request in
1414
In the search input’s `request` object, you specify:
1515

1616
* The indices you want to search
17-
* The [search type](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-type)
17+
* The [search type](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search)
1818
* The search request body
1919

2020
The search request body supports the full Elasticsearch Query DSL—​it’s the same as the body of an Elasticsearch `_search` request.
@@ -137,9 +137,9 @@ The total number of hits in the search response is returned as an object in the
137137

138138
| Name | Required | Default | Description |
139139
| --- | --- | --- | --- |
140-
| `request.search_type` | no | `query_then_fetch` | The [type](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-type) of search request to perform. Valid values are: `dfs_query_then_fetch` and `query_then_fetch`. The Elasticsearch default is `query_then_fetch`. |
140+
| `request.search_type` | no | `query_then_fetch` | The [type](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) of search request to perform. Valid values are: `dfs_query_then_fetch` and `query_then_fetch`. The Elasticsearch default is `query_then_fetch`. |
141141
| `request.indices` | no | - | The indices to search. If omitted, all indices are searched, which is the default behaviour in Elasticsearch. |
142-
| `request.body` | no | - | The body of the request. The [request body](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html) follows the same structure you normally send in the body of a REST `_search` request. The body can be static text or include `mustache` [templates](how-watcher-works.md#templates). |
142+
| `request.body` | no | - | The body of the request. The [request body](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) follows the same structure you normally send in the body of a REST `_search` request. The body can be static text or include `mustache` [templates](how-watcher-works.md#templates). |
143143
| `request.template` | no | - | The body of the search template. See [configure templates](how-watcher-works.md#templates) for more information. |
144144
| `request.indices_options.expand_wildcards` | no | `open` | How to expand wildcards. Valid values are: `all`, `open`, `closed`, and `none` See [`expand_wildcards`](https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-multi-index) for more information. |
145145
| `request.indices_options.ignore_unavailable` | no | `true` | Whether the search should ignore unavailable indices. See [`ignore_unavailable`](https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-multi-index) for more information. |

explore-analyze/alerts-cases/watcher/managing-watches.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ mapped_pages:
1010

1111
{{watcher}} provides as set of APIs you can use to manage your watches:
1212

13-
* Use the [create or update watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html) to add or update watches
14-
* Use the [get watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html) to retrieve watches
15-
* Use the [delete watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html) to delete watches
16-
* Use the [activate watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html) to activate watches
17-
* Use the [deactivate watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html) to deactivate watches
18-
* Use the [ack watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html) to acknowledge watches
13+
* Use the [create or update watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch) to add or update watches
14+
* Use the [get watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch) to retrieve watches
15+
* Use the [delete watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch) to delete watches
16+
* Use the [activate watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch) to activate watches
17+
* Use the [deactivate watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch) to deactivate watches
18+
* Use the [ack watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch) to acknowledge watches
1919

2020
## Listing watches [listing-watches]
2121

explore-analyze/alerts-cases/watcher/transform-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ The following table lists all available settings for the search {{watcher-transf
4949

5050
| Name | Required | Default | Description |
5151
| --- | --- | --- | --- |
52-
| `request.search_type` | no | query_then_fetch | The search [type](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-type). |
52+
| `request.search_type` | no | query_then_fetch | The search [type](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search). |
5353
| `request.indices` | no | all indices | One or more indices to search on. |
54-
| `request.body` | no | `match_all` query | The body of the request. The [request body](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html) follows the same structure you normally send in the body of a REST `_search` request. The body can be static text or include `mustache` [templates](how-watcher-works.md#templates). |
54+
| `request.body` | no | `match_all` query | The body of the request. The [request body](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) follows the same structure you normally send in the body of a REST `_search` request. The body can be static text or include `mustache` [templates](how-watcher-works.md#templates). |
5555
| `request.indices_options.expand_wildcards` | no | `open` | Determines how to expand indices wildcards. An array consisting of a combination of `open`, `closed`, and `hidden`. Alternatively a value of `none` or `all`. (see [multi-target syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-multi-index)) |
5656
| `request.indices_options.ignore_unavailable` | no | `true` | A boolean value that determines whether the search should leniently ignore unavailable indices (see [multi-target syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-multi-index)) |
5757
| `request.indices_options.allow_no_indices` | no | `true` | A boolean value that determines whether the search should leniently return no results when no indices are resolved (see [multi-target syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-multi-index)) |

explore-analyze/alerts-cases/watcher/watch-cluster-status.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ PUT _watcher/watch/cluster_health_watch
3131

3232
1. Schedules are typically configured to run less frequently. This example sets the interval to 10 seconds to you can easily see the watches being triggered. Since this watch runs so frequently, don’t forget to [delete the watch](#health-delete) when you’re done experimenting.
3333

34-
To get the status of your cluster, you can call the [cluster health API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html):
34+
To get the status of your cluster, you can call the [cluster health API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health):
3535

3636
```console
3737
GET _cluster/health?pretty
@@ -224,7 +224,7 @@ GET .watcher-history*/_search?pretty
224224

225225
Since the `cluster_health_watch` is configured to run every 10 seconds, make sure you delete it when you’re done experimenting. Otherwise, you’ll spam yourself indefinitely.
226226

227-
To remove the watch, use the [delete watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html):
227+
To remove the watch, use the [delete watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch):
228228

229229
```console
230230
DELETE _watcher/watch/cluster_health_watch

explore-analyze/alerts-cases/watcher/watcher-getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ PUT _watcher/watch/log_error_watch
154154

155155
Since the `log_error_watch` is configured to run every 10 seconds, make sure you delete it when you’re done experimenting. Otherwise, the noise from this sample watch will make it hard to see what else is going on in your watch history and log file.
156156

157-
To remove the watch, use the [delete watch API](https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html):
157+
To remove the watch, use the [delete watch API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch):
158158

159159
```console
160160
DELETE _watcher/watch/log_error_watch

0 commit comments

Comments
 (0)