Commit Graph

107 Commits

Author SHA1 Message Date
Alexander Reelsen 25c5707c60
[DOCS] Fix Watcher chapter title (#75220)
Simplifies the Watcher chapter's title to "Watcher."

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-07-22 13:27:05 -04:00
James Rodewig 3d1cb4944d
[DOCS] Overhaul search template docs (#72583)
Changes:

* Adds a tutorial for search templates.
* Adds reference docs for the render search template API.
* Improves parameter documentation for the multi search template API.
* Removes duplicate examples from the search template API, multi search API, and create stored script API docs.
* Splits the source files for the search template API and the multi search template API docs.
2021-06-30 16:03:49 -04:00
James Rodewig 39a0314d30
[DOCS] Update alias xrefs (#73380)
Updates several internal 'alias' xrefs to point to the aliases guide rather than
API docs.
2021-05-25 16:19:00 -04:00
Julie Tibshirani fdf254335f
Remove more references to query_and_fetch. (#71988)
This search type was deleted several releases ago.
2021-04-23 09:19:57 -07:00
James Rodewig 693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
Adam Locke aba4422606
[DOCS] Focus scripting docs on Painless (#69748)
* Initial changes for scripting.

* Shorten script examples.

* Expanding types docs.

* Updating types.

* Fixing broken cross-link.

* Fixing map error.

* Incorporating review feedback.

* Fixing broken table.

* Adding more info about reference types.

* Fixing broken path.

* Adding more info an examples for def type.

* Adding more info on operators.

* Incorporating review feedback.

* Adding notconsole for example.

* Removing comments in example.

* More review feedback.

* Editorial changes.

* Incorporating more reviewer feedback.

* Rewrites based on review feedback.

* Adding new sections for storing scripts and shortening scripts.

* Adding redirect for stored scripts.

* Adding DELETE for stored script plus link.

* Adding section for updating docs with scripts.

* Incorporating final feedback from reviews.

* Tightening up a few areas.

* Minor change around other languages.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-18 15:58:33 -04:00
James Rodewig 5c75d004fa
[DOCS] Replace `put` with `create or update` in API names (#70330)
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-15 14:49:44 -04:00
James Rodewig 31fc59efdf
[DOCS] Fix capitalization for Query DSL (#69236) 2021-02-18 18:57:19 -05:00
James Rodewig 9b88ae92e6
[DOCS] Fix typos for duplicate words (#69125) 2021-02-17 10:34:20 -05:00
Jay Modi 1dacf7248b
Allow partial indices options in watches (#68076)
Partially defined indices options have always been allowed in watches,
but the cleanup in #65332 removed this ability and made the definition
of indices options within a watch require all fields. This change fixes
this by updating the parsing to accept a default indices options and
add test coverage for this scenario.

Closes #68022
2021-01-28 08:31:54 -07:00
James Rodewig b357fe35cf
[DOCS] removing extra double quote from example (#67667) (#67718)
Co-authored-by: Vincent Fuchs <vincent.fuchs@gmail.com>
2021-01-19 13:00:59 -05:00
debadair ce5a1a980d
[DOCS] Qualified Watcher topics to distinguish from Kib Alerting (#65908)
* [DOCS] Qualified Watcher topics to distinguish from Kib Alerting

* Reverted actions anchor due to client links.

* Updated redirects.

* Fixed links.

* Roll back anchor changes

* Apply suggestions from code review

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

* Incorporated review comments.
2020-12-08 13:04:32 -08:00
James Rodewig 5cad64c6d1
[DOCS] Change `ctx.payload.hits.total.value` to `ctx.payload.hits.total` (#65874) (#66031)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Ernesto Reig <ernesto.reig@gmail.com>
2020-12-08 12:24:24 -05:00
Martijn van Groningen 4e7adad423
Remove more usages of .watches system index. (#65835)
Make use of the new query watches api to simply list watches or
to delete all watches using the delete watch api.

Relates to #62501
2020-12-04 10:36:46 +01:00
Dan Hermann 4d084c9e11
Add missing comma in sample payload for the watcher's pagerduty action (#65819) 2020-12-03 09:12:28 -06:00
Pius 699af9dbf1
[DOCS] Fix obsolete Slack setup info (#57834)
Slack no longer recommends the legacy "integrations" setup (https://api.slack.com/legacy/custom-integrations/incoming-webhooks).  Updated documentation to reference https://api.slack.com/messaging/webhooks instead.  

Removed screenshots from our documentation related to Slack setup.  We should avoid these screenshots (and simply point to Slack documentation) for Slack may change the instructions/their UI in the future.

Also added a short note on the use case of notifying multiple Slack channels.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-11-24 12:09:00 -05:00
Dan Hermann ad71547001
Add configurable op_type for index watcher action (#64590) 2020-11-05 07:09:55 -06:00
James Rodewig 4f82e667ae
[DOCS] Fix "the the" typos (#64344) 2020-10-29 10:11:58 -04:00
Gordon Brown 91f4b58bf7
Deprecate REST access to System Indices (#60945)
This PR adds deprecation warnings when accessing System Indices via the REST layer. At this time, these warnings are only enabled for Snapshot builds by default, to allow projects external to Elasticsearch additional time to adjust their access patterns.

Deprecation warnings will be triggered by all REST requests which access registered System Indices, except for purpose-specific APIs which access System Indices as an implementation detail a few specific APIs which will continue to allow access to system indices by default:

- `GET _cluster/health`
- `GET {index}/_recovery`
- `GET _cluster/allocation/explain`
- `GET _cluster/state`
- `POST _cluster/reroute`
- `GET {index}/_stats`
- `GET {index}/_segments`
- `GET {index}/_shard_stores`
- `GET _cat/[indices,aliases,health,recovery,shards,segments]`

Deprecation warnings for accessing system indices take the form:
```
this request accesses system indices: [.some_system_index], but in a future major version, direct access to system indices will be prevented by default
```
2020-10-06 11:13:48 -06:00
James Rodewig c688cb6bfd
[DOCS] Fix hyphenation for "time series" (#61472) 2020-08-24 10:34:41 -04:00
James Rodewig a94e5cb7c4
[DOCS] Replace Wikipedia links with attribute (#61171) 2020-08-17 09:44:24 -04:00
James Rodewig 9b9e0b7b16
[DOCS] Remove search request body page (#60972) 2020-08-11 12:05:54 -04:00
James Rodewig 56b10db121
[DOCS] Update pre-existing data stream refs (#60289) 2020-07-28 09:32:15 -04:00
James Rodewig 441c3a21b1
[DOCS] Update my-index examples (#60132)
Changes the following example index names to `my-index-000001` for consistency:

* `my-index`
* `my_index`
* `myindex`
2020-07-27 14:46:39 -04:00
James Rodewig 2774cd6938
[DOCS] Swap `[float]` for `[discrete]` (#60124)
Changes instances of `[float]` in our docs for `[discrete]`.

Asciidoctor prefers the `[discrete]` tag for floating headings:
https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 11:48:22 -04:00
James Rodewig 80b674fb25
[DOCS] Reformat snippets to use two-space indents (#59973) 2020-07-21 12:24:26 -04:00
Lisa Cawley 751e2d0deb
[DOCS] Fixes license management links (#58213) 2020-06-16 16:43:54 -07:00
Hossein Dehghan cf5f01112a
[Docs] Fix missing closing bracket for watcher webhook.asciidoc (#57803) 2020-06-09 13:59:33 +02:00
Luiz Guilherme Pais dos Santos eb9de19258
[DOCS] Add watcher multi-doc index ex (#52040)
Adds an example snippet for creating a `_doc` payload field with the
Watcher `index` action.
2020-05-20 16:01:12 -04:00
Florian Kelbert 12f61a933b [Docs] Insert missing colon (#56980) 2020-05-20 15:50:08 +02:00
debadair 1412e80266
[DOCS] Extract the cron docs from Watcher docs and add to the API conventions. (#56313)
* [DOCS] Promote cron expressions info from Watcher to a separate topic.

* Fix table error

* Fixed xref

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* Incorporated review feedback

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-05-12 15:32:47 -07:00
James Rodewig 1353d8b7dd
[DOCS] Correct watcher event data example (#56469)
* Swaps outdated index patterns for the default `logstash` index alias.
  Adds some related information about Logstash ILM defaults to the callout.

* Swaps `*.raw` fields for `*.keyword` fields. The Logstash template
  uses `keyword` fields by default since 6.x.

* Swaps instances of `ctx.payload.hits.total.value` with
  `ctx.payload.hits.total`
2020-05-12 15:39:00 -04:00
debadair f1fbb40fd1
[DOCS] Removed obsolete warning about no way to securely store passwords (#55133)
* [DOCS] Removed obsolete warning about no way to securely store passwords.

* Update x-pack/docs/en/watcher/actions/email.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2020-04-13 20:26:43 -07:00
Lisa Cawley 42cc589abe
[DOCS] Add missing anchors in cron expressions (#52960) 2020-03-02 09:05:20 -08:00
Florian Kelbert 66bbb39043 [DOCS] Fixes missing colon (#52797) 2020-02-25 16:53:09 -08:00
Florian Kelbert adb56e5842 [DOCS] Correctly read total hits inside watcher config (#50614)
With elastic/elasticsearch#35848, users can now retrieve total hits as an integer when the `rest_total_hits_as_int` query parameter is `true`. This is the default value.

This updates several snippet examples in the Watcher docs that used a workaround to get a total hits integer.
2020-01-16 09:35:23 -05:00
Florian Kelbert 30c3b34441
[DOCS] Correctly read total hits inside watcher config
Relates to #50611 and #50612
2020-01-14 12:58:25 +01:00
James Rodewig cfddddda0b
[DOCS] Fix search request body links (#50500)
PR #44238 changed several links related to the Elasticsearch search request body API. This updates several places still using outdated links or anchors.

This will ultimately let us remove some redirects related to those link changes.
2019-12-26 14:20:51 -05:00
Orhan Toy 48342740c5 [DOCS] Fixes "enables you to" typos (#50225) 2019-12-23 14:38:37 -05:00
Lisa Cawley e5ba242e90
[DOCS] Qualifies Watcher transforms (#47482) 2019-11-20 16:41:58 -08:00
Alan Woodward 566e1b7d33
Remove type field from DocWriteRequest and associated Response objects (#47671)
This commit removes the type field from index, update and delete requests, and their
associated responses.

Relates to #41059
2019-10-11 10:23:55 +01:00
Lisa Cawley e1a30179ba
[DOCS] Fixes missing link title (#47481) 2019-10-03 07:41:40 -07:00
Lisa Cawley 91992a805f
[DOCS] Moves Watcher content into Elasticsearch book (#47147)
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-09-27 16:05:44 -07:00
Lisa Cawley 588aecf6ea
[DOCS] Updates links to reporting content (#46717) 2019-09-13 11:38:51 -07:00
Lisa Cawley 7f1e500512
[DOCS] Adds missing icons to Watcher HLRC APIs (#46626) 2019-09-11 16:32:47 -07:00
Lisa Cawley beec239c1d
[DOCS] Add missing xpack role attributes (#46468) 2019-09-10 10:32:51 -07:00
James Rodewig 5c78f606c2
[DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
jbonn360 859e38783d Watcher max_iterations with foreach action execution (#45715)
Prior to this commit the foreach action execution had a hard coded 
limit to 100 iterations. This commit allows the max number of 
iterations to be a configuration ('max_iterations') on the foreach 
action. The default remains 100.
2019-08-27 11:48:39 -05:00
Alison Goryachev 60474bb335
[DOCS] Fix watcher email action docs (#44877) 2019-08-02 13:58:44 -04:00
Lisa Cawley 280b40eaa4
[DOCS] Adds command reference for elasticsearch-croneval (#43946) 2019-07-25 11:32:31 -07:00