-
Notifications
You must be signed in to change notification settings - Fork 257
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[7.x] [DOCS] Revamps Anomaly Detection section (#592)
* [7.x] [DOCS] Revamps Anomaly Detection section.
- Loading branch information
1 parent
1e502af
commit 84c6f45
Showing
10 changed files
with
217 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[anomaly-examples]] | ||
== {anomaly-detect-cap} examples | ||
++++ | ||
<titleabbrev>Examples</titleabbrev> | ||
++++ | ||
|
||
Though it is quite simple to analyze your data and provide quick {ml} results, | ||
gaining deep insights might require some additional planning and configuration. | ||
The scenarios in this section describe some best practices for generating useful | ||
{ml} results and insights from your data. | ||
|
||
* <<ml-configuring-url>> | ||
* <<ml-configuring-aggregation>> | ||
* <<ml-configuring-categories>> | ||
* <<ml-configuring-detector-custom-rules>> | ||
* <<ml-configuring-pop>> | ||
* <<ml-configuring-transform>> | ||
* <<ml-delayed-data-detection>> | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/customurl.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/aggregations.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/detector-custom-rules.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/categories.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/populations.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/transforms.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/delayed-data-detection.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,40 @@ | ||
[role="xpack"] | ||
[[xpack-ml]] | ||
= {ml-cap} anomaly detection | ||
= {ml-cap} {anomaly-detect} | ||
|
||
[partintro] | ||
-- | ||
Machine learning is tightly integrated with the {stack}. Data is pulled | ||
from {es} for analysis and anomaly results are displayed in {kib} dashboards. | ||
{ml-cap} is tightly integrated with the {stack}. Data is pulled from {es} for | ||
analysis and anomaly results are displayed in {kib} dashboards. | ||
|
||
* <<ml-overview>> | ||
* <<create-jobs>> | ||
* <<ml-concepts>> | ||
* <<ml-configuration>> | ||
//* <<ml-getting-started>> | ||
* <<ml-configuring>> | ||
* <<stopping-ml>> | ||
* <<ml-troubleshooting, Troubleshooting Machine Learning>> | ||
* <<ml-api-quickref>> | ||
* <<ml-functions>> | ||
* <<anomaly-examples>> | ||
* <<ml-limitations>> | ||
//* <<ml-troubleshooting>> | ||
|
||
|
||
-- | ||
|
||
include::overview.asciidoc[] | ||
|
||
include::create-jobs.asciidoc[] | ||
include::ml-concepts.asciidoc[] | ||
|
||
include::job-tips.asciidoc[] | ||
include::ml-configuration.asciidoc[] | ||
|
||
//include::getting-started.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/configuring.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/stopping-ml.asciidoc[] | ||
|
||
include::api-quickref.asciidoc[] | ||
|
||
include::{es-repo-dir}/ml/anomaly-detection/functions.asciidoc[] | ||
|
||
include::troubleshooting.asciidoc[] | ||
include::examples.asciidoc[] | ||
|
||
include::limitations.asciidoc[] | ||
|
||
//include::troubleshooting.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
[role="xpack"] | ||
[[ml-concepts]] | ||
== Concepts | ||
|
||
This section explains the fundamental concepts of the Elastic {ml} | ||
{anomaly-detect} feature. | ||
|
||
* <<ml-jobs>> | ||
* <<ml-dfeeds>> | ||
* <<ml-buckets>> | ||
* <<ml-calendars>> | ||
* <<ml-rules>> | ||
* <<ml-nodes>> | ||
|
||
include::jobs.asciidoc[] | ||
|
||
include::datafeeds.asciidoc[] | ||
|
||
include::buckets.asciidoc[] | ||
|
||
include::calendars.asciidoc[] | ||
|
||
include::rules.asciidoc[] | ||
|
||
include::architecture.asciidoc[] |
37 changes: 37 additions & 0 deletions
37
docs/en/stack/ml/anomaly-detection/ml-configuration.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
[role="xpack"] | ||
[[ml-configuration]] | ||
== Configuring {anomaly-detect} | ||
|
||
If you want to use {ml-features}, there must be at least one {ml} node in | ||
your cluster and all master-eligible nodes must have {ml} enabled. By default, | ||
all nodes are {ml} nodes. For more information about these settings, see | ||
{ref}/modules-node.html#ml-node[{ml} nodes]. | ||
|
||
To use the {ml-features} to analyze your data, you can create an {anomaly-job} | ||
and send your data to that job. | ||
|
||
//* If your data is stored in {es}: | ||
|
||
//** You can create a {dfeed}, which retrieves data from {es} for analysis. | ||
//** You can use {kib} to expedite the creation of jobs and {dfeeds}. | ||
|
||
//* If your data is not stored in {es}, you can | ||
//{ref}/ml-post-data.html[POST data] from any source directly to an API. | ||
|
||
The results of {ml} analysis are stored in {es} and you can use {kib} to help | ||
you visualize and explore the results. | ||
|
||
//For a tutorial that walks you through these configuration steps, | ||
//see <<ml-getting-started>>. | ||
|
||
* <<create-jobs>> | ||
* <<stopping-ml>> | ||
|
||
After you learn how to create and stop {anomaly-detect} jobs, you can check the | ||
<<anomaly-examples>> for more advanced settings and scenarios. | ||
|
||
include::create-jobs.asciidoc[] | ||
|
||
include::job-tips.asciidoc[] | ||
|
||
include::stopping-ml.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
[role="xpack"] | ||
[[stopping-ml]] | ||
=== Stopping {ml} {anomaly-detect} | ||
|
||
An orderly shutdown ensures that: | ||
|
||
* {dfeeds-cap} are stopped | ||
* Buffers are flushed | ||
* Model history is pruned | ||
* Final results are calculated | ||
* Model snapshots are saved | ||
* {anomaly-jobs-cap} are closed | ||
|
||
This process ensures that jobs are in a consistent state in case you want to | ||
subsequently re-open them. | ||
|
||
[float] | ||
[[stopping-ml-datafeeds]] | ||
=== Stopping {dfeeds} | ||
|
||
When you stop a {dfeed}, it ceases to retrieve data from {es}. You can stop a | ||
{dfeed} by using {kib} or the | ||
{ref}/ml-stop-datafeed.html[stop {dfeeds} API]. For example, the following | ||
request stops the `feed1` {dfeed}: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
POST _ml/datafeeds/feed1/_stop | ||
-------------------------------------------------- | ||
// TEST[skip:setup:server_metrics_startdf] | ||
|
||
NOTE: You must have `manage_ml`, or `manage` cluster privileges to stop {dfeeds}. | ||
For more information, see <<security-privileges>>. | ||
|
||
A {dfeed} can be started and stopped multiple times throughout its lifecycle. | ||
|
||
//For examples of stopping {dfeeds} in {kib}, see <<ml-gs-job1-manage>>. | ||
|
||
[float] | ||
[[stopping-all-ml-datafeeds]] | ||
==== Stopping all {dfeeds} | ||
|
||
If you are upgrading your cluster, you can use the following request to stop all | ||
{dfeeds}: | ||
|
||
[source,console] | ||
---------------------------------- | ||
POST _ml/datafeeds/_all/_stop | ||
---------------------------------- | ||
// TEST[skip:needs-licence] | ||
|
||
[float] | ||
[[closing-ml-jobs]] | ||
=== Closing {anomaly-jobs} | ||
|
||
When you close an {anomaly-job}, it cannot receive data or perform analysis | ||
operations. If a job is associated with a {dfeed}, you must stop the {dfeed} | ||
before you can close the job. If the {dfeed} has an end date, the job closes | ||
automatically on that end date. | ||
|
||
You can close a job by using the | ||
{ref}/ml-close-job.html[close {anomaly-job} API]. For | ||
example, the following request closes the `job1` job: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
POST _ml/anomaly_detectors/job1/_close | ||
-------------------------------------------------- | ||
// TEST[skip:setup:server_metrics_openjob] | ||
|
||
NOTE: You must have `manage_ml`, or `manage` cluster privileges to stop {dfeeds}. | ||
For more information, see <<security-privileges>>. | ||
|
||
{anomaly-jobs-cap} can be opened and closed multiple times throughout their | ||
lifecycle. | ||
|
||
[float] | ||
[[closing-all-ml-datafeeds]] | ||
==== Closing all {anomaly-jobs} | ||
|
||
If you are upgrading your cluster, you can use the following request to close | ||
all open {anomaly-jobs} on the cluster: | ||
|
||
[source,console] | ||
---------------------------------- | ||
POST _ml/anomaly_detectors/_all/_close | ||
---------------------------------- | ||
// TEST[skip:needs-licence] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters