Skip to content

Commit 203df4e

Browse files
[DOCS] Marks the change point agg as GA (#134898)
* [DOCS] Marks the change point agg as GA. * Update docs/reference/aggregations/search-aggregations-change-point-aggregation.md Co-authored-by: Liam Thompson <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]>
1 parent ac0cf95 commit 203df4e

File tree

1 file changed

+3
-16
lines changed

1 file changed

+3
-16
lines changed

docs/reference/aggregations/search-aggregations-change-point-aggregation.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,24 @@
22
navigation_title: "Change point"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-change-point-aggregation.html
5+
applies_to:
6+
stack: preview 9.0, ga 9.2
7+
serverless: ga
58
---
69

710
# Change point aggregation [search-aggregations-change-point-aggregation]
811

9-
10-
::::{warning}
11-
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
12-
::::
13-
14-
1512
A sibling pipeline that detects, spikes, dips, and change points in a metric. Given a distribution of values provided by the sibling multi-bucket aggregation, this aggregation indicates the bucket of any spike or dip and/or the bucket at which the largest change in the distribution of values, if they are statistically significant.
1613

1714
::::{tip}
1815
It is recommended to use the change point aggregation to detect changes in time-based data, however, you can use any metric to create buckets.
1916
::::
2017

21-
2218
## Parameters [change-point-agg-syntax]
2319

2420
`buckets_path`
2521
: (Required, string) Path to the buckets that contain one set of values in which to detect a change point. There must be at least 22 bucketed values. Fewer than 1,000 is preferred. For syntax, see [`buckets_path` Syntax](/reference/aggregations/pipeline.md#buckets-path-syntax).
2622

27-
2823
## Syntax [_syntax_11]
2924

3025
A `change_point` aggregation looks like this in isolation:
@@ -39,8 +34,6 @@ A `change_point` aggregation looks like this in isolation:
3934

4035
1. The buckets containing the values to test against.
4136

42-
43-
4437
## Response body [change-point-agg-response]
4538

4639
`bucket`
@@ -54,7 +47,6 @@ A `change_point` aggregation looks like this in isolation:
5447
`doc_count`
5548
: (number) The document count of the bucket.
5649

57-
5850
`type`
5951
: (object) The found change point type and its related values. Possible types:
6052

@@ -67,7 +59,6 @@ A `change_point` aggregation looks like this in isolation:
6759
* `trend_change`: there is an overall trend change occurring at this point
6860

6961

70-
7162
## Example [_example_7]
7263

7364
The following example uses the Kibana sample data logs data set.
@@ -103,7 +94,6 @@ GET kibana_sample_data_logs/_search
10394
3. The change point detection aggregation configuration object.
10495
4. The path of the aggregation values to detect change points. In this case, the input of the change point aggregation is the value of `avg` which is a sibling aggregation of `date`.
10596

106-
10797
The request returns a response that is similar to the following:
10898

10999
```js
@@ -130,6 +120,3 @@ The request returns a response that is similar to the following:
130120
4. Type of change found.
131121
5. The `p_value` indicates how extreme the change is; lower values indicate greater change.
132122
6. The specific bucket where the change occurs (indexing starts at `0`).
133-
134-
135-

0 commit comments

Comments
 (0)