updating visualize aggregations docs (#11034)

* updating visualize aggregations docs

* fixing based on review
This commit is contained in:
Peter Pisljar 2017-04-25 08:01:02 +02:00 committed by GitHub
parent 4209774dde
commit b79cb08a28
3 changed files with 57 additions and 26 deletions

View file

@ -54,16 +54,38 @@ from the saved search.
. In the visualization builder, choose the metric aggregation for the
visualization's Y axis:
+
* *Metric Aggregations*:
* {es-ref}search-aggregations-metrics-valuecount-aggregation.html[count]
* {es-ref}search-aggregations-metrics-avg-aggregation.html[average]
* {es-ref}search-aggregations-metrics-sum-aggregation.html[sum]
* {es-ref}search-aggregations-metrics-min-aggregation.html[min]
* {es-ref}search-aggregations-metrics-max-aggregation.html[max]
* {es-ref}search-aggregations-metrics-stats-aggregation.html[standard deviation]
* {es-ref}search-aggregations-metrics-cardinality-aggregation.html[unique count]
* {es-ref}search-aggregations-metrics-percentile-aggregation.html[median] (50th percentile)
* {es-ref}search-aggregations-metrics-percentile-aggregation.html[percentiles]
* {es-ref}search-aggregations-metrics-percentile-rank-aggregation.html[percentile ranks]
* {es-ref}search-aggregations-metrics-top-hits-aggregation.html[top hit]
* {es-ref}search-aggregations-metrics-geocentroid-aggregation.html[geo centroid]
* *Parent Pipeline Aggregations*:
* {es-ref}search-aggregations-pipeline-derivative-aggregation.html[derivative]
* {es-ref}search-aggregations-pipeline-cumulative-sum-aggregation.html[cumulative sum]
* {es-ref}search-aggregations-pipeline-movavg-aggregation.html[moving average]
* {es-ref}search-aggregations-pipeline-serialdiff-aggregation.html[serial diff]
* *Sibling Pipeline Aggregations*:
* {es-ref}search-aggregations-pipeline-avg-bucket-aggregation.html[average bucket]
* {es-ref}search-aggregations-pipeline-sum-bucket-aggregation.html[sum bucket]
* {es-ref}search-aggregations-pipeline-min-bucket-aggregation.html[min bucket]
* {es-ref}search-aggregations-pipeline-max-bucket-aggregation.html[max bucket]
. For the visualizations X axis, select a bucket aggregation:
+

View file

@ -2,32 +2,9 @@
== X/Y Charts
X/Y charts refer to Area, Line and Bar charts which allow you to plot your data on X/Y axis.
First you need to select your _metrics_ which define Value axis. The following aggregations are available for this axis:
First you need to select your _metrics_ which define Value axis.
*Count*:: The {es-ref}search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of
the elements in the selected index pattern.
*Average*:: This aggregation returns the {es-ref}search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric
field. Select a field from the drop-down.
*Sum*:: The {es-ref}search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric
field. Select a field from the drop-down.
*Min*:: The {es-ref}search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a
numeric field. Select a field from the drop-down.
*Max*:: The {es-ref}search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a
numeric field. Select a field from the drop-down.
*Unique Count*:: The {es-ref}search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
the number of unique values in a field. Select a field from the drop-down.
*Percentiles*:: The {es-ref}search-aggregations-metrics-percentile-aggregation.html[_percentile_] aggregation divides the
values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one
or more ranges in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add* to add a
percentile field.
*Percentile Rank*:: The {es-ref}search-aggregations-metrics-percentile-rank-aggregation.html[_percentile ranks_]
aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field
from the drop-down, then specify one or more percentile rank values in the *Values* fields. Click the *X* to remove a
values field. Click *+Add* to add a values field.
You can add an aggregation by clicking the *+ Add Aggregation* button.
Enter a string in the *Custom Label* field to change the display label.
include::y-axis-aggs.asciidoc[]
The _buckets_ aggregations determine what information is being retrieved from your data set.

View file

@ -1,3 +1,5 @@
Metric Aggregations:
*Count*:: The {es-ref}search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of
the elements in the selected index pattern.
*Average*:: This aggregation returns the {es-ref}search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric
@ -21,6 +23,36 @@ aggregation returns the percentile rankings for the values in the numeric field
from the drop-down, then specify one or more percentile rank values in the *Values* fields. Click the *X* to remove a
values field. Click *+Add* to add a values field.
Parent Pipeline Aggregations:
For each of the parent pipeline aggregations you have to define the metric for which the aggregation is calculated.
That could be one of your existing metrics or a new one. You can also nest this aggregations
(for example to produce 3rd derivative)
*Derivative*:: The {es-ref}search-aggregations-pipeline-derivative-aggregation.html[_derivative_] aggregation calculates
the derivative of specific metrics.
*Cumulative Sum*:: The {es-ref}search-aggregations-pipeline-cumulative-sum-aggregation.html[_cumulative sum_] aggregation
calculates the cumulative sum of a specified metric in a parent histogram
*Moving Average*:: The {es-ref}search-aggregations-pipeline-movavg-aggregation.html[_moving average_] aggregation will
slide a window across the data and emit the average value of that window
*Serial Diff*:: The {es-ref}search-aggregations-pipeline-serialdiff-aggregation.html[_serial differencing_] is a technique
where values in a time series are subtracted from itself at different time lags or period
Sibling Pipeline Aggregations:
Just like with parent pipeline aggregations you need to provide a metric for which to calculate the sibling aggregation.
On top of that you also need to provide a bucket aggregation which will define the buckets on which the sibling
aggregation will run
*Average Bucket*:: The {es-ref}search-aggregations-pipeline-avg-bucket-aggregation.html[_avg bucket_]
calculates the (mean) average value of a specified metric in a sibling aggregation
*Sum Bucket*:: The {es-ref}search-aggregations-pipeline-avg-bucket-aggregation.html[_sum bucket_]
calculates the sum of values of a specified metric in a sibling aggregation
*Min Bucket*:: The {es-ref}search-aggregations-pipeline-avg-bucket-aggregation.html[_min bucket_]
calculates the minimum value of a specified metric in a sibling aggregation
*Max Bucket*:: The {es-ref}search-aggregations-pipeline-avg-bucket-aggregation.html[_max bucket_]
calculates the maximum value of a specified metric in a sibling aggregation
You can add an aggregation by clicking the *+ Add Metrics* button.
Enter a string in the *Custom Label* field to change the display label.