Commit Graph

82 Commits

Author SHA1 Message Date
Dimitris Athanasiou 5eea355b33 [ML] Add overall buckets api (elastic/x-pack-elasticsearch#2713)
Adds the GET overall_buckets API.

The REST end point is: GET
/_xpack/ml/anomaly_detectors/job_id/results/overall_buckets

The API returns overall bucket results. An overall bucket
is a summarized bucket result over multiple jobs.
It has the `bucket_span` of the longest job's `bucket_span`.
It also has an `overall_score` that is the `top_n` average of the
max anomaly scores per job.

relates elastic/x-pack-elasticsearch#2693

Original commit: elastic/x-pack-elasticsearch@ba6061482d
2017-10-10 14:41:24 +01:00
Dimitris Athanasiou 90e327032e [ML][DOCS] Fix bucket_span type in results resources (elastic/x-pack-elasticsearch#2714)
Original commit: elastic/x-pack-elasticsearch@af24bde71f
2017-10-10 12:51:12 +01:00
Russ Cam 9b97f50001 [DOCS] Update type for category_id (elastic/x-pack-elasticsearch#2197)
Make category_id a long to align with the implementation.

Original commit: elastic/x-pack-elasticsearch@9873824281
2017-09-27 15:08:37 +01:00
lcawley af2b2ca542 [DOCS] Add random default datafeed query delay
Original commit: elastic/x-pack-elasticsearch@d886f09192
2017-09-19 09:54:11 -07:00
David Roberts ea94ef3aa9 [ML] Update docs for change to default model memory limit (elastic/x-pack-elasticsearch#2308)
This is the doc change for elastic/x-pack-elasticsearch#2300

Original commit: elastic/x-pack-elasticsearch@acd683d06a
2017-08-21 16:51:30 +01:00
Lisa Cawley 702c192c35 [DOCS] Fix model_plot_config in ML create job API (elastic/x-pack-elasticsearch#2316)
Original commit: elastic/x-pack-elasticsearch@2ef32e52cd
2017-08-18 15:06:24 -07:00
Lisa Cawley 17b4720df7 [DOCS] Add missing ML create job API options (elastic/x-pack-elasticsearch#2268)
* [DOCS] Add missing ML create job API options

* [DOCS] Small fixes in ML create job API

Original commit: elastic/x-pack-elasticsearch@369bd5bfbb
2017-08-18 13:00:15 -07:00
Lisa Cawley d76969a431 [DOCS] Update example for default model memory limit (elastic/x-pack-elasticsearch#2312)
Original commit: elastic/x-pack-elasticsearch@815d63d1bf
2017-08-18 11:29:08 -07:00
Lisa Cawley e97b6dcc47 [DOCS] Add job groups to ML create/update job APIs (elastic/x-pack-elasticsearch#2290)
* [DOCS] Add job groups to ML create/update job APIs

* [DOCS] Fix ML update job API example

* [DOCS] Address feedback for ML create/update job APIs

Original commit: elastic/x-pack-elasticsearch@0e7bb47342
2017-08-17 12:52:29 -07:00
David Roberts cb3f3d2d04 [ML] Switch from max_running_jobs to xpack.ml.max_open_jobs (elastic/x-pack-elasticsearch#2232)
This change makes 2 improvements to the max_running_jobs setting:

1. Namespaces it by adding the xpack.ml. prefix
2. Renames "running" to "open", because the "running" terminology
   is not used elsewhere

The old max_running_jobs setting is used as a fallback if the new
xpack.ml.max_open_jobs setting is not specified.  max_running_jobs
is deprecated and (to ease backporting in the short term) will be
removed from 7.0 in a different PR closer to release of 7.0.

Relates elastic/x-pack-elasticsearch#2185

Original commit: elastic/x-pack-elasticsearch@18c539f9bb
2017-08-11 09:00:33 +01:00
David Kyle c4910098b0 [Docs] Change indexes -> indices in datafeed config example (elastic/x-pack-elasticsearch#2227)
Original commit: elastic/x-pack-elasticsearch@7ddd36360e
2017-08-10 16:22:59 +01:00
Lisa Cawley 1bb3ad38c7 [DOCS] Update APIs for multiple jobs or datafeeds (elastic/x-pack-elasticsearch#2105)
* [DOCS] Update APIs for multiple jobs or datafeeds

* [DOCS] Fix syntax diagrams for ML stop/close APIs

* [DOCS] Removed TBD authorization for ML APIs

Original commit: elastic/x-pack-elasticsearch@1a9137a5a7
2017-08-09 08:30:21 -07:00
Lisa Cawley bf92450fc4 [DOCS] Update multivariate_by_fields (elastic/x-pack-elasticsearch#2147)
Original commit: elastic/x-pack-elasticsearch@a26025ac5e
2017-08-02 08:25:46 -07:00
Lisa Cawley 6614c86413 [DOCS] Fix ML latency definition (elastic/x-pack-elasticsearch#2091)
Original commit: elastic/x-pack-elasticsearch@78c9cb387c
2017-07-27 08:25:14 -07:00
Lisa Cawley 1159f7bfa4 [DOCS] Fix update snapshot API description (elastic/x-pack-elasticsearch#2089)
Original commit: elastic/x-pack-elasticsearch@3d98bfad3f
2017-07-27 08:17:17 -07:00
Lisa Cawley 449064337d [DOCS] Clarify null behaviour in ML resources (elastic/x-pack-elasticsearch#2090)
* [DOCS] Clarify null behaviour in ML resources

* [DOCS] Add category error information

Original commit: elastic/x-pack-elasticsearch@21cdb4fb36
2017-07-27 08:02:46 -07:00
Lisa Cawley 31b02c3941 [DOCS] Update model_memory_limit (elastic/x-pack-elasticsearch#1928)
* [DOCS] Update model_memory_limit

* [DOCS] Clarify minimum model_memory_limit value

* [DOCS] More updates to model_memory_limit

* [DOCS] Address feedback in jobresource.asciidoc

Original commit: elastic/x-pack-elasticsearch@3c62719037
2017-07-10 08:50:38 -07:00
Dimitris Athanasiou 4e03c657a3 [ML] Write model_memory_limit with units into the cluster state (elastic/x-pack-elasticsearch#1934)
This is step 2 of elastic/x-pack-elasticsearch#1604

This change stores `model_memory_limit` as a string with `mb` unit.
I considered using the `toString` method of `ByteSizeValue` but it
can lead to accuracy loss. Adding the fixed `mb` unit maintains
the accuracy, while making clear what unit the value is in.

Original commit: elastic/x-pack-elasticsearch@4dc48f0ce8
2017-07-06 15:40:19 +01:00
Lisa Cawley 2f1693c0fd [DOCS] Update ML open job API (elastic/x-pack-elasticsearch#1875)
Original commit: elastic/x-pack-elasticsearch@00a76d79ae
2017-06-28 10:27:05 -07:00
Sophie Chang a9f86f6d1b [DOCS] Model plot updates (elastic/x-pack-elasticsearch#1803)
* [DOCS] Model plot updates

Add to job create.
Remove terms from job resource.

* [DOCS] Describing terms as experimental

Original commit: elastic/x-pack-elasticsearch@815fa0ec37
2017-06-28 07:40:08 -07:00
lcawley 0b51f7326d [DOCS] Fixed terms typo
Original commit: elastic/x-pack-elasticsearch@25d5e829d3
2017-06-26 07:46:47 -07:00
Lisa Cawley 2b1d5f2cf2 [DOCS] Add ML configuration details and examples for script fields (elastic/x-pack-elasticsearch#1593)
* [DOCS] Add ML info about script fields

* [DOCS] Add links to ML script fields page

* [DOCS] Add ML API examples to transforms.asciidoc

* [DOCS] Addressed feedback in ML script field examples

* [DOCS] Add preview to ML script fields example

* [DOCS] Expanded code snippets in ML transform examples

* [DOCS] Add output for ML scripted fields example

* [DOCS] Add output for more ML scripted field examples

* [DOCS] Add output for final ML scripted field examples

* [DOC] Add Kibana details for ML script fields

* [DOCS] Remove example from ML transforms

Original commit: elastic/x-pack-elasticsearch@51057b029f
2017-06-23 11:42:37 -07:00
lcawley 431118b123 [DOCS] Add links to population analysis
Original commit: elastic/x-pack-elasticsearch@52e1cd36e2
2017-06-23 11:24:47 -07:00
Lisa Cawley b41ff62bcc [DOCS] Update ML APIs for Elasticsearch Reference (elastic/x-pack-elasticsearch#1718)
* [DOCS] Update ML APIs for Elasticsearch Reference

* [DOCS] Add X-Pack icon for ML APIs

* [DOCS] Add role attribute to ML APIs

Original commit: elastic/x-pack-elasticsearch@997ea39759
2017-06-19 18:23:58 -07:00
David Roberts 03652e7497 [ML] Kill autodetect on force close and isolated node rejoining (elastic/x-pack-elasticsearch#1742)
Prior to this change, if the persistent tasks framework noticed that a
job was running on a node that was isolated but has rejoined the cluster
then it would close that job.  This was not ideal, because then the job
would persist state from the autodetect process that was isolated.  This
commit changes the behaviour to kill the autodetect process associated
with such a job, so that it does not interfere with the autodetect process
that is running on the node where the persistent tasks framework thinks it
should be running.

In order to achieve this a change has also been made to the behaviour of
force-close.  Previously this would result in the autodetect process being
gracefully shut down asynchronously to the force-close request.  However,
the mechanism by which this happened was the same as the mechanism for
cancelling tasks that end up running on more than one node due to nodes
becoming isolated from the cluster.  Therefore, force-close now also kills
the autodetect process rather than gracefully stopping it.  The documentation
has been changed to reflect this.  It should not be a problem as force-close
is supposed to be a last resort for when normal close fails.

relates elastic/x-pack-elasticsearch#1186

Original commit: elastic/x-pack-elasticsearch@578c944371
2017-06-19 10:16:51 +01:00
Lisa Cawley 62ee1bc635 [DOCS] Add ML categorization of messages (elastic/x-pack-elasticsearch#1666)
* [DOCS] Add ML categorization of messages

* [DOCS] Describe ML categorization_examples_limit property

* [DOCS] Updated ML categorization of messages

* [DOCS] Add links to ML categorization

Original commit: elastic/x-pack-elasticsearch@6403f6ce84
2017-06-12 10:41:14 -07:00
Ryan Ernst c1a3f50e19 Convert script uses to use source/id keys (elastic/x-pack-elasticsearch#1670)
This is the xpack side of
https://github.com/elastic/elasticsearch/pull/25127

Original commit: elastic/x-pack-elasticsearch@e25bd90825
2017-06-09 08:29:36 -07:00
Lisa Cawley 15e4958d4e [DOCS] Update get datafeed statistics API output (elastic/x-pack-elasticsearch#1678)
Original commit: elastic/x-pack-elasticsearch@7e65102ac0
2017-06-09 07:48:51 -07:00
Lisa Cawley e29ab36849 [DOCS] Describe how to identify active ML model snapshot (elastic/x-pack-elasticsearch#1677)
Original commit: elastic/x-pack-elasticsearch@61766d0975
2017-06-08 16:02:41 -07:00
Lisa Cawley 63138f02c5 [DOCS] Move ML APIs up a level in TOC (elastic/x-pack-elasticsearch#1644)
Original commit: elastic/x-pack-elasticsearch@6048721806
2017-06-06 13:42:47 -07:00
Dimitris Athanasiou 3f6e640f90 [ML] Add force delete datafeed action (elastic/x-pack-elasticsearch#1623)
When a user or client intend to delete a datafeed
and its job, there is benefit into ensuring the
datafeed has gracefully stopped (ie no data loss).
In constrast, the desired behaviour is to stop and
delete the datafeed as quickly as possible.

This change adds a force option to the delete
datafeed action. When the delete is forced,
the datafeed is isolated, its task removed and,
finally, the datafeed itself is removed from the
metadata.

relates elastic/x-pack-elasticsearch#1533

Original commit: elastic/x-pack-elasticsearch@5ae0168bf2
2017-06-06 13:39:36 +01:00
David Kyle ce0315abc4 [ML] Add force delete job option (elastic/x-pack-elasticsearch#1612)
* Add force delete job option

* Can’t kill a process on a 5.4 node

* Address review comments

* Rename KillAutodetectAction -> KillProcessAction

* Review comments

* Cancelling task is superfluous after it has been killed

* Update docs

* Revert "Cancelling task is superfluous after it has been killed"

This reverts commit 576950e2e1ee095b38174d8b71de353c082ae953.

* Remove unnecessary TODOs and logic that doesn't alwasys force close

Original commit: elastic/x-pack-elasticsearch@f8c8b38217
2017-06-06 09:41:33 +01:00
David Roberts babe27afe0 [ML] Add a detector_index field to detectors, and use it for updates (elastic/x-pack-elasticsearch#1613)
Detectors now have a field called detector_index.  This is also now the
field that needs to be supplied when updating a detector.  (Previously
it was simply index, which was confusing.)

When detectors are added to an analysis_config it will reassign
ascending detector_index values starting from 0.  The intention is
never to allow deletion of detectors from an analysis_config, but
possibly to allow disabling them in the future.  This ensures that
detector_index values in results will always tie up with detector_ids
in the detectors that created them.

relates elastic/x-pack-elasticsearch#1275

Original commit: elastic/x-pack-elasticsearch@20a660b07b
2017-06-02 10:26:01 +01:00
David Roberts cc96580cd6 [ML] Remove record_count from bucket results (elastic/x-pack-elasticsearch#1568)
relates elastic/x-pack-elasticsearch#1564

Original commit: elastic/x-pack-elasticsearch@0caff1a735
2017-05-26 16:57:40 +01:00
David Kyle d9882be292 [ML] Use unique and predictable IDs for result docs (elastic/x-pack-elasticsearch#1521)
* Remove sequenceNum from anomaly records and influencers

* Generate unqiue IDs without sequence numbers

* Remove more instances of sequence_num

* Handle parsing sequnce_num from v5.4

Original commit: elastic/x-pack-elasticsearch@e60b206daf
2017-05-24 09:59:17 +01:00
Lisa Cawley 386ac7345c [DOCS] Add details about using aggregations with machine learning (elastic/x-pack-elasticsearch#1446)
* [DOCS] Add ML aggregations configuration scenario

* [DOCS] Refine ML configuration page

* [DOCS] Add ML aggregation details

* [DOCS] Add links to aggregations in Configuring ML

* [DOCS] Address feedback about ML aggregations

Original commit: elastic/x-pack-elasticsearch@8474144093
2017-05-23 14:34:21 -07:00
David Kyle f3c94915b0 [ML] Add sort parameter for get buckets (elastic/x-pack-elasticsearch#1464)
* Add sort parameter for get buckets

* Add secondary sort by time

* Use default values from actions in rest requests

Original commit: elastic/x-pack-elasticsearch@a530c0bed6
2017-05-18 16:40:54 +01:00
Lisa Cawley cf5f8e4bad [DOCS] Clarify model snapshots (elastic/x-pack-elasticsearch#1447)
Original commit: elastic/x-pack-elasticsearch@55f307cf89
2017-05-17 09:02:52 -07:00
Lisa Cawley ea2214e5ce [DOCS] Require job to have explicit data_description (elastic/x-pack-elasticsearch#1445)
* [DOCS] Require job to have explicit data_description

* [DOCS] Fix typo in put-job.asciidoc

Original commit: elastic/x-pack-elasticsearch@e7fbbff7eb
2017-05-17 08:53:43 -07:00
Lisa Cawley 4e8c7ad094 [DOCS] Add script_fields to ML data feed documentation (elastic/x-pack-elasticsearch#1372)
* [DOCS] Add script_fields to ML datafeed APIs

* [DOCS] Add datafeedresource.asciidoc to build.gradle

* [DOCS] Addressed feedback in PR 1372

Original commit: elastic/x-pack-elasticsearch@3404ca7850
2017-05-15 09:30:30 -07:00
Lisa Cawley 0c4a7e1930 [DOCS] More minor fixes (elastic/x-pack-elasticsearch#1343)
Original commit: elastic/x-pack-elasticsearch@351e4ea643
2017-05-08 07:12:03 -07:00
Lisa Cawley 0542d730c9 [DOCS] Fix minor ML documentation problems (elastic/x-pack-elasticsearch#1336)
Original commit: elastic/x-pack-elasticsearch@53e65b90fc
2017-05-08 06:53:04 -07:00
Lisa Cawley 45cfc17ea1 [DOCS] Add ML analytical functions (elastic/x-pack-elasticsearch#1319)
* [DOCS] Add ML analytical functions

* [DOCS] Add pages for ML analytical functions

* [DOCS] Add links to ML functions from API definitions

Original commit: elastic/x-pack-elasticsearch@ae50b431d3
2017-05-05 10:41:53 -07:00
Dimitris Athanasiou 7f2c7dbe17 [ML] Rename datafeed indexes to indices (elastic/x-pack-elasticsearch#1297)
Renames datafeed indexes to indices but keeps indexes
as a synonym while parsing.

relates elastic/x-pack-elasticsearch#1292

Original commit: elastic/x-pack-elasticsearch@1fcdd97f88
2017-05-04 11:37:12 +01:00
Lisa Cawley cf27cb479a [DOCS] Clarify wildcard usage in ML datafeed APIs (elastic/x-pack-elasticsearch#1296)
Original commit: elastic/x-pack-elasticsearch@c18fca323b
2017-05-03 09:07:44 -07:00
Dimitris Athanasiou eae7d19d2f [DOCS] Improvements on datafeed related docs (elastic/x-pack-elasticsearch#1293)
Original commit: elastic/x-pack-elasticsearch@4bb1932f0e
2017-05-03 08:38:31 -07:00
Dimitris Athanasiou 3e9c36838d [ML] Remove get model snapshot by description functionality (elastic/x-pack-elasticsearch#1288)
relates elastic/x-pack-elasticsearch#1284

Original commit: elastic/x-pack-elasticsearch@780feea5c1
2017-05-03 13:20:52 +01:00
Lisa Cawley 33c50f1201 [DOCS] Add property table for ML Update Jobs API (elastic/x-pack-elasticsearch#1268)
* [DOCS] Add property table for ML Update Jobs API

* [DOCS] Updates based on feedback for ML Update Jobs API

* [DOCS] Removed detector properties from ML Update Jobs API

* [DOCS] Fixes typos

Original commit: elastic/x-pack-elasticsearch@68d1b5598c
2017-05-02 15:38:41 -07:00
Lisa Cawley 9b2fb6ac16 [DOCS] Change "data feed" to "datafeed" in Machine Learning documentation (elastic/x-pack-elasticsearch#1277)
* [DOCS] Add xpackml attribute to XPack Reference

* [DOCS] Use attribute for datafeed terms

Original commit: elastic/x-pack-elasticsearch@f37bf48ee4
2017-05-02 12:45:42 -07:00
Lisa Cawley a615532866 [DOCS] ML 5.4 docs final tuning (elastic/x-pack-elasticsearch#1265)
Original commit: elastic/x-pack-elasticsearch@91e4af140d
2017-05-01 11:30:19 -07:00