Skip to content

Commit 8ab7f98

Browse files
committed
[6.7] Drafts index.asciidoc for ML Guide (elastic#772)
1 parent 51ce26f commit 8ab7f98

17 files changed

+102
-66
lines changed

docs/en/install-upgrade/upgrading-stack.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ restart all nodes to maintain communication across the cluster.
8787
.. Make sure real passwords are configured for the built-in `elasticsearch`,
8888
`kibana`, and `logstash_system` users. They cannot use the 5.n default
8989
password (`changeme`). For more information, see
90-
{stack-ov}/built-in-users.html[Built-in users].
90+
{ref}/built-in-users.html[Built-in users].
9191

9292
. Stop any {xpack} machine learning jobs that are running before starting the
9393
upgrade process. See

docs/en/stack/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
1717

1818
include::introduction.asciidoc[]
1919

20-
include::ml/index.asciidoc[]
20+
include::ml/ml-index.asciidoc[]
2121

2222
include::troubleshooting.asciidoc[]
2323

docs/en/stack/license.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ you install in {kib} or by using the {ref}/update-license.html[update license AP
3131

3232
TIP: If you are using a basic or trial license, {security-features} are disabled
3333
by default. In all other licenses, {security-features} are enabled by default;
34-
you must {stack-ov}/security-getting-started.html[secure the {stack}] or disable
34+
you must {ref}/secure-cluster.html[secure the {stack}] or disable
3535
the {security-features}.
3636

3737
--

docs/en/stack/ml/analyzing.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ actual data values, the bounds for the expected values, and the anomalies that
2323
occur outside these bounds.
2424

2525
[role="screenshot"]
26-
image::ml/images/ml-gs-job-analysis.jpg["Example screenshot from the Machine Learning Single Metric Viewer in Kibana"]
26+
image::images/ml-gs-job-analysis.jpg["Example screenshot from the Machine Learning Single Metric Viewer in Kibana"]
2727

2828
For a more detailed walk-through of {ml-features}, see
2929
<<ml-getting-started>>.

docs/en/stack/ml/buckets.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ high multi-bucket impact are depicted in the *Anomaly Explorer* and the
2929
*Single Metric Viewer* with a cross symbol instead of a dot. For example:
3030

3131
[role="screenshot"]
32-
image::ml/images/multibucketanalysis.jpg["Examples of anomalies with multi-bucket impact in {kib}"]
32+
image::images/multibucketanalysis.jpg["Examples of anomalies with multi-bucket impact in {kib}"]
3333

3434
In this example, you can see that some of the anomalies fall within the shaded
3535
blue area, which represents the bounds for the expected values. The bounds are

docs/en/stack/ml/forecasting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ that you created at different times. You can create a forecast by using the
1919

2020

2121
[role="screenshot"]
22-
image::ml/images/ml-gs-job-forecast.jpg["Example screenshot from the Machine Learning Single Metric Viewer in Kibana"]
22+
image::images/ml-gs-job-forecast.jpg["Example screenshot from the Machine Learning Single Metric Viewer in Kibana"]
2323

2424
The yellow line in the chart represents the predicted data values. The
2525
shaded yellow area represents the bounds for the predicted values, which also
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
By default, when you install {stack} products, they apply basic licenses with no
2+
expiration dates. To view your license in {kib}, go to **Management** and click
3+
**License Management**.
4+
5+
[role="screenshot"]
6+
image::images/management-license.png["The License Management page in {kib}"]
7+
8+
For more information about Elastic license levels, see
9+
https://www.elastic.co/subscriptions.
10+
11+
You can start a 30-day trial to try out all of the platinum features, including
12+
{security-features} and {ml-features}. Click **Start trial** on the
13+
**License Management** page in {kib}.
14+
15+
IMPORTANT: If your cluster has already activated a trial license for the current
16+
major version, you cannot start a new trial. For example, if you have already
17+
activated a trial for v6.0, you cannot start a new trial until v7.0.
18+
19+
At the end of the trial period, the platinum features operate in a degraded
20+
mode. You can revert to a basic license, extend the trial, or purchase a
21+
subscription.

docs/en/stack/ml/getting-started-forecast.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ in this tutorial. For example, select the `total-requests` job.
1414
+
1515
--
1616
[role="screenshot"]
17-
image::ml/images/ml-gs-forecast.jpg["Create a forecast from the Single Metric Viewer"]
17+
image::images/ml-gs-forecast.jpg["Create a forecast from the Single Metric Viewer"]
1818
--
1919

2020
. Specify a duration for your forecast. This value indicates how far to
@@ -25,14 +25,14 @@ duration of 1 week: +
2525
+
2626
--
2727
[role="screenshot"]
28-
image::ml/images/ml-gs-duration.jpg["Specify a duration of 1w"]
28+
image::images/ml-gs-duration.jpg["Specify a duration of 1w"]
2929
--
3030

3131
. View the forecast in the **Single Metric Viewer**: +
3232
+
3333
--
3434
[role="screenshot"]
35-
image::ml/images/ml-gs-forecast-results.jpg["View a forecast from the Single Metric Viewer"]
35+
image::images/ml-gs-forecast-results.jpg["View a forecast from the Single Metric Viewer"]
3636

3737
The yellow line in the chart represents the predicted data values. The shaded
3838
yellow area represents the bounds for the predicted values, which also gives an
@@ -56,14 +56,14 @@ from the list. For example: +
5656
+
5757
--
5858
[role="screenshot"]
59-
image::ml/images/ml-gs-forecast-open.jpg["Open a forecast in the Single Metric Viewer"]
59+
image::images/ml-gs-forecast-open.jpg["Open a forecast in the Single Metric Viewer"]
6060
--
6161

6262
.. View the forecast and actual data in the **Single Metric Viewer**: +
6363
+
6464
--
6565
[role="screenshot"]
66-
image::ml/images/ml-gs-forecast-actual.jpg["View a forecast over actual data in the Single Metric Viewer"]
66+
image::images/ml-gs-forecast-actual.jpg["View a forecast over actual data in the Single Metric Viewer"]
6767

6868
The chart contains the actual data values, the bounds for the expected values,
6969
the anomalies, the forecast data values, and the bounds for the forecast. This

docs/en/stack/ml/getting-started-multi.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ go to `http://localhost:5601/`.
4444
+
4545
--
4646
[role="screenshot"]
47-
image::ml/images/ml-gs-multi-job.jpg["Create a new job from the server-metrics index"]
47+
image::images/ml-gs-multi-job.jpg["Create a new job from the server-metrics index"]
4848
--
4949

5050
.. For the **Fields**, select `high mean(response)` and `sum(total)`. This
@@ -110,7 +110,7 @@ sum `total` values over time. For example:
110110
+
111111
--
112112
[role="screenshot"]
113-
image::ml/images/ml-gs-job2-split.jpg["Kibana charts for data split by service"]
113+
image::images/ml-gs-job2-split.jpg["Kibana charts for data split by service"]
114114
--
115115

116116
. Provide a name for the job, for example `response_requests_by_app`. The job
@@ -140,7 +140,7 @@ event occurs outside of the model, that event is identified as an anomaly.
140140
You can use the **Anomaly Explorer** in {kib} to view the analysis results:
141141

142142
[role="screenshot"]
143-
image::ml/images/ml-gs-job2-explorer.jpg["Job results in the Anomaly Explorer"]
143+
image::images/ml-gs-job2-explorer.jpg["Job results in the Anomaly Explorer"]
144144

145145
You can explore the overall anomaly time line, which shows the maximum anomaly
146146
score for each section in the specified time period. You can change the time
@@ -165,7 +165,7 @@ the `host` field as an influencer, you can also optionally view the results in
165165
swim lanes for each host name:
166166

167167
[role="screenshot"]
168-
image::ml/images/ml-gs-job2-explorer-host.jpg["Job results sorted by host"]
168+
image::images/ml-gs-job2-explorer-host.jpg["Job results sorted by host"]
169169

170170
By default, the swim lanes are ordered by their maximum anomaly score values.
171171
You can click on the sections in the swim lane to see details about the
@@ -185,7 +185,7 @@ anomalies in that time period. For example, click on the red section in the swim
185185
lane for `server_2`:
186186

187187
[role="screenshot"]
188-
image::ml/images/ml-gs-job2-explorer-anomaly.jpg["Job results for an anomaly"]
188+
image::images/ml-gs-job2-explorer-anomaly.jpg["Job results for an anomaly"]
189189

190190
You can see exact times when anomalies occurred and which detectors or metrics
191191
caught the anomaly. Also note that because you split the data by the `service`
@@ -197,7 +197,7 @@ Below the charts, there is a table that provides more information, such as the
197197
typical and actual values and the influencers that contributed to the anomaly.
198198

199199
[role="screenshot"]
200-
image::ml/images/ml-gs-job2-explorer-table.jpg["Job results table"]
200+
image::images/ml-gs-job2-explorer-table.jpg["Job results table"]
201201

202202
Notice that there are anomalies for both detectors, that is to say for both the
203203
`high_mean(response)` and the `sum(total)` metrics in this time interval. The

docs/en/stack/ml/getting-started-next.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,4 @@ multi-metric jobs and split the data or create more complex analysis functions
5252
as necessary. For examples of more complicated configuration options, see
5353
<<ml-configuring>>.
5454

55-
If you encounter problems, we're here to help. See <<help>> and
56-
<<ml-troubleshooting>>.
55+
If you encounter problems, we're here to help. See <<ml-troubleshooting>>.

docs/en/stack/ml/getting-started-single.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ go to `http://localhost:5601/`.
3636
+
3737
--
3838
[role="screenshot"]
39-
image::ml/images/ml-gs-single-job.jpg["Create a new job from the server-metrics index"]
39+
image::images/ml-gs-single-job.jpg["Create a new job from the server-metrics index"]
4040
--
4141

4242
.. For the **Aggregation**, select `Sum`. This value specifies the analysis
@@ -97,7 +97,7 @@ you've got the time range set up, click the **Go** button. +
9797
+
9898
--
9999
[role="screenshot"]
100-
image::ml/images/ml-gs-job1-time.jpg["Setting the time range for the {dfeed}"]
100+
image::images/ml-gs-job1-time.jpg["Setting the time range for the {dfeed}"]
101101
--
102102
+
103103
--
@@ -117,7 +117,7 @@ job and create a job group.
117117
+
118118
--
119119
[role="screenshot"]
120-
image::ml/images/ml-gs-job1.jpg["A graph of the total number of requests over time"]
120+
image::images/ml-gs-job1.jpg["A graph of the total number of requests over time"]
121121
--
122122

123123
As the job is created, the graph is updated to give a visual representation of
@@ -141,7 +141,7 @@ API reference information, see {ref}/ml-apis.html[Machine Learning APIs].
141141
After you create a job, you can see its status in the **Job Management** tab: +
142142

143143
[role="screenshot"]
144-
image::ml/images/ml-gs-job1-manage1.jpg["Status information for the total-requests job"]
144+
image::images/ml-gs-job1-manage1.jpg["Status information for the total-requests job"]
145145

146146
The following information is provided for each job:
147147

@@ -214,7 +214,7 @@ now process the remaining data by restarting the {dfeed}:
214214
+
215215
--
216216
[role="screenshot"]
217-
image:ml/images/ml-gs-start-feed.jpg["Start {dfeed}"]
217+
image::images/ml-gs-start-feed.jpg["Start {dfeed}"]
218218
--
219219

220220
. Choose a start time and end time. For example,
@@ -225,7 +225,7 @@ otherwise you might miss anomalies. +
225225
+
226226
--
227227
[role="screenshot"]
228-
image::ml/images/ml-gs-job1-datafeed.jpg["Restarting a {dfeed}"]
228+
image::images/ml-gs-job1-datafeed.jpg["Restarting a {dfeed}"]
229229
--
230230

231231
The {dfeed} state changes to `started`, the job state changes to `opened`,
@@ -267,7 +267,7 @@ Single Metric Viewer::
267267
By default when you view the results for a single metric job, the
268268
**Single Metric Viewer** opens:
269269
[role="screenshot"]
270-
image::ml/images/ml-gs-job1-analysis.jpg["Single Metric Viewer for total-requests job"]
270+
image::images/ml-gs-job1-analysis.jpg["Single Metric Viewer for total-requests job"]
271271

272272

273273
The blue line in the chart represents the actual data values. The shaded blue
@@ -299,7 +299,7 @@ anomaly data point. If you hover over the point, you can see more information
299299
about that data point. You can also see details in the **Anomalies** section
300300
of the viewer. For example:
301301
[role="screenshot"]
302-
image::ml/images/ml-gs-job1-anomalies.jpg["Single Metric Viewer Anomalies for total-requests job"]
302+
image::images/ml-gs-job1-anomalies.jpg["Single Metric Viewer Anomalies for total-requests job"]
303303

304304
For each anomaly you can see key details such as the time, the actual and
305305
expected ("typical") values, and their probability.
@@ -319,13 +319,13 @@ show all anomalies.
319319
You can see the same information in a different format by using the
320320
**Anomaly Explorer**:
321321
[role="screenshot"]
322-
image::ml/images/ml-gs-job1-explorer.jpg["Anomaly Explorer for total-requests job"]
322+
image::images/ml-gs-job1-explorer.jpg["Anomaly Explorer for total-requests job"]
323323

324324

325325
Click one of the red sections in the swim lane to see details about the anomalies
326326
that occurred in that time interval. For example:
327327
[role="screenshot"]
328-
image::ml/images/ml-gs-job1-explorer-anomaly.jpg["Anomaly Explorer details for total-requests job"]
328+
image::images/ml-gs-job1-explorer-anomaly.jpg["Anomaly Explorer details for total-requests job"]
329329

330330
After you have identified anomalies, often the next step is to try to determine
331331
the context of those situations. For example, are there other factors that are

docs/en/stack/ml/getting-started-wizards.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ go to `http://localhost:5601/`.
3838
You can then choose from a list of job wizards. For example:
3939

4040
[role="screenshot"]
41-
image::ml/images/ml-gs-create-job.jpg["Job creation wizards in {kib}"]
41+
image::images/ml-gs-create-job.jpg["Job creation wizards in {kib}"]
4242

4343
If you are not certain which wizard to use, there is also a **Data Visualizer**
4444
that can help you explore the fields in your data.
@@ -49,7 +49,7 @@ To learn more about the sample data:
4949
+
5050
--
5151
[role="screenshot"]
52-
image::ml/images/ml-gs-data-visualizer.jpg["Data Visualizer in {kib}"]
52+
image::images/ml-gs-data-visualizer.jpg["Data Visualizer in {kib}"]
5353
--
5454

5555
. Select a time period that you're interested in exploring by using the time
@@ -64,7 +64,7 @@ that using a large sample size increases query run times and increases the load
6464
on the cluster.
6565

6666
[role="screenshot"]
67-
image::ml/images/ml-gs-data-metrics.jpg["Data Visualizer output for metrics in {kib}"]
67+
image::images/ml-gs-data-metrics.jpg["Data Visualizer output for metrics in {kib}"]
6868

6969
The fields in the indices are listed in two sections. The first section contains
7070
the numeric ("metric") fields. The second section contains non-metric fields
@@ -78,21 +78,21 @@ the values in the data are clustered. Alternatively, you can view the top values
7878
for metric fields. For example:
7979

8080
[role="screenshot"]
81-
image::ml/images/ml-gs-data-topmetrics.jpg["Data Visualizer output for top values in {kib}"]
81+
image::images/ml-gs-data-topmetrics.jpg["Data Visualizer output for top values in {kib}"]
8282

8383
For date fields, the **Data Visualizer** provides the earliest and latest field
8484
values and the number and percentage of documents that contain the field
8585
during the selected time period. For example:
8686

8787
[role="screenshot"]
88-
image::ml/images/ml-gs-data-dates.jpg["Data Visualizer output for date fields in {kib}"]
88+
image::images/ml-gs-data-dates.jpg["Data Visualizer output for date fields in {kib}"]
8989

9090
For keyword fields, the **Data Visualizer** provides the number of distinct
9191
values, a list of the top values, and the number and percentage of documents
9292
that contain the field during the selected time period. For example:
9393

9494
[role="screenshot"]
95-
image::ml/images/ml-gs-data-keywords.jpg["Data Visualizer output for date fields in {kib}"]
95+
image::images/ml-gs-data-keywords.jpg["Data Visualizer output for date fields in {kib}"]
9696

9797
In this tutorial, you will create single and multi-metric jobs that use the
9898
`total`, `response`, `service`, and `host` fields. Though there is an option to

docs/en/stack/ml/getting-started.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,15 @@ easier to control which users have authority to view and manage the jobs,
5555
By default, you can perform all of the steps in this tutorial by using the
5656
built-in `elastic` super user. However, the password must be set before the user
5757
can do anything. For information about how to set that password, see
58-
<<security-getting-started>>.
58+
{ref}/security-getting-started.html[Getting started with security].
5959

6060
If you are performing these steps in a production environment, take extra care
6161
because `elastic` has the `superuser` role and you could inadvertently make
6262
significant changes to the system. You can alternatively assign the
6363
`machine_learning_admin` and `kibana_user` roles to a user ID of your choice.
6464

65-
For more information, see <<built-in-roles>> and <<privileges-list-cluster>>.
65+
For more information, see {ref}/built-in-roles.html[Built-in roles] and
66+
{ref}/security-privileges.html[Security privileges].
6667

6768
--
6869

103 KB
Loading

docs/en/stack/ml/index.asciidoc

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,17 @@
1-
[role="xpack"]
2-
[[xpack-ml]]
3-
= Machine learning in the Elastic Stack
1+
= Machine Learning in the Elastic Stack
42

5-
[partintro]
6-
--
7-
Machine learning is tightly integrated with the {stack}. Data is pulled
8-
from {es} for analysis and anomaly results are displayed in {kib} dashboards.
3+
:doctype: book
4+
:forum: https://discuss.elastic.co/c/x-pack
5+
:blog-ref: https://www.elastic.co/blog/
6+
:wikipedia: https://en.wikipedia.org/wiki
7+
:es-repo-dir: {docdir}/../../../../../elasticsearch/docs/reference
98

10-
* <<ml-overview>>
11-
* <<ml-getting-started>>
12-
* <<ml-configuring>>
13-
* <<stopping-ml>>
14-
* <<ml-troubleshooting, Troubleshooting Machine Learning>>
15-
* <<ml-api-quickref>>
16-
* <<ml-functions>>
9+
include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
10+
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
1711

12+
include::ml-index.asciidoc[]
1813

19-
--
20-
21-
include::overview.asciidoc[]
22-
23-
include::getting-started.asciidoc[]
24-
25-
include::{es-repo-dir}/ml/configuring.asciidoc[]
26-
27-
include::{es-repo-dir}/ml/stopping-ml.asciidoc[]
28-
29-
include::api-quickref.asciidoc[]
30-
31-
include::{es-repo-dir}/ml/functions.asciidoc[]
14+
include::troubleshooting.asciidoc[]
3215

16+
include::limitations.asciidoc[]
3317

0 commit comments

Comments
 (0)