Skip to content

Commit 0c5b52f

Browse files
authored
[DOCS] Changes level offset of anomaly detection pages (#59911) (#59943)
1 parent bcc4a41 commit 0c5b52f

19 files changed

+50
-204
lines changed

docs/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ apply plugin: 'elasticsearch.rest-resources'
2626

2727
/* List of files that have snippets that will not work until platinum tests can occur ... */
2828
buildRestTests.expectedUnconvertedCandidates = [
29-
'reference/ml/anomaly-detection/transforms.asciidoc',
29+
'reference/ml/anomaly-detection/ml-configuring-transform.asciidoc',
3030
'reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc',
3131
'reference/ml/anomaly-detection/apis/get-bucket.asciidoc',
3232
'reference/ml/anomaly-detection/apis/get-category.asciidoc',

docs/reference/ml/anomaly-detection/configuring.asciidoc

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/reference/ml/anomaly-detection/functions/count.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-count-functions.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-count-functions]]
3-
=== Count functions
3+
= Count functions
44

55
Count functions detect anomalies when the number of events in a bucket is
66
anomalous.
@@ -22,7 +22,7 @@ The {ml-features} include the following count functions:
2222

2323
[float]
2424
[[ml-count]]
25-
===== Count, high_count, low_count
25+
== Count, high_count, low_count
2626

2727
The `count` function detects anomalies when the number of events in a bucket is
2828
anomalous.
@@ -145,7 +145,7 @@ and the `summary_count_field_name` property. For more information, see
145145

146146
[float]
147147
[[ml-nonzero-count]]
148-
===== Non_zero_count, high_non_zero_count, low_non_zero_count
148+
== Non_zero_count, high_non_zero_count, low_non_zero_count
149149

150150
The `non_zero_count` function detects anomalies when the number of events in a
151151
bucket is anomalous, but it ignores cases where the bucket count is zero. Use
@@ -215,7 +215,7 @@ data is sparse, use the `count` functions, which are optimized for that scenario
215215

216216
[float]
217217
[[ml-distinct-count]]
218-
===== Distinct_count, high_distinct_count, low_distinct_count
218+
== Distinct_count, high_distinct_count, low_distinct_count
219219

220220
The `distinct_count` function detects anomalies where the number of distinct
221221
values in one field is unusual.

docs/reference/ml/anomaly-detection/functions.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-functions.asciidoc

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-functions]]
3-
== Function reference
3+
= Function reference
44

55
The {ml-features} include analysis functions that provide a wide variety of
66
flexible ways to analyze data for anomalies.
@@ -41,17 +41,3 @@ These functions effectively ignore empty buckets.
4141
* <<ml-rare-functions>>
4242
* <<ml-sum-functions>>
4343
* <<ml-time-functions>>
44-
45-
include::functions/count.asciidoc[]
46-
47-
include::functions/geo.asciidoc[]
48-
49-
include::functions/info.asciidoc[]
50-
51-
include::functions/metric.asciidoc[]
52-
53-
include::functions/rare.asciidoc[]
54-
55-
include::functions/sum.asciidoc[]
56-
57-
include::functions/time.asciidoc[]

docs/reference/ml/anomaly-detection/functions/geo.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-geo-functions.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-geo-functions]]
3-
=== Geographic functions
3+
= Geographic functions
44

55
The geographic functions detect anomalies in the geographic location of the
66
input data.
@@ -13,7 +13,7 @@ geographic functions.
1313

1414
[float]
1515
[[ml-lat-long]]
16-
==== Lat_long
16+
== Lat_long
1717

1818
The `lat_long` function detects anomalies in the geographic location of the
1919
input data.

docs/reference/ml/anomaly-detection/functions/info.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-info-functions.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[ml-info-functions]]
2-
=== Information Content Functions
2+
= Information Content Functions
33

44
The information content functions detect anomalies in the amount of information
55
that is contained in strings within a bucket. These functions can be used as
@@ -12,7 +12,7 @@ The {ml-features} include the following information content functions:
1212

1313
[float]
1414
[[ml-info-content]]
15-
==== Info_content, High_info_content, Low_info_content
15+
== Info_content, High_info_content, Low_info_content
1616

1717
The `info_content` function detects anomalies in the amount of information that
1818
is contained in strings in a bucket.

docs/reference/ml/anomaly-detection/functions/metric.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-metric-functions.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-metric-functions]]
3-
=== Metric functions
3+
= Metric functions
44

55
The metric functions include functions such as mean, min and max. These values
66
are calculated for each bucket. Field values that cannot be converted to
@@ -20,7 +20,7 @@ function.
2020

2121
[float]
2222
[[ml-metric-min]]
23-
==== Min
23+
== Min
2424

2525
The `min` function detects anomalies in the arithmetic minimum of a value.
2626
The minimum value is calculated for each bucket.
@@ -55,7 +55,7 @@ entry mistakes. It models the minimum amount for each product over time.
5555

5656
[float]
5757
[[ml-metric-max]]
58-
==== Max
58+
== Max
5959

6060
The `max` function detects anomalies in the arithmetic maximum of a value.
6161
The maximum value is calculated for each bucket.
@@ -113,7 +113,7 @@ response times for each bucket.
113113

114114
[float]
115115
[[ml-metric-median]]
116-
==== Median, high_median, low_median
116+
== Median, high_median, low_median
117117

118118
The `median` function detects anomalies in the statistical median of a value.
119119
The median value is calculated for each bucket.
@@ -151,7 +151,7 @@ median `responsetime` is unusual compared to previous `responsetime` values.
151151

152152
[float]
153153
[[ml-metric-mean]]
154-
==== Mean, high_mean, low_mean
154+
== Mean, high_mean, low_mean
155155

156156
The `mean` function detects anomalies in the arithmetic mean of a value.
157157
The mean value is calculated for each bucket.
@@ -221,7 +221,7 @@ values.
221221

222222
[float]
223223
[[ml-metric-metric]]
224-
==== Metric
224+
== Metric
225225

226226
The `metric` function combines `min`, `max`, and `mean` functions. You can use
227227
it as a shorthand for a combined analysis. If you do not specify a function in
@@ -258,7 +258,7 @@ when the mean, min, or max `responsetime` is unusual compared to previous
258258

259259
[float]
260260
[[ml-metric-varp]]
261-
==== Varp, high_varp, low_varp
261+
== Varp, high_varp, low_varp
262262

263263
The `varp` function detects anomalies in the variance of a value which is a
264264
measure of the variability and spread in the data.

docs/reference/ml/anomaly-detection/functions/rare.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-rare-functions.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-rare-functions]]
3-
=== Rare functions
3+
= Rare functions
44

55
The rare functions detect values that occur rarely in time or rarely for a
66
population.
@@ -35,7 +35,7 @@ The {ml-features} include the following rare functions:
3535

3636
[float]
3737
[[ml-rare]]
38-
==== Rare
38+
== Rare
3939

4040
The `rare` function detects values that occur rarely in time or rarely for a
4141
population. It detects anomalies according to the number of distinct rare values.
@@ -93,7 +93,7 @@ is rare, even if it occurs for that client IP in every bucket.
9393

9494
[float]
9595
[[ml-freq-rare]]
96-
==== Freq_rare
96+
== Freq_rare
9797

9898
The `freq_rare` function detects values that occur rarely for a population.
9999
It detects anomalies according to the number of times (frequency) that rare

docs/reference/ml/anomaly-detection/functions/sum.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-sum-functions.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-sum-functions]]
3-
=== Sum functions
3+
= Sum functions
44

55
The sum functions detect anomalies when the sum of a field in a bucket is
66
anomalous.
@@ -19,7 +19,7 @@ The {ml-features} include the following sum functions:
1919

2020
[float]
2121
[[ml-sum]]
22-
==== Sum, high_sum, low_sum
22+
== Sum, high_sum, low_sum
2323

2424
The `sum` function detects anomalies where the sum of a field in a bucket is
2525
anomalous.
@@ -75,7 +75,7 @@ to find users that are abusing internet privileges.
7575

7676
[float]
7777
[[ml-nonnull-sum]]
78-
==== Non_null_sum, high_non_null_sum, low_non_null_sum
78+
== Non_null_sum, high_non_null_sum, low_non_null_sum
7979

8080
The `non_null_sum` function is useful if your data is sparse. Buckets without
8181
values are ignored and buckets with a zero value are analyzed.

docs/reference/ml/anomaly-detection/functions/time.asciidoc renamed to docs/reference/ml/anomaly-detection/functions/ml-time-functions.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role="xpack"]
22
[[ml-time-functions]]
3-
=== Time functions
3+
= Time functions
44

55
The time functions detect events that happen at unusual times, either of the day
66
or of the week. These functions can be used to find unusual patterns of behavior,
@@ -37,7 +37,7 @@ step change in behavior and the new times will be learned quickly.
3737

3838
[float]
3939
[[ml-time-of-day]]
40-
==== Time_of_day
40+
== Time_of_day
4141

4242
The `time_of_day` function detects when events occur that are outside normal
4343
usage patterns. For example, it detects unusual activity in the middle of the
@@ -73,7 +73,7 @@ its past behavior.
7373

7474
[float]
7575
[[ml-time-of-week]]
76-
==== Time_of_week
76+
== Time_of_week
7777

7878
The `time_of_week` function detects when events occur that are outside normal
7979
usage patterns. For example, it detects login events on the weekend.

0 commit comments

Comments
 (0)