Commit graph

245 commits

Author SHA1 Message Date
Craig Taverner
c9c1765986
Remove duplicate 'the the' (#116023)
There were many places where `the the` was typed, in comments, docs and messages. All were incorrect and replaces with a single `the`
2024-10-31 19:14:58 +01:00
Stef Nestor
612ce0f996
(Doc+) Link API doc to parent object - part2 (#113541)
* (Doc+) Cross-link CAT APIs to parent object

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-10-09 14:21:56 -06:00
Valeriy Khakhutskyy
7b7dd91f62
[ML] Add documentation for post calendar events API (#113188)
This PR updates the documentation for the extension of the POST calendar events API implemented in #112837.
2024-09-24 09:46:42 +02:00
Valeriy Khakhutskyy
5a7a032cea
[ML] Force time shift documentation (#111668)
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2024-08-09 11:12:46 +02:00
Valeriy Khakhutskyy
87d9a0b268
[ML] Extend lat_long documentation (#111239)
This PR adds the explanation of what "typical" means for the lat_long function.
2024-07-25 10:32:36 +02:00
Lisa Cawley
a079cdc17d
[DOCS] Update transform and anomaly detection rule creation steps (#107975) 2024-05-07 07:52:45 -07:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Niels Bauman
0f3ac367ac
Rename values of FailureStoreOptions (#107062)
With these new values, there's a better match between selecting failure stores in read and write operations.
2024-04-06 08:46:38 +02:00
István Zoltán Szabó
de7e8980d1
[DOCS] Amends important note on delayed data detection. (#106610) 2024-03-21 16:41:31 +01:00
István Zoltán Szabó
5d7549c2c8
[DOCS] Documents scripted metric aggregation limitation in datafeeds (#106059) 2024-03-07 14:07:14 +01:00
Mary Gouseti
6fbf9892aa
Add the parameter failure_store to multi-target syntax APIs (#105386)
In this PR we introduce a new query parameter behind the failure store feature flag. The query param, `faliure_store` allows the multi-syntax supporting APIs to choose the failure store indices as well. If an API should not support failure store, the `allowFailureStore` flag should be `false`.
2024-03-06 14:04:18 +02:00
Lisa Cawley
1cfa86ee13
[DOCS] Update anomaly detection jobs health rule details (#105716) 2024-02-22 08:26:31 -08:00
David Roberts
35aff34912
[ML] Add an important note about a gotcha with the delayed data check (#104725)
Recently a user saw spurious delayed data warnings. These turned
out to be due to accidentally setting `summary_count_field` to a
field that was always zero. This meant that every document was
considered delayed.
2024-01-25 14:31:24 +00:00
István Zoltán Szabó
56be53adac
[DOCS] Fixes link in PUT datafeeds API docs. (#102684) 2023-11-28 10:47:24 +01:00
István Zoltán Szabó
cb5a702174
[DOCS] Expands anomaly alerts docs with info on Anomaly Explorer integration. (#102477) 2023-11-23 14:33:06 +01:00
Abdon Pijpelink
70128f5b74
[DOCS] Mark 'ignore_throttled' deprecated in all docs (#101838) 2023-11-07 13:03:49 +01:00
Lisa Cawley
3418c6a2af
[DOCS] Alerts-as-data for anomaly detection rules (#100864) 2023-10-17 07:37:22 -07:00
DeDe Morton
e3f1c15788
Update ml-delayed-data-detection.asciidoc (#99843) 2023-09-26 11:18:24 +02:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00
Ed Savage
3682a88199
[ML] Update documentation regarding versioning. (#98320)
Update the ml and transform reference documentation to provide information regarding the new versioning schemes independent from the product versions.

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-08-10 11:20:58 +01:00
István Zoltán Szabó
3fd94678e6
[DOCS] Adds important admonition to handling delayed data page (#97753) 2023-07-19 13:32:06 +02:00
David Roberts
708730e27c
[ML] Add _meta field to data frame analytics config (#94529)
This PR adds a new field, `_meta`, to the data frame
analytics configuration.

The `_meta` field stores an arbitrary key-value map.
Keys are strings. Values are arbitrary objects
(possibly also maps).

The `_meta` field can be updated using the data frame
analytics `_update` endpoint.
2023-03-20 11:53:53 +00:00
Lisa Cawley
f49bb09503
[DOCS] Refresh screenshots for machine learning rules (#93805) 2023-02-15 15:43:30 -08:00
István Zoltán Szabó
9229011000
[DOCS] Adds size parameter details to aggregating data for faster performance page (#93475) 2023-02-02 19:29:11 +01:00
István Zoltán Szabó
05c77534fe
[DOCS] Fixes markup for example in count function docs. (#93308) 2023-01-27 14:41:30 +01:00
Valeriy Khakhutskyy
c24712bfa7
[ML] Add multimodal distribution field processing for anomaly score explanation (#92978)
The companion PR to elastic/ml-cpp#2440 adds processing of multimodal_distribution field in the anomaly score explanation. I added a changelog entry in the ml-cpp PR hence I mark this PR as a non-issue.
2023-01-17 21:16:12 +01:00
David Roberts
1be17d8c55
[ML] Correct the update datafeed docs (#92227)
These docs previously implied that you could update datafeed
properties while the datafeed was running, but then would have
to stop and restart it for the changes to take effect.

In fact datafeed updates can only be made while the datafeed is
stopped (and this has been the case for many years, if not forever).
2022-12-08 09:58:48 +00:00
István Zoltán Szabó
f5b98b3182
[DOCS] Documents how aggregate_metric_double works in datafeeds (#92139) 2022-12-07 09:28:38 +01:00
Lisa Cawley
3f2f9de928
[DOCS] Refresh machine learning rule docs (#92013) 2022-12-05 07:47:42 -08:00
Ed Savage
e0e32caf28
[ML] Option to delete user-added annotations for the reset/delete job APIs (#91698)
Currently there is no way to remove user-added annotations when a job is deleted or reset.
This change adds an option - delete_user_annotations - to both the delete and reset job APIs.
The default value is false, to keep the behaviour of these calls as it is currently.
2022-11-18 17:17:33 +00:00
Lisa Cawley
9e83084020
[DOCS] Clarify description of geo_results (#91237) 2022-11-04 08:15:46 -07:00
Valeriy Khakhutskyy
7c4186ddbc
[ML] Update API documentation for anomaly score explanation (#91177)
This PR updates the API documentation to match the UI.

Co-authored-by: lcawl <lcawley@elastic.co>
2022-11-01 21:43:33 +01:00
Valeriy Khakhutskyy
95758e88a2
[ML] Explain anomaly score factors (#90675)
This PR surfaces new information about the impact of the factors on the initial anomaly score in the anomaly record:

- single bucket impact is determined by the deviation between actual and typical in the current bucket
- multi-bucket impact is determined by the deviation between actual and typical in the past 12 buckets
- anomaly characteristics are statistical properties of the current anomaly compared to the historical observations
- high variance penalty is the reduction of anomaly score in the buckets with large confidence intervals.
- incomplete bucket penalty is the reduction of anomaly score in the buckets with fewer samples than historically expected.

Additionally, we compute lower- and upper-confidence bounds and the typical value for the anomaly records. This improves the explainability of the cases where the model plot is not activated with only a slight overhead in performance (1-2%).
2022-10-12 16:57:06 +02:00
István Zoltán Szabó
7de1a6efc5
[DOCS] Simplifies composite aggregation recommendation (#89878) 2022-09-07 17:54:05 +02:00
István Zoltán Szabó
e244473962
[DOCS] Reworks aggregating data for faster performance page (#89575) 2022-09-01 13:59:05 +02:00
István Zoltán Szabó
74d694e0fd
[DOCS] Resizes anomaly detection screenshot properly. (#89544) 2022-08-23 16:38:15 +02:00
Benjamin Trent
a044b5c01e
[ML] make composite aggs in datafeeds Generally Available (#88589)
Commit makes composite aggs in datafeeds generally available.
2022-07-19 12:41:25 -04:00
Lisa Cawley
c9b4499d2e
[DOCS] Add authorization details to update datafeed API (#88099) 2022-06-28 13:43:58 -07:00
Lisa Cawley
aa19690990
[DOCS] Add authorization to anomaly detection job and datafeed API examples (#87937) 2022-06-27 13:05:35 -07:00
Lisa Cawley
76cd7b63a4
[DOCS] Add authorization info to get anomaly detection jobs API (#87904) 2022-06-22 15:15:33 -07:00
István Zoltán Szabó
78c0ad91fc
[DOCS] Adds note to time_of_week function about how values are calculated (#87871)
Co-authored-by: Tom Veasey <tveasey@users.noreply.github.com>
2022-06-22 10:22:49 +02:00
Lisa Cawley
5b6838e6ec
[DOCS] Fix typo in anomaly detection example (#87668) 2022-06-14 14:34:33 -07:00
Lisa Cawley
32f6082b7e
[DOCS] Typo in time functions (#87373) 2022-06-03 08:40:12 -07:00
István Zoltán Szabó
a71ad6e407
[DOCS] Expands AD and Transform alert docs with info on context for recovered alerts (#87118) 2022-06-02 09:52:47 +02:00
Benjamin Trent
115f19ff6d
[ML] adds start and end params to _preview and excludes cold/frozen tiers from unbounded previews (#86989)
n larger clusters with complicated datafeed requirements, being able to preview only a specific window of time is important. Previously, datafeed previews would always start at 0 (or from the beginning of the data). This causes issues if the index pattern contains indices on slower hardware, but when the datafeed is actually started, the "start" time is set to more recent data (and thus on faster hardware).

Additionally, when _preview is unbounded (as before), it attempts to only preview indices that are NOT frozen or cold. This is done through a query against the _tier field. Meaning, it only effects newer indices that actually have that field set.
2022-05-20 13:56:53 -04:00
Lisa Cawley
458ef91066
[DOCS] Move ML info and upgrade APIs (#84005) 2022-02-16 11:23:00 -08:00
Tobias Stadler
e3deacf547
[DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
István Zoltán Szabó
b42ba64019
[DOCS] Fixes geo function field names. (#83198) 2022-01-27 12:03:58 +01:00
Ugo Sangiorgi
305ff20b8f
[DOCS] Add missing HTML anchors to CCR and ML (#80287) 2022-01-26 11:00:40 -08:00
István Zoltán Szabó
a5affc7104
[DOCS] Fixes field names in ML sum functions. (#83048) 2022-01-25 15:28:06 +01:00