Commit Graph

116 Commits

Author SHA1 Message Date
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
Lisa Cawley 435338e6b9 [DOCS] Fix ML API example for elastic/x-pack-elasticsearch#1180 (elastic/x-pack-elasticsearch#1252)
Original commit: elastic/x-pack-elasticsearch@5290dd0a89
2017-04-28 09:14:53 -07:00
Lisa Cawley 68c3a94c35 [DOCS] Add ML limitations (elastic/x-pack-elasticsearch#1229)
* [DOCS] Add ML limitations

* [DOCS] Address feedback about ML limitations

* [DOCS] Change ML limitations capitalization

Original commit: elastic/x-pack-elasticsearch@41682d8d93
2017-04-28 08:13:47 -07:00
Lisa Cawley 485be502f4 [DOCS] Doc build fixes and edits for elastic/x-pack-elasticsearch#1237 (elastic/x-pack-elasticsearch#1241)
* [DOCS] Fixing doc build error

* [DOCS] Edits on ML content for elastic/x-pack-elasticsearch#1237

Original commit: elastic/x-pack-elasticsearch@cd4d404dee
2017-04-27 11:22:59 -07:00
Sophie Chang ffb3bb6493 [DOCS] Overall review (elastic/x-pack-elasticsearch#1237)
* [DOCS] Overall review

* [DOCS] General review

* [DOCS] typo

* [DOCS] Fix for processed_record_count with aggs

* [DOCS] Added latency tbd

Original commit: elastic/x-pack-elasticsearch@9e8cf664c1
2017-04-27 11:22:42 -07:00
Lisa Cawley d709a64638 [DOCS] Change allows to enables in ML docs (elastic/x-pack-elasticsearch#1230)
Original commit: elastic/x-pack-elasticsearch@a408fd59f6
2017-04-26 15:29:55 -07:00
Lisa Cawley 577fa559f6 [DOCS] More edits in datafeed resource (elastic/x-pack-elasticsearch#1221)
Original commit: elastic/x-pack-elasticsearch@ea6abc163f
2017-04-26 11:22:15 -07:00
Dimitris Athanasiou 8af91aed6a [DOCS] Add missing info in datafeed resource (elastic/x-pack-elasticsearch#1215)
Original commit: elastic/x-pack-elasticsearch@c415bc92c2
2017-04-26 10:05:27 -07:00
Lisa Cawley 268f5a95af [DOCS] Add authorization section to ML API pages (elastic/x-pack-elasticsearch#1205)
* [DOCS] Edits for description of ML results resource

* [DOCS] Adds Authorization section to ML API pages

Original commit: elastic/x-pack-elasticsearch@797761e7ae
2017-04-25 14:21:42 -07:00
Lisa Cawley 019b1f7ece [DOCS] Fix doc build errors for elastic/x-pack-elasticsearch#1197 (elastic/x-pack-elasticsearch#1199)
Original commit: elastic/x-pack-elasticsearch@30f69513ab
2017-04-25 08:23:51 -07:00
Sophie Chang 4b39d858b7 [DOCS] Major re-work of resultsresource (elastic/x-pack-elasticsearch#1197)
Original commit: elastic/x-pack-elasticsearch@8e9a004dd2
2017-04-25 08:23:30 -07:00
Lisa Cawley ee612a3dd8 [DOCS] Add ML Getting Started job analysis pages (elastic/x-pack-elasticsearch#1185)
* [DOCS] ML getting started file extraction

* [DOCS] ML Getting Started exploring job results

Original commit: elastic/x-pack-elasticsearch@7b46e7beb3
2017-04-24 16:31:48 -07:00
lcawley 918f4fb962 [DOCS] Clarify force parameter for close job ML API
Original commit: elastic/x-pack-elasticsearch@c170d43757
2017-04-24 11:32:50 -07:00
Lisa Cawley af47002654 [DOCS] Edits for ML doc changes in elastic/x-pack-elasticsearch#1169 (elastic/x-pack-elasticsearch#1177)
Original commit: elastic/x-pack-elasticsearch@84f8b4b9bd
2017-04-24 10:56:26 -07:00
lcawley ee59f18d42 [DOCS] Fixed X-Pack Reference build error
Original commit: elastic/x-pack-elasticsearch@69d20f4346
2017-04-24 10:08:04 -07:00
Sophie Chang 528ac3d902 [DOCS] ML API docs review (elastic/x-pack-elasticsearch#1169)
* [DOCS] Fix for prelertcategory

* [DOCS] _preview returns a page of data

* [DOCS] Added adv options e.g. background_persist_interval"

* [DOCS] Clarify meanings of model_snapshot params

* [DOCS] Format fixes

* [DOCS] Include _all keyword

* [DOCS] Explain retain.

* [DOCS] Further explanations for model size limits

* [DOCS] Format fixes in quick ref

* [DOCS] Update for exclude_interim

* [DOCS] Update for exclude_interim

* [DOCS] Update for exclude_interim

Original commit: elastic/x-pack-elasticsearch@cdd2fcefdd
2017-04-24 10:07:51 -07:00
Zachary Tong d993926ba4 [DOCS] Re-enable XPack doc testing (elastic/x-pack-elasticsearch#1146)
Adds a gradle build for documentation testing, partially stolen from the xpack meta repo. Updated to make work with the current setup

index.asciidoc was updated/enabled as a test, and various pre-existing tests appear to be working. There are a large number of tests still ignored due to missing proper // CONSOLE tags

Original commit: elastic/x-pack-elasticsearch@1d596f0be3
2017-04-21 11:23:27 -04:00
Lisa Cawley bf110ba05e [DOCS] Document machine_learning_admin and machine_learning_user roles (elastic/x-pack-elasticsearch#1132)
* [DOCS] Document machine_learning_admin and machine_learning_user roles

* [DOCS] Fix auth requrements for ML result APIs

* [DOCS] Update authorization.asciidoc based on elastic/x-pack-elasticsearch#1132

Original commit: elastic/x-pack-elasticsearch@1bf563e8d7
2017-04-20 08:45:30 -07:00
lcawley 7c3a3cce80 [DOCS] Add results_index_name to ML put job API
Original commit: elastic/x-pack-elasticsearch@d319a968f4
2017-04-19 23:02:45 -07:00
Lisa Cawley ded8edcc3d [DOCS] Fixes build and typo issues in ML API update elastic/x-pack-elasticsearch#1118
Original commit: elastic/x-pack-elasticsearch@3ef20792ac
2017-04-19 13:31:07 -07:00
Sophie Chang e2cc00ab8e [DOCS] Review of API docs part 1 (elastic/x-pack-elasticsearch#1118)
* [DOCS] Review of close job and job stats

* [DOCS] Add force close

* [DOCS] Remove invalid params from get records

* [DOCS] Remove invalid params from get buckets

* [DOCS] Job resource corrections

Original commit: elastic/x-pack-elasticsearch@bc68d05097
2017-04-19 11:43:30 -07:00
Dimitris Athanasiou 96cfbc8f4c [ML] Remove partition_field param from GetBucketsAction (elastic/x-pack-elasticsearch#1122)
Relates elastic/x-pack-elasticsearch#1119


Original commit: elastic/x-pack-elasticsearch@c87fdbc031
2017-04-19 14:07:51 +01:00
Lisa Cawley 5223acdd9f [DOCS] Multiple fixes related to privileges in ML documentation (elastic/x-pack-elasticsearch#1110)
* [DOCS] Add privilege requirements to ML API docs

* [DOCS] Document ML cluster-level privileges

Original commit: elastic/x-pack-elasticsearch@221c67d395
2017-04-18 15:13:21 -07:00
Lisa Cawley 178d259315 [DOCS] Clarify missing_field_count for elastic/x-pack-elasticsearch#987 (elastic/x-pack-elasticsearch#1105)
Original commit: elastic/x-pack-elasticsearch@91e867e6b5
2017-04-18 11:30:30 -07:00
lcawley 10390a5e50 [DOCS] Forward-fit example output for DELETE model snapshot API
Original commit: elastic/x-pack-elasticsearch@d847776203
2017-04-13 14:32:01 -07:00
lcawley 412bb63383 [DOCS] Remove data type formatting from API pages
Original commit: elastic/x-pack-elasticsearch@fb06ece3f0
2017-04-11 20:17:29 -07:00
lcawley 1a6f813d5a [DOCS] Update all ML API examples with latest build output
Original commit: elastic/x-pack-elasticsearch@f9fa3b813a
2017-04-11 20:15:50 -07:00
lcawley 298ee9f554 [DOCS] Add snapshot API examples
Original commit: elastic/x-pack-elasticsearch@8928c3c1be
2017-04-11 14:43:17 -07:00
lcawley a0771019a5 [DOCS] Remove redundant batch_span and period from job config
Original commit: elastic/x-pack-elasticsearch@95e162eaa9
2017-04-11 13:30:03 -07:00
lcawley a1bf6247a8 [DOCS] Add ML API results examples
Original commit: elastic/x-pack-elasticsearch@60a21763eb
2017-04-11 09:00:15 -07:00
Lisa Cawley 90575b18f4 [DOCS] Add ML data feed API examples (elastic/x-pack-elasticsearch#1016)
* [DOCS] Added examples for all ML job APIs

* [DOCS] Add ML datafeed API examples

Original commit: elastic/x-pack-elasticsearch@9634356371
2017-04-10 09:06:34 -07:00
Lisa Cawley e339cf82df [DOCS] Added examples for all ML job APIs (elastic/x-pack-elasticsearch#980)
Original commit: elastic/x-pack-elasticsearch@7911b53af9
2017-04-06 08:07:49 -07:00
Lisa Cawley 843a0d8b3f [DOCS] Add ML documentation to master (elastic/x-pack-elasticsearch#959)
Original commit: elastic/x-pack-elasticsearch@666a10bd23
2017-04-04 15:26:39 -07:00