honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix default gap policy for moving fn, moving avg aggs (#60223)

This commit is contained in:
James Rodewig 2020-07-27 12:08:33 -04:00 committed by GitHub
parent 47922c9e4a
commit dbd7e7793a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/aggregations/pipeline/movavg-aggregation.asciidoc
View File

@ -41,7 +41,7 @@ A `moving_avg` aggregation looks like this in isolation:
|Parameter Name |Description |Required |Default Value |Parameter Name |Description |Required |Default Value
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required | |`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`model` |The moving average weighting model that we wish to use |Optional |`simple` |`model` |The moving average weighting model that we wish to use |Optional |`simple`
|`gap_policy` |Determines what should happen when a gap in the data is encountered. |Optional |`insert_zeros` |`gap_policy` |The policy to apply when gaps are found in the data. See <<gap-policy>>. |Optional |`skip`
|`window` |The size of window to "slide" across the histogram. |Optional |`5` |`window` |The size of window to "slide" across the histogram. |Optional |`5`
|`minimize` |If the model should be algorithmically minimized. See <<movavg-minimizer, Minimization>> for more |`minimize` |If the model should be algorithmically minimized. See <<movavg-minimizer, Minimization>> for more
details |Optional |`false` for most models details |Optional |`false` for most models

1
docs/reference/aggregations/pipeline/movfn-aggregation.asciidoc
View File

@ -32,6 +32,7 @@ A `moving_fn` aggregation looks like this in isolation:
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required | |`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`window` |The size of window to "slide" across the histogram. |Required | |`window` |The size of window to "slide" across the histogram. |Required |
|`script` |The script that should be executed on each window of data |Required | |`script` |The script that should be executed on each window of data |Required |
|`gap_policy` |The policy to apply when gaps are found in the data. See <<gap-policy>>. |Optional |`skip`
|`shift` |<<shift-parameter, Shift>> of window position. |Optional | 0 |`shift` |<<shift-parameter, Shift>> of window position. |Optional | 0
|=== |===